一、说明
用于给酒店打周期性活动标签，如踏青赏花、高考特惠等。
总共分两个接口：第一个hotel.label.list是获取所有的标签；第二个hotel.label.hotel是获取某个标签下的酒店ID列表。
二、标签列表
方法名称
hotel.label.list
使用说明
通过该接口获取标签列表，需要周期性拉取，例如1-2天一次；
输入参数
| 节点 | 名称 | 类型 | 可为空 | 说明 |
|---|---|---|---|---|
| StartId |
本次拉取的起始游标id |
Long | N | 首次从0开始，非首次根据前一次最后一条ID拉取 |
| Count | 本次拉取数量 | Integer | N | 例如：100 |
响应结果
| 节点 | 名称 | 类型 | 可为空 | 说明 |
|---|---|---|---|---|
| Count | 标签总数量 | Integer | N |
用来分页获取使用 |
| Labels | 标签列表 | Label | Y | 见Label节点 |
Label节点
| 节点 | 名称 | 类型 | 可为空 | 说明 |
|---|---|---|---|---|
| Id | 标签ID | Long | N | |
| Name | 标签名称 | String | N | 最多8个汉字 |
| Category | 所属分类名称 | String | N | 最多8个汉字 |
| StartTime | 标签有效开始时间 | Date | N |
YYYY-MM-ddT00:00:00+08:00格式 标签的有效时间 |
| EndTime | 标签有效结束时间 | Date | N |
输入参数示例
|
1
2
3
|
|
输出参数示例
{
"Code": "0",
"Result": {
"Count": 10,
"Labels": [{
"Id": 1,
"Name": "电竞",
"Category": "主题特色",
"StartTime": "2022-05-19T00:00:00+08:00",
"EndTime": "2022-06-19T00:00:00+08:00"
}, {
"Id": 2,
"Name": "端午特惠",
"Category": "节日氛围",
"StartTime": "2022-05-19T00:00:00+08:00",
"EndTime": "2022-06-21T00:00:00+08:00"
}]
},
"Guid": "5cb4edaf-4baf-4fc5-a876-05af48dc42da"
}
三、标签酒店
方法名称
hotel.label.hotel
使用说明
通过该接口获取每个标签下的物理酒店ID
输入参数
| 节点 | 名称 | 类型 | 可为空 | 说明 |
|---|---|---|---|---|
| Id |
标签的ID |
Long | N |
从hotel.label.list接口返回的出参中获取 |
| PageIndex | 页码 | Integer | N | 例如：1，本次拉取的页码 |
| PageSize | 每页拉取的数量 | Integer | N | 例如：500，本次拉取500条 |
响应结果
| 节点 | 名称 | 类型 | 可为空 | 说明 |
|---|---|---|---|---|
| Count | 标签总数量 | Integer | N |
用来分页获取使用 |
| HotelIds | 酒店ID列表 | List<String> | Y |
输入参数示例
|
1
2
3
|
|
输出参数示例
{
"Code": "0",
"Result": {
"Count": 100,
"HotelIds": [
"10101149",
"10101148",
"10101147",
"10101146",
"10101142",
"10101143",
"10101144",
"10101145",
"10101140",
"10101141"
]
}
}