酒店-关键字补全
基本信息
Path: /hotel/keyword
Method: POST
使用说明
- 本接口用于获取与用户输入关键字匹配的关键字列表,关键字可以是除了城市以外的任何信息(比如车站、医院、学校等)。
- 使用本接口可以不再使用GEO静态数据,本接口数据和功能比GEO数据完善许多。
- 本接口适于和hotel.list接口结合使用,获取的关键字信息中的关键字名称(Name字段)可以作为hotel.list接口的QueryText参数。
- 本接口与目的地接口(hotel.destination)功能类似,相较于目的地接口,本接口一般不用于获取城市信息,而只用于确定城市后,搜索该城市下的关键字。
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 | ||
| x-lvcang-api-account | 开放平台分配 | 是 | aaa.test |
Body
| 名称 | 类型 | 是否必须 | 备注 |
|---|---|---|---|
| cityId | string | 必须 | 城市ID,可以从hotel.destination接口或者GEO静态数据中获取 |
| queryText | string | 必须 | 用户输入的关键字 |
| isSameCity | boolean | 必须 | 是否同一城市 传入的经纬度坐标是否在CityId指定的城市范围内 |
| longitude | number | 非必须 | 经度 isSameCity为true时不可为空,百度坐标系 |
| latitude | number | 非必须 | 纬度 isSameCity为true时不可为空,百度坐标系 |
| oSType | string | 非必须 | 用户系统类型 可传入Android、IOS、PC、Other中的任意一个,默认“pc” |
| isNeedMoreType | boolean | 非必须 | 是否返回更多类型 是否获取更多类型,默认为true。 更多类型包括医院、学校、景点、地铁站、机场/车站 |
| isNeedBrandGroup | boolean | 非必须 | 是否返回酒店集团 是否获取酒店集团、品牌,默认为false |
返回数据
| 名称 | 类型 | 是否必须 | 备注 |
|---|---|---|---|
| code | number | 必须 | 返回码 0:请求成功 3000:请求失败 5000:请求异常 |
| message | string | 必须 | 请求消息 |
| success | boolean | 必须 | 请求是否成功 |
| data | object | 必须 | |
| ├─ keywordResult | object [] | 必须 | 关键字结果列表 |
| ├─ name | string | 必须 | 关键字名称 |
| ├─ type | string | 必须 | 关键字的类型 关键字的类型 0-酒店 3-品牌 4-行政区 5-商圈 6-POI(大学、周边游[风景区]、汽车站、火车站、地铁等),如果平台没有进行分类,那么就属于此项 8-医院 9-学校 10-景点 11-地铁站 12-机场/车站 13-集团 14-景区 16-设施 17-床型 18-主题 19-星级 |
| ├─ starInfo | integer | 必须 | 酒店星级 仅在关键字类型为酒店时使用,其他类型本字段均为0 |
| ├─ score | string | 非必须 | 酒店点评分 满分5分,仅当关键字类型是酒店时有效,其他类型返回为空 |
| ├─ hotelId | string | 非必须 | 酒店ID 仅当关键字类型为酒店时有效,其他时候返回为空 |
| ├─ filterType | string | 非必须 | poi地址信息 仅当关键字类型为POI时有效,其他时候返回为空 |
| guid | string | 必须 | guid |
