API测试>>

酒店

酒店-筛选项信息更新时间:2025/01/09 16:19

方法名称

hotel.filter

使用说明

本接口用于获取与目的地或关键字关联的筛选项信息,比如选择目的地北京后,可以通过本接口获取北京拥有的酒店的品牌、设施、主题等,使用对应的筛选项传入hotel.list接口相关字段,可以获取到符合筛选条件的产品,一般是传入hotel,.list接口的QueryText字段。

本接口适于和hotel.list接口结合使用,获取的关键字信息中的关键字名称(Name字段)可以作为hotel.list接口的QueryText参数。

具体用法可以参考艺龙官网的目的地和关键字输入框下方的筛选项区域的逻辑。

输入参数

节点名称类型可为空说明
CityId城市IDString(4)N城市ID,可以从hotel.destination接口或者GEO静态数据中获取。
HotFilter获取热门筛选项BooleanN

true-获取热门筛选项

false-获取所有筛选项

FilterType获取筛选项类型StringY

指定获取那种类型的筛选项,多个类型时使用逗号隔开。

3-品牌

4-行政区

5-商圈

6-POI(大学、风景区、汽车站、火车站、地铁等)

1007-支付类型

1008-星级

1011-设施

1012-主题

1016-酒店特色

1020-评分

1031-住宿类型

响应结果

节点名称类型可为空说明
HotelFilterInfos筛选项列表HotelFilterInfo[]N包含多个HotelFilterInfo节点


HotelFilterInfo节点

节点名称类型可为空说明
TypeId筛选项类型IntN

3-品牌

4-行政区

5-商圈

6-POI(大学、风景区、汽车站、火车站等)

1007-支付类型

1008-星级

1010-房间可容纳人数

1011-设施

1012-主题

1016-酒店特色

1020-评分

10

1888-热门搜索

1889-热门酒店

AppWeight类型排序位置IntY表示此类型排在第几个展示,可以无视该字段 废弃

NameCn

筛选项中文名StringN
NameEn筛选项英文名称StringY


TypeNameCn筛选项类型中文名称StringY一般是空字符串,可以忽略
TypeNameEn筛选项类型英文名称StringY

一般是空字符串,可以忽略

UserDistribution用户分布信息StringY描述本筛选项有多少用户选择,只有(TypeId=5)商圈有值
Introduce简介StringY


hotFilterWeightOutSide筛选项外部排序IntN

表示本条筛选项在筛选项中的位置,数值越大越靠前,可以忽略,一般要求分销商自行排序。

hotFilterWeightInSide筛选项内部排序IntN
HasSubNode是否含有子节点BooleanN

表示本筛选项是否还有子筛选项,例如选择了故宫,还可以向下级选择北海公园、天安门等

SubHotelFilterInfos递归子节点HotelFilterInfo[]YHasSubNode为true时有值,表示本筛选项包含的子筛选项列表,节点类型与本节点一样
SelectMode选择模式BooleanY

表示本筛选项所在的列表中是否支持多选,一般不用关注本字段

true-支持多选

false-不支持多选

ParentTypeName父类型中文名称StringY

Id本筛选项的唯一标识Int
N

仅用于标识本筛选项 

IdV4筛选项V4IDStringY当TypeId为4时有值,可用于hotel.list接口DistrictId入参
IdCityV4城市IDStringY只有一级筛选项列表中的节点才可能有值,表示筛选项所属城市ID,可用于hotel.list接口CityId参数
NameExtCn筛选项中文附加信息StringY一般为空
NameExtEn筛选项英文附加信息StringY一般为空
UniqueID流程IDInt
Y当前无用字段
PoiInfo坐标信息HotelGeoInfoYTypeId为6时有效,参考HotelGeoInfo节点 废弃
HotelPricePair价格区间HotelPriceInfoY表示筛选项可检索到的酒店中的最小价格和最大价格,目前一般为空,参考HotelPricePair节点废弃
RegionInfo多边形HotelGeoInfo[]Y表示多边形区域,目前无效 废弃
HasExceptHotSubNode是否含有非热门子节点BooleanN

表示本筛选项是否包含非热门的子节点

SubExceptHotHotelFilterInfos非热门子节点递归列表HotelFilterInfo[]NHasExceptHotSubNode为true时有值,节点类型与本节点类型相同

HotelGeoInfo节点

节点名称类型可为空说明
Lat纬度DecimalN
Lng
经度DecimalN

HotelPricePair节点

节点名称类型可为空说明
Min最低价DecimalN
Max最高价DecimalN


输入参数示例

https://api-test.elong.com/rest?timestamp=1490001050&format=json
&method=hotel.filter&signature=d19ce1e910def16453801405581c9d7c
&user={userid}&data={"Version":"1.33","Local":"zh_CN","Request":{"CityId":"0101","HotFilter":false,"FilterType":"4"}}

输出参数示例

{
  "Code": "0",
  "Result": {
    "hotelFilterInfos": [
      {
        "id": 0,
        "typeId": 4,
        "nameCn": "行政区",
        "nameEN": "ADMIN_AREA",
        "typeNameCn": "",
        "typeNameEn": "",
        "hotelNum": 0,
        "hasSubNode": true,
        "subHotelFilterInfos": [
          {
            "id": -1,
            "idV4": "0",
            "typeId": 4,
            "nameCn": "不限",
            "nameEN": "All",
            "typeNameCn": "",
            "typeNameEn": "",
            "hotelNum": 0,
            "idCityV4": "0",
            "regionInfo": [],
            "hasSubNode": false,
            "hotFilterWeightInSide": 0,
            "hotFilterWeightOutSide": 0,
            "appWeight": 0,
            "parentTypeName": "行政区",
            "hasExceptHotSubNode": false,
            "selectMode": true,
            "uniqueID": 0
          },
          {
            "id": 100025798,
            "idV4": "3",
            "typeId": 4,
            "nameCn": "朝阳区",
            "nameEN": "chaoyangqu",
            "typeNameCn": "",
            "typeNameEn": "",
            "hotelNum": 0,
            "idCityV4": "101",
            "regionInfo": [],
            "hasSubNode": false,
            "hotFilterWeightInSide": 0,
            "hotFilterWeightOutSide": 0,
            "appWeight": 0,
            "parentTypeName": "行政区",
            "hasExceptHotSubNode": false,
            "selectMode": true,
            "uniqueID": 0
          }
    ]
  },
  "Guid": "d0c6b75d-d16a-4d86-b7f0-f7b4b3e762ad"
}

注意事项

本接口返回信息较多,请根据实际情况使用,不要为了使用某个字段而去开发功能。