酒店-目的地补全
基本信息
Path: /hotel/destination
Method: POST
使用说明
- 本接口用于获取与用户输入关键字匹配的目的地列表,目的地可以是城市、行政区、酒店、医院等。
- 使用本接口可以不再使用GEO静态数据,本接口数据和功能比GEO数据完善许多。
- 本接口适于和hotel.list接口结合使用,获取的目的地信息中的CityId作为hotel.list接口的CityId参数,目的地如果不是城市类型,那么目的地名称可以作为hotel.list接口的QueryText参数。
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 | ||
| x-lvcang-api-account | 开放平台分配 | 是 | aaa.test |
Body
| 名称 | 类型 | 是否必须 | 备注 |
|---|---|---|---|
| queryText | string | 必须 | 关键字 用户输入的关键字 |
| oSType | string | 非必须 | 用户系统类型 ,默认“PC” 用户设备的唯一识别号,可以是mac地址,手机也可以是IMEI,一般不需要传入 |
| sugOrientation | integer | 必须 | 目的地范围,默认“0” 在哪个范围进行目的地匹配检索。 0-国内 1-国际 2-国内国际混排,国内优先 3-国内国际混排,国际优先 |
返回数据
| 名称 | 类型 | 是否必须 | 备注 |
|---|---|---|---|
| code | number | 必须 | 返回码 0:请求成功 3000:请求失败 5000:请求异常 |
| message | string | 必须 | 返回消息 |
| success | boolean | 必须 | 请求是否成功 |
| data | object | 必须 | 返回数据 |
| ├─ regionResult | object [] | 必须 | 目的地结果列表 |
| ├─ regionId | string | 必须 | 目的地ID 当目的地类型(RegionType字段)是城市时,此处为即hotel.list接口所使用的CityId |
| ├─ regionNameCn | string | 非必须 | 目的地中文名 |
| ├─ parentId | string | 必须 | 父级目的地ID 当目的地类型(RegionType字段)是城市时可以忽略本字段,目的地类型为其他类型时,本字段表示该目的地所属的城市ID,即hotel.list接口使用的CityId |
| ├─ parentNameCn | string | 必须 | 父级目的地中文名 当目的地类型是城市时本字段表示城市所属省份名称,部分城市(比如直辖市)本字段为空。 当目的地类型为其他类型时,本字段为目的地所属城市的名称。 |
| ├─ regionType | integer | 必须 | 目的地类型 0-城市 1-行政区 2-景区 3-商圈 4-酒店 5-地点 6-医院 7-学校 8-景点 9-地铁站 10-机场/车站 12-品牌 13-集团 |
| ├─ filterType | integer | 必须 | 对应筛选项的类型 用于hotel.filter接口的入参,获取本目的地对应的筛选项 3-品牌 4-行政区 5-商圈 6-POI(大学、周边游[风景区]、汽车站、火车站、地铁等) |
| ├─ address | string | 必须 | POI地址信息 目的地的地址信息描述 |
| guid | string | 必须 | guid |
