接口开发
xxxxxxxx CRS网站接口协议规范 1.20
版本历史
Version 1.20
- 增加get_rate_promotion_list接口，获取可用的促销套餐列表
- create_order增加rate_promotion_id传入
Version 1.19
- 增加get_voucher_type_list，获取可用的优惠劵列表
- 创建订单增加电子劵参数传入，可以抵扣订单金额
- 增加binding_exist_card，绑定第三方帐号
Version 1.18
- search_hotel_rates增加brand品牌条件
- 酒店信息的返回增加brand
- card_deposit_pay_order的参数 card_type_id可以不传
- list_news增加no_content参数
Version 1.17
- list_questions接口作废（未来删除），改成search_questions（传入的参数有变化）
- 增加search_reviews接口
- 增加get_binding_card接口
Version 1.16
- 增加回复留言接口reply_question
- 增加回复点评接口reply_review
Version 1.15
- get_avail_rooms接口修改返回结果格式
- card_login, modify_card_password 支持传入密文密码（必须MD5编码）
- query_cards增加card_no查询参数，会员卡详情增加card_type_name和rate_type_name返回字段
Version 1.14
- 创建订单接口增加业务来源参数
- 增加get_hotel_payment_list接口
Version 1.13
- 增加重新分配预留房间的接口reassign_order_rooms
Version 1.12
- 增加查询可用房间列表get_avail_rooms，增加查询房间信息接口get_room_infos
- 作废原来的get_order_room_availability接口，将在未来一定时候后从代码里删除
- 新闻增加logo返回
Version 1.11
- 增加reset_card_password接口
- deposit_order接口增加payment_seq流水号参数
Version 1.10
- register_card接口的返回值增加价格代码
- list_card_check_records返回值增加hotel_name返回值
- hotel信息返回增加 前台支付最晚时间 和 是否允许匿名会员预订 2个配置值
Version 1.09
- 修改card_login登录接口，不再报错，改为返回状态值
- search_hotel_rates接口增加 disabled_payment_ids返回值
- 修改list_card_deposit_logs接口，增加搜索条件，同时不再和上版接口兼容
- 修改list_card_score_logs接口，增加搜索条件，同时不再和上版接口兼容
Version 1.08
- 增加订单搜索接口
- 增加根据订单号获取订单详情的接口
第一部分 协议简介
1.1 接口底层协议
请求基于HTTP GET/POST，参数通过URL参数传递，返回值是JSON格式。
1.2 协议编码
全部采用UTF-8编码
1.3 公用参数
每次请求都需带上身份验证参数，sob.sob_code（必填），sob.hotel_id，sob.hotelgroup_id （此2个参数只需要传一个，视调用方的身份而定）, sob.password，此4个参数值需调用方向罗盘申请发放。除此之外某些和信息相关的请求还需传送locale参数，如果是中文请求，传送zh_CN，英文请求，传送en。以上几个参数将不再在下面的协议详情里列出。例子 http://test.chinapms.com:9001/gateway/get_hotelgroup_detail?sob.sob_code=www.test.com&sob.password=111111&sob.hotelgroup_id=159&hotelgroup_id=159
1.4 错误处理
当请求失败时，将返回一个异常对象，格式为
失败返回结果范例:
{
“exception_code”: “error.auth.illegal_sob”,
“exception_description”: "接口代码和密码必填"
}
调用方可以通过判断返回的结果对象根下是否有exception_code这个属性来判断调用是否成功。
其中通用的exception_code如下
- error.auth.illegal_sob 非法接口帐号
- system.error 系统错误
1.5 图片显示
通过接口返回的图片信息，只是在服务器上的路径，并不是全url，调用方如果要显示，需要在前面加上服务器，具体格式为http://bj.chinapms.com:8900/crs_images/?path=接口返回的路径，注意这个路径在拼装的时候需要url编码
1.6 数据字典
- room_avail_records room_type_statuses quantity_status 可预订房量状态（0无房 1紧缺 2充足）
- card.gender 性别（0男，1女）
- card.id_card_type_id 证件类型ID（11身份证，13户口薄，31工作证，32介绍信，40无证件，41驾照，90军官证，91警官证，92士兵证，93护照，99其他证件，默认11）
- card.is_actived 注册同时是否激活(0不激活，1激活，默认1)
- order_type 结果排序(0顺序，1逆序，默认0)
- log_type 卡日志类型（0卡激活，1卡充值，2卡消费，3积分操作，4修改卡号，5修改卡类，6修改卡信息，7卡升级，8卡挂失，9卡取消挂失，10补卡，11重置密码，12间夜积分操作）
- score_type 积分日志类型（1积分消费，2返还积分，3初始积分，4添加积分，5扣除积分，6兑换奖品，7入住成功积分奖励，8充值赠送积分，9积分担保，10卡升级扣除积分，11卡升级奖励积分，12推荐会员奖励积分，13 Noshow扣除积分，14 点评奖励积分）
- payment_mode_id 付款方式ID （0前台支付，3在线支付首日房费，7在线支付全部房费）
- order.order_status 0:入住前 1:入住中 2:已退房 3:已取消 4:Noshow
- prepaid_source_code 预付款来源代码（alipay:支付宝）
- gift_application.apply_status 0:等待审批 1:批准 2:完成领取 3:酒店拒绝 4:用户取消
1.7 模型描述
会员卡信息Model
card_type_id: 会员卡类型ID
card_type_name: 会员卡类型名称
card_no: 会员卡号
deposit: 储值余额
card_score: 积分余额
user_name: 用户名
rate_code: 价格代码
rate_type_name: 价格代码名称
gender: 性别
id_card_type_id: 证件类型ID
id_card_no: 证件号
email: 电子邮箱
mobile: 手机
phone: 电话
fax: 传真
address: 地址
zip: 邮编
active_time: 激活时间（YYYY-MM-DD HH:MM:SS）
expire_date: 过期日期（YYYY-MM-DD）
company: 公司
company_address: 公司地址
birth_date: 生日（YYYY-MM-DD）
marry_day: 结婚纪念日（YYYY-MM-DD）
note: 备注
passport_id: 罗盘卡号
total_checks: 总共入住次数
total_room_night: 总共入住间夜数
第二部分 协议详情（酒店相关）
2.1 查询一段时间内可用房态及房价search_hotel_rates
请求参数
condition.hotel_id 酒店编码
condition.hotelgroup_id 集团编码
condition.check_in_date 入住日期（必填）
condition.check_out_date 离店日期（必填）
condition.rate_codes 查询价格代码，用逗号分隔（必填）
condition.room_quantity 需用房间数量
condition.room_type_id 房间类型ID（选填）
condition.city_name 所在城市名字（选填）
condition.city_code 所在城市编码（选填）
condition.name_or_address 要搜索的酒店的名称或者地址关键字（选填）
condition.latitude 要搜索的地标纬度（选填）
condition.longitude 要搜索的地标经度（选填）
condition.brand 酒店品牌
condition.page 搜索分页的页号（0开始，选填）
condition.page_size 搜索分页的每页数量（选填）
返回结果对象
room_avail_records 房态及房价记录列表
记录字段信息：
hotel_id 酒店编码
hotel_name 酒店名称，和请求Locale一致
star 酒店星级(0-5)
logo 酒店logo
hotel_phone 酒店电话
hotel_intro 酒店简单介绍
hotel_address 酒店地址
traffic_guide 酒店交通指南
latitude 纬度
longitude 经度
review_rate 平均点评分
review_count 总点评数
check_in_date 入住日期 冗余
check_out_date 离店日期 冗余
room_type_statuses 各房型价格、早参数和可预订等信息
room_type_id 房间类型编码
room_type_name 房型名称，根据请求Locale
room_type_desc 房型详情信息
logo 房型标志型图片
nights 预订的天数 冗余
room_quantity 预订的房间数量 冗余
prices 每日价格，以价格代码为主键，每个价格代码的映射值对应查询时间段端内的价格数组
breakfasts 每日早餐数，以价格代码为主键，每个价格代码的映射值对应查询时间段端内的早餐数数组
quantities 每日可预订数量数组
quantity_status 可预订房量状态 2有房 1房紧 0无房
disabled_payment_ids 这段时间内禁用的付款方式ID数组
成功返回结果范例
{
“room_avail_records”: [
{
“hotel_id”: “cnbjbjcgmz”,
“hotel_name”: “北京成果酒店民族园店”,
“star”: 3,
“logo”: “logo.png”,
“hotel_phone”: “82313333”,
“hotel_intro”: “北京成果民族园店是一个好酒店”,
“hotel_address”: “北京长安街”,
“traffic_guide”: “做4路公交车直达”,
“latitude”: 40,
“longitude”: 116,
“review_rate”: 3.0,
“review_count”: 100,
“check_in_date”: “2012-01-28”,
“check_out_date”: “2012-02-01”,
“room_type_statuses”: [
{
“room_type_id”: 1481251,
“room_type_name”: “特价房”,
“room_type_desc”: “1.8米大床，免费宽带上网”,
“logo”: “room_logo.jpg”,
“nights”: 4,
“room_quantity”: 3,
“prices”: {
“WEB”: [
100,
100,
100,
100
],
“TEAM”: [
231,
231,
231,
231
]
},
“breakfasts”: {
“WEB”: [
2,
2,
2,
2
],
“TEAM”: [
2,
2,
2,
2
]
},
“quantities”: [
3,
3,
4,
4
],
“quantity_status”: 2,
“disabled_payment_ids”: [“0”, “7”]
},
{
“room_type_id”: 1481221,
“room_type_name”: “商务大床房”,
“room_type_desc”: “1.8米大床，免费宽带上网”,
“logo”: “room_logo.jpg”,
“nights”: 4,
“room_quantity”: 3,
“prices”: {
“WEB”: [
100,
100,
100,
100
],
“TEAM”: [
231,
231,
231,
231
]
},
“breakfasts”: {
“WEB”: [
2,
2,
2,
2
],
“TEAM”: [
2,
2,
2,
2
]
},
“quantities”: [
13,
13,
14,
14
],
“quantity_status”: 2,
“disabled_payment_ids”: [“0”, “7”]
},
{
“room_type_id”: 1481243,
“room_type_name”: “商务标准房”,
“room_type_desc”: “1.8米大床，免费宽带上网”,
“logo”: “room_logo.jpg”,
“nights”: 4,
“room_quantity”: 3,
“prices”: {
“COMPANY”: [
179,
179,
179,
179
],
“WEB”: [
100,
100,
100,
100
],
“TEAM”: [
179,
179,
179,
179
]
},
“breakfasts”: {
“COMPANY”: [
0,
0,
0,
0
],
“WEB”: [
2,
2,
2,
2
],
“TEAM”: [
0,
0,
0,
0
]
},
“quantities”: [
17,
17,
17,
17
],
“quantity_status”: 2
},
{
“room_type_id”: 1481223,
“room_type_name”: “普通双人房”,
“room_type_desc”: “1.8米大床，免费宽带上网”,
“logo”: “room_logo.jpg”,
“nights”: 4,
“room_quantity”: 3,
“prices”: {
“WEB”: [
100,
100,
100,
100
],
“TEAM”: [
123,
123,
123,
123
]
},
“breakfasts”: {
“WEB”: [
2,
2,
2,
2
],
“TEAM”: [
2,
2,
2,
2
]
},
“quantities”: [
6,
6,
7,
7
],
“quantity_status”: 2
},
{
“room_type_id”: 1481227,
“room_type_name”: “休闲房”,
“room_type_desc”: “1.8米大床，免费宽带上网”,
“logo”: “room_logo.jpg”,
“nights”: 4,
“room_quantity”: 3,
“prices”: {
“WEB”: [
100,
100,
100,
100
],
“TEAM”: [
123,
123,
123,
123
]
},
“breakfasts”: {
“WEB”: [
2,
2,
2,
2
],
“TEAM”: [
2,
2,
2,
2
]
},
“quantities”: [
10,
10,
11,
11
],
“quantity_status”: 2
},
{
“room_type_id”: 1481267,
“room_type_name”: “普通单人房”,
“room_type_desc”: “1.8米大床，免费宽带上网”,
“logo”: “room_logo.jpg”,
“nights”: 4,
“room_quantity”: 3,
“prices”: {
“COMPANY”: [
200,
200,
200,
200
],
“WEB”: [
200,
200,
200,
200
],
“TEAM”: [
200,
200,
200,
200
]
},
“breakfasts”: {
“COMPANY”: [
0,
0,
0,
0
],
“WEB”: [
0,
0,
0,
0
],
“TEAM”: [
0,
0,
0,
0
]
},
“quantities”: [
7,
7,
9,
9
],
“quantity_status”: 2
}
]
}
]
}
错误代码
error.hotel.wrong_hotel_and_hotelgroup_id 请输入有效的酒店ID或者酒店集团ID
error.hotel.wrong_check_in_or_out_date 请输入有效的查询房态起止日期
2.2 查看酒店详细介绍get_hotel_detail
请求参数
hotel_id 酒店编码
返回结果对象
hotel : 酒店信息（字段信息见返回范例）
成功返回结果范例
{
“hotel”:
{
“hotel_id”: “cnbjbjbfjy”,
“name”: “北京北方佳苑饭店”,
“email”: “[email protected]”,
“fax”: “010-65287957”,
“phone”: “010-65238888”,
“mobile”: "",
“zip”: “100006”,
“city_code”: “100000”,
“latitude”: 39.9090696321086,
“longitude”: 0.0,
“star”: 3,
“logo”: “logo.jpg”,
“address”: “北京王府井大街218-1号”,
“traffic_guide”: “交通指南”,
“brief_intro”: “酒店简介”,
“detail_intro”: “酒店详细介绍”,
“announce”: “预订须知”,
“room_types”: [
{
“id”: 8,
“name”: “标准间”,
“hotel_id”: “cnbjbjbx001”,
“list_price”: 260,
“total_amount”: 105,
“list_priority”: 12,
“logo”: "room_logo.png"
},
{
“id”: 10,
“name”: “大床间”,
“hotel_id”: “cnbjbjbx001”,
“list_price”: 260,
“total_amount”: 105,
“list_priority”: 12,
“logo”: "room_logo.png"
}
]
}
}
2.3 查看房型详细信息列表get_room_type_list
请求参数
hotel_id 酒店编码
返回结果对象
room_types： 房型信息数组（字段信息见返回范例）
成功返回结果范例：
{
“room_types”: [
{
“id”: 8,
“name”: “标准间”,
“hotel_id”: “cnbjbjbx001”,
“list_price”: 260,
“total_amount”: 105,
“list_priority”: 12,
“logo”: "room_logo.png"
},
{
“id”: 10,
“name”: “大床间”,
“hotel_id”: “cnbjbjbx001”,
“list_price”: 260,
“total_amount”: 105,
“list_priority”: 12,
“logo”: "room_logo.png"
}
]
}
2.4 查看分店详细介绍get_sub_hotel_list
请求参数
默认
返回结果对象
hotels : 酒店信息数组（字段信息见返回范例）
成功返回结果范例
{
hotels
{
“hotel_id”: “cnbjbjbfjy”,
“name”: “北京北方佳苑饭店”,
“email”: “[email protected]”,
“fax”: “010-65287957”,
“phone”: “010-65238888”,
“mobile”: "",
“zip”: “100006”,
“city_code”: “100000”,
“latitude”: 39.9090696321086,
“longitude”: 0.0,
“address”: “北京王府井大街218-1号”,
“traffic_guide”: “交通指南”,
“brief_intro”: “酒店简介”,
“detail_intro”: “酒店详细介绍”,
“announce”: “预订须知”,
default_reserve_hour,
allow_anonymous,
“room_types”: [
{
“id”: 8,
“name”: “标准间”,
“hotel_id”: “cnbjbjbx001”,
“list_price”: 260,
“total_amount”: 105,
“list_priority”: 12,
“logo”: "room_logo.png"
},
{
“id”: 10,
“name”: “大床间”,
“hotel_id”: “cnbjbjbx001”,
“list_price”: 260,
“total_amount”: 105,
“list_priority”: 12,
“logo”: "room_logo.png"
}
]
},
{
“hotel_id”: “cnbjbjbxsw”,
“name”: “北京北新商务饭店”,
“email”: “[email protected]”,
“fax”: “010-65287957”,
“phone”: “010-65238888”,
“mobile”: "",
“zip”: “100006”,
“city_code”: “100000”,
“latitude”: 39.9090696321086,
“longitude”: 110.0,
“address”: “北京东单大街218-1号”,
“traffic_guide”: “交通指南”,
“brief_intro”: “酒店简介”,
“detail_intro”: “酒店详细介绍”,
“announce”: “预订须知”,
“room_types”: [
{
“id”: 8,
“name”: “标准间”,
“hotel_id”: “cnbjbjbx001”,
“list_price”: 260,
“total_amount”: 105,
“list_priority”: 12,
“logo”: "room_logo.png"
},
{
“id”: 10,
“name”: “大床间”,
“hotel_id”: “cnbjbjbx001”,
“list_price”: 260,
“total_amount”: 105,
“list_priority”: 12,
“logo”: "room_logo.png"
}
]
}
]
}
2.5 查看可用价格代码列表get_rate_type_list
请求参数
默认
返回结果对象
rate_types： 价格代码信息数组（字段信息见返回范例）
成功返回结果范例：
{
“rate_types”: [
{
“rate_code”: “WEB”,
“name”: “网络预订价”,
“min_days”: 0,
“advance_day”: 0
},
{
“rate_code”: “cnbjbjbfjy_xxx”,
“name”: “前台价”,
“min_days”: 0,
“advance_day”: 0
}
]
}
2.6 查看可用会员卡类型列表get_card_type_list
请求参数
默认
返回结果对象
card_types： 会员卡类型信息数组（字段信息见返回范例）
成功返回结果范例：
{
“card_types”: [
{
“card_type_id”: “100011”,
“name”: “金卡”,
“rate_code”: “WEB”,
“is_for_register”: true
},
{
“card_type_id”: “100013”,
“name”: “银卡”,
“rate_code”: “USER”,
“is_for_register”: false
},
]
}
2.7 查看酒店房间信息get_room_infos
请求参数
hotel_id 酒店编码（必填）
返回结果对象
room_infos： 房间信息数组（字段信息见返回范例）
成功返回结果范例：
{
“room_infos”: [
{
“room_building_name”: “观海楼”,
“room_direction_name”: “海景”,
“room_no”: “222”,
“room_floor_name”: “一楼”,
“room_type_name”: “标准间”,
“room_type_id”: 1,
“room_id”: 1
},
{
“room_building_name”: “观海楼”,
“room_direction_name”: “市景”,
“room_no”: “301”,
“room_floor_name”: “一楼”,
“room_type_name”: “套间”,
“room_type_id”: 27,
“room_id”: 2
},
{
“room_building_name”: “观海楼”,
“room_direction_name”: “海景”,
“room_no”: “401”,
“room_floor_name”: “一楼”,
“room_type_name”: “套间”,
“room_type_id”: 27,
“room_id”: 3
},
{
“room_building_name”: “观海楼”,
“room_direction_name”: “海景”,
“room_no”: “402”,
“room_floor_name”: “一楼”,
“room_type_name”: “套间”,
“room_type_id”: 27,
“room_id”: 4
},
{
“room_building_name”: “观海楼”,
“room_direction_name”: “海景”,
“room_no”: “403”,
“room_floor_name”: “一楼”,
“room_type_name”: “套间”,
“room_type_id”: 27,
“room_id”: 5
},
{
“room_building_name”: “观海楼”,
“room_direction_name”: “海景”,
“room_no”: “404”,
“room_floor_name”: “一楼”,
“room_type_name”: “套间”,
“room_type_id”: 27,
“room_id”: 6
},
{
“room_building_name”: “观海楼”,
“room_direction_name”: “海景”,
“room_no”: “405”,
“room_floor_name”: “一楼”,
“room_type_name”: “套间”,
“room_type_id”: 27,
“room_id”: 7
},
{
“room_building_name”: “观海楼”,
“room_direction_name”: “海景”,
“room_no”: “406”,
“room_floor_name”: “一楼”,
“room_type_name”: “套间”,
“room_type_id”: 27,
“room_id”: 8
}
]
}
2.8 获取酒店开通的付款方式 get_hotel_payment_list
请求参数
hotel_id 酒店编码（必填）
返回结果对象
payments： 付款信息数组（字段信息见返回范例）
成功返回结果范例：
{
“payments”: [
{
“payment_id”: 1,
“payment_noice”: "请汇款到000000中国银行帐号"
},
{
“payment_id”: 3,
“payment_noice”: "房间可以保留到24点"
}
]
}
2.9 获取酒店或集团可用的电子优惠券类型列表 get_voucher_type_list
请求参数
默认
返回结果对象
voucher_types： 电子优惠券类型信息数组
记录字段信息：
id 劵类型编码
discount_ratio 打折相对幅度的百分比，80表示是原价的80%
discount_bias 打折绝对幅度，-5表示原价减5
amount_per_check 每个订单允许使用的次数
amount_per_room 每间房允许使用的次数
amount_per_night 每间夜允许使用的次数
成功返回结果范例：
{
“voucher_types”: [
{
“id”: “091015143902203647L”,
“name”: “八折劵”,
“discount_ratio”: 80,
“discount_bias”: -5,
“amount_per_check”: 1,
“amount_per_room”: 0,
“amount_per_night”: 0
},
{
“id”: “1209271218231095250S8SY”,
“name”: “10元代金劵”,
“discount_ratio”: 80,
“discount_bias”: -5,
“amount_per_check”: 0,
“amount_per_room”: 0,
“amount_per_night”: 1
}
]
}
2.10 获取酒店或集团可用的促销套餐列表 get_rate_promotion_list
请求参数
默认
返回结果对象
促销套餐信息数组
数组对象记录字段信息：
id 促销套餐编号
name 名称
rate_code 绑定的价格代码
min_days 至少要入住多少天
max_days 至多要入住多少天
max_quantity 最大可预订数量
need_member 是否必须是会员
card_type_ids 允许的会员卡类型编号，#分隔
relative 是否采用相对价格促销
start_clock 可预订的开始时间（小时*100+分钟），例如 1230表示12点半
end_clock 可预订的结束时间
min_advance 至少要提前多少天预订
max_advance 至多能提前多少天预订 0表示必须预订今天的
biz_source_ids 允许的业务来源id，#分隔
rate_promotion_items 促销价格设置的数组
数组对象记录字段信息：
hotel_id 此价格所针对的酒店，空表示针对所有酒店
day_index 此价格要针对第几天的价格
room_rate 绝对方式下的促销价
rate_ratio 相对方式下的促销价 80表示 原价的80%
rate_bias 相对方式下的偏移 -5表示原价-5
should_round 是否要四舍五入
avoid_four 尾数是否要避免4
成功返回结果范例：
{
[
{
“id”: 89,
“hotel_id”: “cnbjbjs8sy”,
“name”: “首日八折”,
“rate_code”: “WEB”,
“min_days”: 0,
“max_days”: 999,
“max_quantity”: 99,
“need_member”: true,
“card_type_ids”: "#11122#23233#"
“relative”: true,
“use_interval”: 0,
“start_clock”: 0,
“end_clock”: 2400,
“min_advance”: 0,
“max_advance”: 999,
“biz_source_ids”: "#10#5#"
“rate_promotion_items”: [{
“hotel_id”: “cnbjbjs8sy”,
“day_index”: 0,
“room_rate”: 0.0,
“rate_ratio”: 80.0,
“rate_bias”: 0.0,
“should_round”: true,
“avoid_four”: true
}]
}
]
}
第三部分 协议详情（订单相关）
3.1 创建订单create_order
请求参数
order.room_order_id 订单号（可选，不输入则系统自动生成）
order.hotel_id 酒店ID（必填）
order.currency_code 货币代码（可选， 不输入默认“CNY”）
order.exchange_rate 货币汇率（可选，默认1.0）
order.room_type_id 房型ID（必填）
order.room_quantity 预订房间数量（必填）
order.adult_quantity 成人数量（必填）
order.child_quantity 儿童数量
order.check_in_date 入住日期（必填）
order.check_out_date 预离日期（必填）
order.rate_code 价格代码（必填）
order.total_order_money 总房价（必填）
order.contacter 预订人（必填）
order.mobile 手机号
order.email 电子邮件
order.phone 电话
order.fax 传真号
order.note 订单备注
order.payment_mode_id 支付方式
order.arrive_info 客人抵达信息
order.earliest_arrive 最早抵达（最早抵达小时数*100+分钟，如1800）
order.latest_arrive 最晚抵达（最晚抵达小时数*100+分钟，如2200）
order.card_type_id 会员卡类型ID
order.card_no 会员卡号
order.voucher_type_id 电子优惠券类型ID
order.voucher_no 电子优惠券号
order.reserve_hour 保留时间
order.guarantee_score 担保积分
order.biz_source_id 订单业务来源
order.rate_promotion_id 促销套餐ID
order.ip 调用接口IP
order.referer_url 调用接口的引用URL
成功后返回结果案例
{
“room_order_id”: "O110307191006734030S"
}
错误代码
error.order.wrong_room_type 房型不存在
error.order.wrong_check_date 订房日期错误
error.order.not_enough_room 房量不足
error.order.no_price 无房价
error.order.wrong_price 房价已变化
error.card.not_exist 卡号卡类型不正确
error.card.quota_limit 此会员超出了当日预订房间数量限额
error.voucher.voucher_finish_consume 电子劵已经消费完毕
error.voucher.voucher_type_disabled 电子券类型已经被禁用
error.voucher.voucher_expired 电子券已经过期
error.voucher.voucher_not_effective 电子券还未生效
error.voucher.wrong_voucher_no 非法电子券号，电子券号必须输入且需要符合电子券类型约束
error.voucher.wrong_voucher_type_id 非法电子券类型
3.2 取消订单cancel_order
请求参数
room_order_id 订单ID（必填）
mobile_or_email 手机号或者电子邮箱（必填）
cancel_reason 取消原因
成功返回结果范例
{
“room_order_id”: "O110307191006734030S"
}
错误代码
error.order.wrong_order_id 非法订单号
error.order.order_query_fail = 订单号错误或者联系方式错误
error.order.exist_unbalanced_card_money 订单存在多余的储值卡或者积分支付的预定金，不能取消
error.order.not_pending_status 只有待入住订单才能取消或者添加预付款
3.3 查看订单详情get_order_detail
请求参数
room_order_id 订单ID（必填）
mobile_or_email 手机号或者电子邮箱（必填）
返回结果对象
order 订单详情
order.room_order_id 订单号
order.hotel_id 酒店ID
order.hotel_name 酒店名称
order.currency_code 货币代码
order.exchange_rate 货币汇率
order.room_type_id 房型ID（crs订单才返回）
order.room_type_code 房型代码
order.room_type_name 房型
order.room_quantity 预订房间数量
order.adult_quantity 成人数量
order.child_quantity 儿童数量
order.check_in_date 入住日期
order.check_out_date 预离日期
order.rate_code 价格代码
order.discount 打折（crs订单才返回）
order.prepaid 预付款
order.total_order_money 总房价
order.contacter 预订人
order.mobile 手机号
order.email 电子邮件
order.phone 电话
order.fax 传真号
order.note 订单备注
order.payment_mode_id 支付方式
order.arrive_info 客人抵达信息
order.earliest_arrive 最早抵达
order.latest_arrive 最晚抵达
order.card_type_id 会员卡类型ID
order.card_no 会员卡号
order.reserve_hour 保留时间
order.guarantee_score 担保积分
order.order_status 订单状态
order.status_desc 订单状态描述
order.cancel_reason 订单取消原因（crs订单才返回）
order.ip 调用接口IP
order.referer_url 调用接口的引用URL（crs订单才返回）
order.created_at 订单创建时间
order.room_nos 订单分配或入住房间号（pms订单才返回）
order.discount 订单打折
成功返回结果案例
{
“order”: {
“room_order_id”: “O111222120419813047S”,
“hotel_id”: “cnbjbjbfjy”,
“exchange_rate”: 1,
“room_type_id”: 1,
“room_quantity”: 1,
“adult_quantity”: 0,
“child_quantity”: 0,
“check_in_date”: “2008-09-01”,
“check_out_date”: “2008-09-12”,
“rate_code”: “WEB”,
“discount”: 0,
“prepaid”: 0,
“total_price”: 0,
“booker_name”: “linmu”,
“mobile”: “13466726411”,
“note”: “取消原因:测试取消订单;”,
“payment_mode_id”: 0,
“reserve_hour”: 18,
“guarantee_score”: 0,
“order_status”: 3,
“ip”: "127.0.0.1"
}
}
错误代码
error.order.wrong_order_id 非法订单号
error.order.not_own_order 非自己的订单
3.4 通知订单付款成功deposit_order
请求参数
deposit_account.room_order_id 订单ID（必填）
deposit_account.money 预付款金额（必填）
deposit_account.prepaid_source_code 预付款来源代码
deposit_account.note 付款备注（可以记录付款的实际渠道，例如支付宝的账号，paypal的名字等）
deposit_account.payment_seq 付款流水号，由支付网关返回，用于唯一标识，避免重复提交
成功返回结果范例
{
“room_order_id”: "O110307191006734030S"
}
错误代码
error.order.wrong_order_id 非法订单号
error.order.not_pending_or_checking_status 订单已经入住完成，被取消或者NoShow，不能付款
error.order.wrong_deposit_money 预付款金额错误
3.5 获取会员卡订单列表get_card_orders
请求参数
card_no(必填)
card_type_id（必填）
order_status 订单状态（选填，不填查询全部状态）
should_paid 是否是待支付订单（应该支付而未支付，选填，不填查询所有）
返回结果对象
orders 订单列表
order 订单详情（字段信息见返回结果案例）
成功返回结果范例
{
“orders”: [
{
“room_order_id”: 53,
“hotel_id”: “cnbjbjbfjy”,
“hotel_name”: “北方佳园酒店”,
“currency_code”: “CNY”,
“exchange_rate”: 1,
“room_type_id”: 1480997,
“room_type_name”: “标准间（中宾）”,
“room_quantity”: 2,
“adult_quantity”: 2,
“child_quantity”: 0,
“check_in_date”: “2012-03-15”,
“check_out_date”: “2012-03-16”,
“rate_code”: “USER”,
“discount”: 0,
“prepaid”: 0,
“total_order_money”: 596,
“contacter”: “陈强”,
“email”: “[email protected]”,
“mobile”: “13810482416”,
“payment_mode_id”: 0,
“card_type_id”: “1480329”,
“card_no”: “99223”,
“reserve_hour”: 24,
“guarantee_score”: 0,
“order_status”: 0,
“status_desc”: “入住前”,
“cancel_reason”: "",
room_nos
},
{
“room_order_id”: 55,
“hotel_id”: “cnbjbjbfjy”,
“currency_code”: “CNY”,
“exchange_rate”: 1,
“room_type_id”: 1480997,
“room_type_name”: “标准间（中宾）”,
“room_quantity”: 2,
“adult_quantity”: 2,
“child_quantity”: 0,
“check_in_date”: “2012-03-15”,
“check_out_date”: “2012-03-16”,
“rate_code”: “USER”,
“discount”: 0,
“prepaid”: 0,
“total_order_money”: 596,
“contacter”: “陈强”,
“email”: “[email protected]”,
“mobile”: “13810482416”,
“payment_mode_id”: 0,
“card_type_id”: “1480329”,
“card_no”: “99223”,
“reserve_hour”: 24,
“guarantee_score”: 0,
“order_status”: 0,
“status_desc”: “入住前”,
“cancel_reason”: "",
room_nos
},
{
“room_order_id”: 57,
“hotel_id”: “cnbjbjbfjy”,
“hotel_name”: “北方佳园酒店”,
“currency_code”: “CNY”,
“exchange_rate”: 1,
“room_type_id”: 1480997,
“room_type_name”: “标准间（中宾）”,
“room_quantity”: 2,
“adult_quantity”: 2,
“child_quantity”: 0,
“check_in_date”: “2012-03-15”,
“check_out_date”: “2012-03-16”,
“rate_code”: “USER”,
“discount”: 0,
“prepaid”: 0,
“total_order_money”: 596,
“contacter”: “陈强”,
“email”: “[email protected]”,
“mobile”: “13810482416”,
“payment_mode_id”: 0,
“card_type_id”: “1480329”,
“card_no”: “99223”,
“reserve_hour”: 24,
“guarantee_score”: 0,
“order_status”: 0,
“status_desc”: “入住前”,
“cancel_reason”: "",
room_nos
},
{
“room_order_id”: 59,
“hotel_id”: “cnbjbjbfjy”,
“hotel_name”: “北方佳园酒店”,
“currency_code”: “CNY”,
“exchange_rate”: 1,
“room_type_id”: 1480997,
“room_type_name”: “标准间（中宾）”,
“room_quantity”: 2,
“adult_quantity”: 2,
“child_quantity”: 0,
“check_in_date”: “2012-03-15”,
“check_out_date”: “2012-03-16”,
“rate_code”: “USER”,
“discount”: 0,
“prepaid”: 0,
“total_order_money”: 596,
“contacter”: “陈强”,
“email”: “[email protected]”,
“mobile”: “13810482416”,
“payment_mode_id”: 0,
“card_type_id”: “1480329”,
“card_no”: “99223”,
“reserve_hour”: 24,
“guarantee_score”: 0,
“order_status”: 0,
“status_desc”: “入住前”,
“cancel_reason”: "",
room_nos
}
]
}
错误代码
error.card.not_exist 卡号卡类型不正确
3.6 储值卡支付订单card_deposit_pay_order
请求参数
room_order_id 订单ID（必填）
deposit 预付款金额（必填）
card_no 会员卡号（必填）
card_type_id 会员卡类型ID（选填）
consume_password 储值卡支付密码
reserve_hour 新保留时间
成功返回结果范例
{
“room_order_id”: "O110307191006734030S"
}
错误代码
error.order.wrong_order_id 非法订单号
error.order.not_pending_or_checking_status 订单已经入住完成，被取消或者NoShow，不能付款
error.order.wrong_deposit_money 预付款金额错误
error.card.not_exist 卡号卡类型不正确
error.card.wrong_consume_password 非法消费密码
error.card.not_enough_deposit 会员卡余额不足
3.7 会员卡积分支付订单card_score_pay_order
请求参数
room_order_id 订单ID（必填）
deposit 预付款金额（必填）
card_no 会员卡号（必填）
card_type_id 会员卡类型ID（必填）
score 会员卡扣除积分
password 会员卡网站登录密码（必填）
reserve_hour 新保留时间
成功返回结果范例
{
“room_order_id”: "O110307191006734030S"
}
错误代码
error.order.wrong_order_id 非法订单号
error.order.not_pending_or_checking_status 订单已经入住完成，被取消或者NoShow，不能付款
error.order.wrong_deposit_money 预付款金额错误
error.order.wrong_deposit_score 支付积分错误
error.card.not_exist 卡号卡类型不正确
error.card.wrong_password 非法密码
error.card.not_enough_score 会员卡积分不足
3.8 查询可用房间列表get_avail_rooms
请求参数
room_type_id 房型ID（必填）
check_in_date 入住日期（必填）
check_out_date 离店日期（必填）
成功返回结果范例
{
“room_infos”: [
{
“room_building_name”: “观海楼”,
“room_direction_name”: “市景”,
“room_no”: “301”,
“room_floor_name”: “一楼”,
“room_type_name”: “套间”,
“room_type_id”: 27,
“room_id”: 2
},
{
“room_building_name”: “观海楼”,
“room_direction_name”: “海景”,
“room_no”: “401”,
“room_floor_name”: “一楼”,
“room_type_name”: “套间”,
“room_type_id”: 27,
“room_id”: 3
},
{
“room_building_name”: “观海楼”,
“room_direction_name”: “海景”,
“room_no”: “402”,
“room_floor_name”: “一楼”,
“room_type_name”: “套间”,
“room_type_id”: 27,
“room_id”: 4
},
{
“room_building_name”: “观海楼”,
“room_direction_name”: “海景”,
“room_no”: “403”,
“room_floor_name”: “一楼”,
“room_type_name”: “套间”,
“room_type_id”: 27,
“room_id”: 5
},
{
“room_building_name”: “观海楼”,
“room_direction_name”: “海景”,
“room_no”: “404”,
“room_floor_name”: “一楼”,
“room_type_name”: “套间”,
“room_type_id”: 27,
“room_id”: 6
},
{
“room_building_name”: “观海楼”,
“room_direction_name”: “海景”,
“room_no”: “405”,
“room_floor_name”: “一楼”,
“room_type_name”: “套间”,
“room_type_id”: 27,
“room_id”: 7
},
{
“room_building_name”: “观海楼”,
“room_direction_name”: “海景”,
“room_no”: “406”,
“room_floor_name”: “一楼”,
“room_type_name”: “套间”,
“room_type_id”: 27,
“room_id”: 8
}
]
}
错误代码
error.order.wrong_room_type 房型不存在
3.9 分配订单预留房房间号assign_order_rooms
请求参数
room_order_id 订单ID（必填）
room_ids 预留房间ID（必填，多个房间ID用逗号隔开）
成功返回结果范例
{
“room_order_id”: "O110307191006734030S"
}
错误代码
error.order.wrong_order_id 非法订单号
error.order.missing_room_ids 预留房间ID必填
error.order.order_assigned_room 订单已经分配了预留房间
3.10 重新分配订单预留房房间号reassign_order_rooms
请求参数
room_order_id 订单ID（必填）
room_ids 预留房间ID（必填，多个房间ID用逗号隔开）
成功返回结果范例
{
“room_order_id”: "O110307191006734030S"
}
错误代码
error.order.wrong_order_id 非法订单号
error.order.missing_room_ids 预留房间ID必填
3.11 搜索订单列表search_orders
请求参数
condition.card_no 会员卡号
condition.card_type_id 会员卡类型
condition.order_status 订单状态
condition.hotel_id 预订的酒店
condition.start_check_in 入住日期范围下限
condition.end_check_in 入住日期范围上限
condition.page 页号（从1开始）
condition.page_size 每页数量
返回结果对象
orders 订单列表
order 订单详情（字段信息见返回结果案例）
成功返回结果范例
同3.5 get_card_orders返回结果
3.12 根据订单号查询订单get_order_by_ids
请求参数
order_ids 订单号（多个订单号需逗号分隔）
返回结果对象
orders 订单列表
order 订单详情（字段信息见返回结果案例）
成功返回结果范例
同3.5 get_card_orders返回结果
3.13 电子券支付订单voucher_pay_order
请求参数
room_order_id 订单ID（必填）
voucher_no 电子券号（必填）
voucher_type_id 电子券类型ID（必填）
成功返回结果范例
{
“room_order_id”: "O110307191006734030S"
}
错误代码
error.order.wrong_order_id 非法订单号
error.voucher.voucher_finish_consume 电子劵已经消费完毕
error.voucher.voucher_type_disabled 电子券类型已经被禁用
error.voucher.voucher_expired 电子券已经过期
error.voucher.voucher_not_effective 电子券还未生效
error.voucher.wrong_voucher_no 非法电子券号，电子券号必须输入且需要符合电子券类型约束
error.voucher.wrong_voucher_type_id 非法电子券类型
error.voucher.not_owner 电子劵不属于此会员
第四部分 协议详情（会员相关）
4.1 注册会员卡register_card
请求参数
card.card_type_id 会员卡类型ID（可选，不输入则采用酒店或集团的默认注册卡类型）
card.card_no 会员卡号(可选，必需符合会员卡类型对卡号的限制，不输入则采用系统自动生成会员卡号)
card.password 密码（必填，明文）
card.consume_password 消费密码（可选，明文）
card.user_name 用户名（必填）
card.gender 性别（必填）
card.id_card_type_id 证件类型ID（必填）
card.id_card_no 证件号（必填）
card.email 电子邮箱
card.mobile 手机
card.phone 电话
card.fax 传真
card.address 地址
card.zip 邮编
card.company 公司名称
card.company_address 公司地址
card.birth_date 生日（YYYY-MM-DD）
card.marry_day 结婚纪念日（YYYY-MM-DD）
card.note 备注
card.is_actived 注册同时是否激活（必填）
card.binding_qq 绑定的QQ openID
card.binding_weixin 绑定的微信openID
card.binding_sina_weibo 绑定的新浪微博帐号
成功返回结果范例
{
“card_id”: “12”,
“card_type_id”: “100”,
“card_no”: “111202172607578643”,
“rate_code”: "WEB"
}
错误代码
error.card.wrong_card_type_id 非法卡类型
error.card.not_for_register_type 网站禁止注册该类型会员卡
error.card.missing_id_card_no 证件号必填
error.card.exist_id_card_no_member 证件号已经注册会员
error.card.exist_email_member Email已经注册会员
error.card.exist_mobile_member 手机号已经注册会员
error.card.missing_password 密码必填
error.card.card_type_full 当前会员卡类型已经注册满或者会员卡号超出卡类型规定范围
error.card.wrong_binding 绑定错误，此第三方帐号已经绑定过
4.2 卡激活active_card
请求参数
card_type_id 会员卡类型ID
card_no 会员卡号
成功返回结果范例
{
“card_id”: “12”,
“card_type_id”: “100”,
“card_no”: "111202172607578643"
}
错误代码
error.card.not_exist 卡号卡类型不正确
error.card.has_actived 会员卡已激活
4.3 会员卡登录card_login
请求参数
card_no 会员卡号或电子邮箱或手机号
password 用户密码
返回结果对象
login_result: 0 表示登录成功，1密码空，2用户名不存在，3用户已禁用，4密码不正确
card: 第一个符合card_no和password的会员卡
数据类型：会员卡信息Model
成功返回结果案例
{
“login_result”: 0,
“card”:
{
“card_type_id”: “100”,
“card_no”: “101”,
“deposit”: 0.0,
“card_score”: 5000.0,
“user_name”: “李四”,
“rate_code”: “WEB”,
“gender”: 0,
“id_card_type_id”: 11,
“id_card_no”: “334455”,
“email”: “[email protected]”,
“mobile”: “12345678910”,
“phone”: ""
“fax”: "",
“address”: “address”,
“zip”: “100098”,
“active_time”: “2009-10-10 12:23:32”,
“expire_date”: "",
“company”: "",
“company_address”: "",
“birth_date”: “1982-12-10”,
“marry_day”: “2006-10-22”,
“is_actived”: false,
“total_checks”: 0,
“total_room_nights”: 0
}
}
错误代码
无
4.4 修改会员卡信息modify_card_profile
请求参数
card.card_type_id 会员卡类型ID（必填）
card.card_no 会员卡号(必填)
card.user_name 用户名
card.gender 称呼
card.id_card_type_id 证件类型ID
card.id_card_no 证件号
card.email 电子邮箱
card.mobile 手机
card.phone 电话
card.fax 传真
card.address 地址
card.zip 邮编
card.company 公司名称
card.company_address 公司地址
card.birth_date 生日（YYYY-MM-DD）
card.marry_day 结婚纪念日（YYYY-MM-DD）
成功返回结果示例
{
“card_id”: “12”,
“card_type_id”: “100”,
“card_no”: "111202172607578643"
}
错误代码
error.card.not_exist 卡号卡类型不正确
error.card.exist_id_card_no_member 证件号已经注册会员
error.card.exist_email_member Email已经注册会员
error.card.exist_mobile_member 手机号已经注册会员
4.5 查看会员卡详情get_card_detail
请求参数
card_type_id 会员卡类型ID（必填）
card_no 会员卡号(必填)
返回结果对象
数据类型：会员卡信息Model
成功返回结果案例
{
“card”:
{
“card_type_id”: “100”,
“card_no”: “101”,
“deposit”: 0.0,
“card_score”: 5000.0,
“user_name”: “李四”,
“gender”: 0,
“id_card_type_id”: 11,
“id_card_no”: “334455”,
“email”: “[email protected]”,
“mobile”: “12345678910”,
“phone”: "",
“fax”: "",
“address”: “address”,
“zip”: “100098”,
“active_time”: “2009-10-10 12:23:32”,
“expire_date”: "",
“company”: "",
“company_address”: "",
“birth_date”: “1982-12-10”,
“marry_day”: “2006-10-22”,
“is_actived”: false,
“total_checks”: 0,
“total_room_nights”: 0
}
}
4.6 查看会员卡客史list_card_check_records
请求参数（会员卡类型和会员卡号不为空 或者 订单号不为空）
condition.card_type_id 会员卡类型ID
condition.card_no 会员卡号
condition.room_order_id 订单号
condition.hotel_id 入住的酒店
condition.start_date 入住起始日期（YYYY-MM-DD）
condition.end_date 入住终止日期（YYYY-MM-DD）
condition.order_type 排序方式（0升序，1倒序，默认0）
condition.page 页号，从1开始（选填）
condition.page_size 每页记录条数（选填）
返回结果对象
histories 客史列表
客史信息字段
id 客史ID
hotel_id 酒店编码
hotel_name 酒店名称
room_no 入住房间号
room_type_name 房型名称
check_in_date 入住日期
check_out_date 离店日期
guest_name 入住客人
room_rate 房价
total_fee 总消费
room_fee 总房费
food_fee 餐饮费
other_fee 其他费用
points 消费所得积分
room_order_id 对应PMS客房订单ID
mms_review_id 对应的点评ID
成功返回结果范例
{
“histories”:
[
{
“id”: 19,
“hotel_id”: “cnbjbjbx00”,
“hotel_name”: “北京饭店”,
“room_no”: “A301”,
“room_type_name”: “标准间”,
“check_in_date”: “2008-09-09”,
“check_out_date”: “2008-09-12”,
“guest_name”: “jacky”,
“room_rate”: 218.0,
“total_fee”: 1280.0,
“room_fee”: 872.0,
“food_fee”: 328.0,
“other_fee”: 80.0,
“points”: 300.0,
“room_order_id”: "123456
},
{
“id”: 20,
“hotel_id”: “cnbjbjbx01”,
“room_no”: “A302”,
“check_in_date”: “2008-09-09”,
“check_out_date”: “2008-09-12”,
“guest_name”: “andy”,
“room_rate”: 218.0,
“total_fee”: 1280.0,
“room_fee”: 872.0,
“food_fee”: 328.0,
“other_fee”: 80.0,
“points”: 300.0,
“room_order_id”: "123458"
}
]
}
4.7 修改会员卡密码modify_card_password
请求参数
card_type_id 会员卡类型ID（必填）
card_no 会员卡号（必填）
password 会员卡旧密码（可选，明文，不上送不验证）
new_password 会员卡新密码（必填，明文）
成功返回结果范例
{
“card_type_id”: “100”,
“card_no”: "111202172607578643"
}
错误代码
error.card.not_exist 卡号卡类型不正确
error.card.wrong_password 非法密码
4.8 修改储值卡消费密码modify_card_consume_password
请求参数
card_type_id 会员卡类型ID（必填）
card_no 会员卡号（必填）
password 会员卡密码（必填，明文）
new_consume_password 会员卡新消费密码（必填，明文）
成功返回结果范例
{
“card_id”: “12”,
“card_type_id”: “100”,
“card_no”: "111202172607578643"
}
错误代码
error.card.not_exist 卡号卡类型不正确
error.card.missing_password 密码不能为空
error.card.wrong_password 非法密码
4.9 查看会员卡积分操作日志list_card_score_logs
请求参数
condition.card_type_id 会员卡类型ID
condition.card_no 会员卡号
condition.start_date 日志最早日期（选填）
condition.end_date 日志最晚日期（选填）
condition.page 页号，从1开始（选填）
condition.page_size 每页记录数（选填）
返回结果对象
logs 积分操作日志列表
积分操作日期信息字段：
hotel_id 操作酒店编码
card_type_id 会员卡类型ID
card_no 会员卡号
log_type 卡日志类型
score_type 积分日志类型
log_date 积分操作营业日（YYYY-MM-DD）
log_time 积分操作时间（YYYY-MM-DD HH:MM:SS）
deposit_money 储值金额
score 积分
operator_id 操作员ID
note 备注
成功返回结果范例
{
“logs”:
[
{
“hotel_id”: “cnbjbjbx00”,
“card_type_id”: “100”,
“card_no”: “101”,
“log_type”: 0,
“score_type”: 8,
“log_date”: “2009-09-12”,
“log_time”: “2009-09-12 16:30:12”,
“deposit_money”: 1000.0,
“score”: 100.0,
“operator_id”: “cnbjbjbfjy”,
“note”: "储值1000，送100积分"
},
{
“hotel_id”: “cnbjbjbfjy”,
“card_type_id”: “100”,
“card_no”: “101”,
“log_type”: 0,
“score_type”: 8,
“log_date”: “2009-09-16”,
“log_time”: “2009-09-16 19:38:12”,
“deposit_money”: 5000.0,
“score”: 500.0,
“operator_id”: “cnbjbjbfjy”,
“note”: "储值5000，送500积分"
}
]
}
4.10 查看储值卡消费日志list_card_deposit_logs
请求参数
condition.card_type_id 会员卡类型ID
condition.card_no 会员卡号
condition.start_date 日志最早日期
condition.end_date 日志最晚日期
condition.page 页号，从1开始（选填）
condition.page_size 每页记录数（选填）
返回结果对象
logs 储值操作日志列表
储值操作日期信息字段：
hotel_id 操作酒店编码
card_type_id 会员卡类型ID
card_no 会员卡号
log_type 卡日志类型
score_type 积分日志类型
log_date 积分操作营业日（YYYY-MM-DD）
log_time 积分操作时间（YYYY-MM-DD HH:MM:SS）
deposit_money 储值金额
score 积分
operator_id 操作员ID
note 备注
成功返回结果范例
{
“logs”:
[
{
“hotel_id”: “cnbjbjbx00”,
“card_type_id”: “100”,
“card_no”: “101”,
“log_type”: 0,
“score_type”: 8,
“log_date”: “2009-09-12”,
“log_time”: “2009-09-12 16:30:12”,
“deposit_money”: 1000.0,
“score”: 100.0,
“operator_id”: “cnbjbjbfjy”,
“note”: "储值1000，送100积分"
},
{
“hotel_id”: “cnbjbjbfjy”,
“card_type_id”: “100”,
“card_no”: “101”,
“log_type”: 0,
“score_type”: 8,
“log_date”: “2009-09-16”,
“log_time”: “2009-09-16 19:38:12”,
“deposit_money”: 5000.0,
“score”: 500.0,
“operator_id”: “cnbjbjbfjy”,
“note”: "储值5000，送500积分"
}
]
}
4.10 修改会员卡积分modify_card_score
请求参数
card_type_id 会员卡类型ID
card_no 会员卡号
score 修改积分（正数为添加，负数为扣减）
note 备注
返回结果对象
card_id 会员卡ID
card_type_id 会员卡类型ID
card_no 会员卡号
card_score 会员卡积分
成功返回结果范例
{
“card_id”: “12”,
“card_type_id”: “100”,
“card_no”: “111202172607578643”,
“card_score”: "1200.0"
}
错误代码
error.card.not_exist 卡号卡类型不正确
error.card.not_enough_score 会员卡积分不足
4.11 查询会员卡query_cards
请求参数
condition.user_name 用户名
condition.mobile 手机号
condition.birthday 生日（四位字符串，如0613）
condition.phone 座机号
condition.card_no 卡号
（以上查询条件必须输入其中一个）
返回结果对象
cards: 符合查询条件的会员卡列表
数据类型：会员卡信息Model
成功返回结果案例
{
“cards”: [
{
“hotel_id”: “cnbjbjbfjy”,
“card_type_id”: “100363”,
“card_type_name”: “金卡”,
“card_no”: “112233”,
“rate_code”: “TEAM”,
“rate_type_name”: “团队价”,
“deposit”: 200,
“card_score”: 0,
“user_name”: “jacky”,
“gender”: 0,
“id_card_type_id”: 40,
“id_card_no”: "",
“email”: "",
“mobile”: "",
“phone”: "",
“fax”: "",
“address”: "",
“company”: “安得物流公司成都物流中心”,
“company_address”: “成华大道24号”,
“is_actived”: true,
“active_time”: “2012-03-13 16:45:34”,
“last_modify_time”: “2012-03-14 14:29:35”,
“note”: "",
“total_checks”: 0,
“total_room_nights”: 0
},
{
“hotel_id”: “cnbjbjbfjy”,
“card_type_id”: “100374”,
“card_no”: “2233445568”,
“rate_code”: “WEB”,
“deposit”: 0,
“card_score”: 0,
“user_name”: “jacky”,
“gender”: 0,
“id_card_type_id”: 11,
“id_card_no”: “1234567”,
“email”: "",
“mobile”: “01001”,
“phone”: "",
“fax”: "",
“address”: "",
“zip”: "",
“company”: "",
“company_address”: "",
“birth_date”: “2012-01-08”,
“marry_day”: “2012-02-02”,
“is_actived”: true,
“active_time”: “2012-02-08 18:11:56”,
“last_modify_time”: “2012-02-08 18:11:57”,
“total_checks”: 0,
“total_room_nights”: 0
}
]
}
错误代码
error.card.login_fail 帐号密码不正确
4.12 重置会员卡密码reset_card_password
请求参数
card_no 会员卡号（必填）
mobile 手机号（必填
成功返回结果案例
{
“card_id”: “12”,
“card_type_id”: “100”,
“card_no”: "111202172607578643"
}
错误代码
error.card.not_exist 卡号卡类型不正确
4.13 返回第三方帐号关联的会员卡信息get_binding_card
请求参数
qq 腾讯QQ openID
weixin 微信 openID
sina_weibo 新浪微博帐号
返回结果对象
同接口4.5
成功返回结果案例
同接口4.5
4.14 获取会员电子劵列表 get_card_vouchers
请求参数
card_type_id 会员卡类型ID
card_no 会员卡号
返回结果对象
vouchers 电子劵列表
电子劵信息字段：
voucher_type_name 电子劵名称
voucher_type_id 电子劵类型ID
voucher_no 劵号
sell_time 获得时间（YYYY-MM-DD HH:MM:SS）
effective_date 有效日开始（YYYY-MM-DD）
expire_date 过期日（YYYY-MM-DD）
left_times 剩余使用次数
成功返回结果范例
{
“vouchers”:
[
{
“voucher_type_name”: “10元劵”,
“voucher_type_id”: “100”,
“voucher_no”: “101”,
“sell_time”: “2009-09-12 16:30:12”,
“effective_date”: “2009-09-12”,
“expire_date”: “2009-09-15”,
“left_times”: 1
},
{
“voucher_type_name”: “10元劵”,
“voucher_type_id”: “100”,
“voucher_no”: “102”,
“sell_time”: “2009-09-12 16:30:12”,
“effective_date”: “2009-09-12”,
“expire_date”: “2009-09-15”,
“left_times”: 1
}
]
}
4.15 绑定第三方帐号binding_exist_card
请求参数
card_no 卡号
card_type_id 卡类型ID
qq 腾讯QQ openID
weixin 微信 openID
sina_weibo 新浪微博帐号
返回结果对象
空
错误代码
error.card.not_exist 卡号卡类型不正确
error.card.wrong_binding 绑定错误，此第三方帐号已经绑定过
第五部分 协议详情（奖品相关）
5.1 获取有效奖品列表list_gifts
请求参数
默认
返回结果对象
gifts : 奖品信息数组
奖品信息对象字段
id: 奖品编码
score: 兑换奖品所需积分
name: 奖品名称
logo: 奖品图片（在远程服务器上）
成功返回结果范例
{
“gifts”: [
{
“id”: 1336088,
“score”: 500,
“name”: "鼠标垫"
},
{
“id”: 1336089,
“score”: 1500,
“name”: "雨伞"
}
]
}
5.2 申请兑换奖品apply_gift
请求参数
apply.gift_id 请求的奖品ID（必填）
apply.gift_quantity 请求兑换的奖品份数（必填）
apply.exchange_hotel_id 希望兑换奖品的所在分店的编码（可选，在单店申请的奖品需要填写单店hotel_id）
apply.card_type_id: 会员卡类型ID（必填）
apply.card_no: 会员卡号（必填）
成功返回结果范例
{}
错误代码
error.gift.wrong_gift_id 奖品ID不正确
error.card.not_exist 卡号卡类型不正确
error.card.not_enough_score 会员卡积分不足
5.3 取消奖品申请cancel_gift_application
请求参数
gift_application_id 需要取消的奖品申请ID（必填）
cancel_reason 取消原因（可选）
card_type_id 会员卡类型ID（必填）
card_no 会员卡号（必填）
成功返回结果范例
{}
错误代码
error.card.not_exist卡号卡类型不正确
error.gift_apply.wrong_application_id 奖品申请ID不正确
error.gift_apply.not_own_application 不属于自己的奖品申请
error.gift_apply.not_pending_status 只有待审批的申请才能取消
5.4 奖品申请列表list_gift_applications
请求参数
card_type_id 会员卡类型ID（必填）
card_no 会员卡号（必填）
返回结果对象
applications : 奖品申请列表数组
奖品申请信息对象字段
id: 奖品申请编码
gift_id: 奖品编码
gift_name: 奖品名称
gift_quantity: 申请奖品数量
exchange_hotel_id: 兑换奖品酒店编码
card_type_id: 会员卡类型ID
card_no: 会员卡号
locale: 语言
score: 兑换奖品所需积分
apply_time: 申请时间
apply_status: 申请状态
approve_time: 批准申请时间
approve_operator_id: 批准人ID
complete_time: 完成领取时间
complete_operator_id: 完成领取操作员
decline_time: 拒绝时间
decline_operator_id: 拒绝人
note: 备注
成功返回结果范例
{
“applications”: [
{
“id”: 1,
“gift_id”: 1479381,
“gift_name”: “雨伞”,
“gift_quantity”: 1,
“exchange_hotel_id”: “cngdgzwxhj”,
“card_type_id”: “1480317”,
“card_no”: “0000”,
“locale”: “zh_CN”,
“score”: 500,
“apply_time”: “2009-08-12 10:05:40”,
“apply_status”: 2,
“approve_time”: “2009-08-12 10:05:40”,
“note”: "8-9"
},
{
“id”: 2,
“gift_id”: 1479381,
“gift_name”: “雨伞”,
“gift_quantity”: 1,
“exchange_hotel_id”: “cngdgzwxhj”,
“card_type_id”: “1480317”,
“card_no”: “0000”,
“locale”: “zh_CN”,
“score”: 500,
“apply_time”: “2009-08-12 10:05:56”,
“apply_status”: 2,
“approve_time”: “2009-08-12 10:05:56”,
“note”: "8-9"
},
{
“id”: 3,
“gift_id”: 1479381,
“gift_name”: “雨伞”,
“gift_quantity”: 1,
“exchange_hotel_id”: “cngdgzwxhj”,
“card_type_id”: “1480317”,
“card_no”: “0000”,
“locale”: “zh_CN”,
“score”: 500,
“apply_time”: “2009-08-12 10:06:09”,
“apply_status”: 2,
“approve_time”: “2009-08-12 10:06:09”,
“note”: "8-9"
},
{
“id”: 4,
“gift_id”: 1479381,
“gift_name”: “雨伞”,
“gift_quantity”: 1,
“exchange_hotel_id”: “cngdgzwxhj”,
“card_type_id”: “1480317”,
“card_no”: “0000”,
“locale”: “zh_CN”,
“score”: 500,
“apply_time”: “2009-08-12 10:06:23”,
“apply_status”: 2,
“approve_time”: “2009-08-12 10:06:23”,
“note”: "8-9"
},
{
“id”: 5,
“gift_id”: 1479381,
“gift_name”: “雨伞”,
“gift_quantity”: 1,
“exchange_hotel_id”: “cngdgzwxhj”,
“card_type_id”: “1480317”,
“card_no”: “0000”,
“locale”: “zh_CN”,
“score”: 500,
“apply_time”: “2009-08-12 10:06:36”,
“apply_status”: 2,
“approve_time”: “2009-08-12 10:06:36”,
“note”: "8-9"
},
{
“id”: 6,
“gift_id”: 1479381,
“gift_name”: “雨伞”,
“gift_quantity”: 1,
“exchange_hotel_id”: “cngdgzwxhj”,
“card_type_id”: “1480317”,
“card_no”: “0000”,
“locale”: “zh_CN”,
“score”: 500,
“apply_time”: “2009-08-12 10:06:50”,
“apply_status”: 2,
“approve_time”: “2009-08-12 10:06:50”,
“note”: "8-9"
}
]
}
第六部分 协议详情（点评相关）
6.1获取某一个酒店点评综合情况get_hotel_review_stats
请求参数
hotel_id 酒店ID（必填）
返回结果对象
stats: 点评统计
hotel_id: 点评酒店ID
review_type_id: 点评项类型ID
review_count: 点评数
average_rate: 点评平均分
成功返回结果范例
{
“stats”: [
{
“hotel_id”: “cnbjbjcgmz”,
“review_type_id”: 1,
“review_count”: 2,
“average_rate”: 5
},
{
“hotel_id”: “cnbjbjcgmz”,
“review_type_id”: 2,
“review_count”: 2,
“average_rate”: 5
},
{
“hotel_id”: “cnbjbjcgmz”,
“review_type_id”: 3,
“review_count”: 2,
“average_rate”: 5
},
{
“hotel_id”: “cnbjbjcgmz”,
“review_type_id”: 4,
“review_count”: 2,
“average_rate”: 5
}
]
}
6.2获取某条点评各项评分详情get_review_detail
请求参数
review_id 点评ID（必填）
错误代码
error.review.not_exist 点评不存在
返回结果对象
review: 点评信息对象
id: 点评ID
hotelgroup_id: 点评酒店所属集团ID
card_id: 点评会员卡ID
card_no: 点评会员卡号
user_name: 会员卡用户名
review_hotel_id: 所点评酒店ID
check_in_date: 会员卡客史入住日期
check_out_date: 会员卡客史离店日期
locale: 语言
content: 点评内容
score: 点评获得积分
average_rate: 点评在几个项目里的平均分
created_at: 点评时间
reply: 点评回复内容
reply_user_id: 点评回复用户ID
mms_review_rates: 点评各项评分
review_type_id: 点评项类型ID
rate: 评分
成功返回结果范例
{
“review”: {
“id”: 1,
“hotelgroup_id”: “159”,
“card_id”: 1633513,
“card_no”: “200019”,
“user_name”: “jack”,
“review_hotel_id”: “cnbjbjcgmz”,
“check_in_date”: “2010-11-19”,
“check_out_date”: “2010-11-19”,
“locale”: “zh-cn”,
“content”: “酒店装修很漂亮，房间也还不错，比较宽敞，设施齐全，价格比较实惠，总体来说很OK”,
“score”: 10,
“average_rate”: 5,
“created_at”: “2010-11-20 14:38:27”,
“mms_review_rates”: [
{
“review_type_id”: 1,
“rate”: 5
},
{
“review_type_id”: 2,
“rate”: 5
},
{
“review_type_id”: 4,
“rate”: 5
},
{
“review_type_id”: 3,
“rate”: 5
}
]
}
}
6.3增加点评add_review
请求参数
history_id 客史ID（必填）
card_no 点评会员卡号
card_type_id 点评会员卡类型
content 点评内容
review_rates 点评项评分数组（点评项字段包括：review_type_id 点评项类型ID; rate 评分）
返回结果对象
review_id 返回对象id
成功返回结果范例
{
“review_id”: 11232
}
错误代码
error.member_history.not_exist 客史不存在
error.member_history.had_reviewed 此客史已经发表过点评
error.card.not_exist 卡号卡类型不正确
6.4获取某会员点评列表get_card_reviews
请求参数
card_type_id 会员卡类型（必填）
card_no 会员卡号（必填）
page 当前页 （允许空）
per_page 页大小（允许空，空表示不分页）
返回结果对象
reviews: 点评对象列表
review: 点评信息对象
id: 点评ID
hotelgroup_id: 点评酒店所属集团ID
card_id: 点评会员卡ID
card_no: 点评会员卡号
user_name: 会员卡用户名
review_hotel_id: 所点评酒店ID
check_in_date: 会员卡客史入住日期
check_out_date: 会员卡客史离店日期
locale: 语言
content: 点评内容
score: 点评获得积分
average_rate: 点评在几个项目里的平均分
created_at: 点评时间
reply: 点评回复内容
reply_user_id: 点评回复用户ID
mms_review_rates: 点评各项评分
review_type_id: 点评项类型ID
rate: 评分
total_entries: 总点评条数
成功返回结果范例
{
“reviews”: [
{
“id”: 1,
“card_id”: 1635639,
“card_no”: “01000”,
“user_name”: “周明红”,
“review_hotel_id”: “cnbjbjbfjy”,
“check_in_date”: “2008-09-12”,
“check_out_date”: “2008-09-12”,
“locale”: “zh_CN”,
“content”: “a”,
“score”: 10,
“average_rate”: 3.17,
“created_at”: “2012-03-15 20:10:35”,
“mms_review_rates”: [
{
“review_type_id”: 1,
“rate”: 2
},
{
“review_type_id”: 2,
“rate”: 3
},
{
“review_type_id”: 3,
“rate”: 4
},
{
“review_type_id”: 4,
“rate”: 5
},
{
“review_type_id”: 5,
“rate”: 2
},
{
“review_type_id”: 6,
“rate”: 3
}
]
},
{
“id”: 2,
“card_id”: 1635639,
“card_no”: “01000”,
“user_name”: “周明红”,
“review_hotel_id”: “cnbjbjbfjy”,
“check_in_date”: “2008-08-15”,
“check_out_date”: “2008-08-15”,
“locale”: “zh_CN”,
“content”: "",
“score”: 10,
“average_rate”: 3,
“created_at”: “2012-03-15 20:08:18”,
“mms_review_rates”: [
{
“review_type_id”: 1,
“rate”: 2
},
{
“review_type_id”: 2,
“rate”: 3
},
{
“review_type_id”: 3,
“rate”: 2
},
{
“review_type_id”: 4,
“rate”: 4
},
{
“review_type_id”: 5,
“rate”: 4
},
{
“review_type_id”: 6,
“rate”: 3
}
]
},
{
“id”: 3,
“card_id”: 1635639,
“card_no”: “01000”,
“user_name”: “周明红”,
“review_hotel_id”: “cnbjbjbfjy”,
“check_in_date”: “2008-09-20”,
“check_out_date”: “2008-09-20”,
“locale”: “zh_CN”,
“content”: "",
“score”: 10,
“average_rate”: 3.3333333333333335,
“created_at”: “2012-03-15 20:06:31”,
“mms_review_rates”: [
{
“review_type_id”: 1,
“rate”: 2
},
{
“review_type_id”: 2,
“rate”: 3
},
{
“review_type_id”: 3,
“rate”: 4
},
{
“review_type_id”: 4,
“rate”: 4
},
{
“review_type_id”: 5,
“rate”: 2
},
{
“review_type_id”: 6,
“rate”: 5
}
]
},
{
“id”: 4,
“card_id”: 1635639,
“card_no”: “01000”,
“user_name”: “周明红”,
“review_hotel_id”: “cnbjbjbfjy”,
“check_in_date”: “2008-09-09”,
“check_out_date”: “2008-09-14”,
“locale”: “zh_CN”,
“content”: “还可以下次还来，还可以下次还来，还可以下次还来，还可以下次还来，还可以下次还来，还可以下次还来~~”,
“score”: 10,
“average_rate”: 3.1666666666666665,
“created_at”: “2012-03-13 14:49:46”,
“mms_review_rates”: [
{
“review_type_id”: 1,
“rate”: 2
},
{
“review_type_id”: 2,
“rate”: 4
},
{
“review_type_id”: 3,
“rate”: 3
},
{
“review_type_id”: 4,
“rate”: 3
},
{
“review_type_id”: 5,
“rate”: 4
},
{
“review_type_id”: 6,
“rate”: 3
}
]
},
{
“id”: 5,
“card_id”: 1635639,
“card_no”: “01000”,
“user_name”: “周明红”,
“review_hotel_id”: “cnbjbjbfjy”,
“check_in_date”: “2008-09-12”,
“check_out_date”: “2008-09-12”,
“locale”: “zh_CN”,
“content”: “很不错，卫生0”,
“score”: 10,
“average_rate”: 3.5,
“created_at”: "2012-02-05 20:19:26"
},
{
“id”: 6,
“card_id”: 1635639,
“card_no”: “01000”,
“user_name”: “周明红”,
“review_hotel_id”: “cnbjbjbfjy”,
“check_in_date”: “2008-09-12”,
“check_out_date”: “2008-09-12”,
“locale”: “zh_CN”,
“content”: “很不错，卫生9”,
“score”: 10,
“average_rate”: 3.5,
“created_at”: "2012-02-05 20:19:26"
},
{
“id”: 7,
“card_id”: 1635639,
“card_no”: “01000”,
“user_name”: “周明红”,
“review_hotel_id”: “cnbjbjbfjy”,
“check_in_date”: “2008-09-12”,
“check_out_date”: “2008-09-12”,
“locale”: “zh_CN”,
“content”: “很不错，卫生8”,
“score”: 10,
“average_rate”: 3.5,
“created_at”: "2012-02-05 20:19:26"
},
{
“id”: 8,
“card_id”: 1635639,
“card_no”: “01000”,
“user_name”: “周明红”,
“review_hotel_id”: “cnbjbjbfjy”,
“check_in_date”: “2008-09-12”,
“check_out_date”: “2008-09-12”,
“locale”: “zh_CN”,
“content”: “很不错，卫生7”,
“score”: 10,
“average_rate”: 3.5,
“created_at”: "2012-02-05 20:19:26"
},
{
“id”: 9,
“card_id”: 1635639,
“card_no”: “01000”,
“user_name”: “周明红”,
“review_hotel_id”: “cnbjbjbfjy”,
“check_in_date”: “2008-09-12”,
“check_out_date”: “2008-09-12”,
“locale”: “zh_CN”,
“content”: “很不错，卫生6”,
“score”: 10,
“average_rate”: 3.5,
“created_at”: "2012-02-05 20:19:26"
},
{
“id”: 10,
“card_id”: 1635639,
“card_no”: “01000”,
“user_name”: “周明红”,
“review_hotel_id”: “cnbjbjbfjy”,
“check_in_date”: “2008-09-12”,
“check_out_date”: “2008-09-12”,
“locale”: “zh_CN”,
“content”: “很不错，卫生5”,
“score”: 10,
“average_rate”: 3.5,
“created_at”: "2012-02-05 20:19:26"
}
],
“total_entries”: 16
}
6.5获取某酒店点评列表get_hotel_reviews
请求参数
hotel_id 酒店编号（必填）
page 当前页 （允许空）
per_page 页大小（允许空，空表示不分页）
返回结果对象
reviews: 点评对象列表
review: 点评信息对象
id: 点评ID
hotelgroup_id: 点评酒店所属集团ID
card_id: 点评会员卡ID
card_no: 点评会员卡号
user_name: 会员卡用户名
review_hotel_id: 所点评酒店ID
check_in_date: 会员卡客史入住日期
check_out_date: 会员卡客史离店日期
locale: 语言
content: 点评内容
score: 点评获得积分
average_rate: 点评在几个项目里的平均分
created_at: 点评时间
reply: 点评回复内容
reply_user_id: 点评回复用户ID
mms_review_rates: 点评各项评分
review_type_id: 点评项类型ID
rate: 评分
total_entries: 总点评条数
成功返回结果范例
{
“reviews”: [
{
“id”: 1,
“card_id”: 1635639,
“card_no”: “01000”,
“user_name”: “周明红”,
“review_hotel_id”: “cnbjbjbfjy”,
“check_in_date”: “2008-09-12”,
“check_out_date”: “2008-09-12”,
“locale”: “zh_CN”,
“content”: “a”,
“score”: 10,
“average_rate”: 3.17,
“created_at”: “2012-03-15 20:10:35”,
“mms_review_rates”: [
{
“review_type_id”: 1,
“rate”: 2
},
{
“review_type_id”: 2,
“rate”: 3
},
{
“review_type_id”: 3,
“rate”: 4
},
{
“review_type_id”: 4,
“rate”: 5
},
{
“review_type_id”: 5,
“rate”: 2
},
{
“review_type_id”: 6,
“rate”: 3
}
]
},
{
“id”: 2,
“card_id”: 1635639,
“card_no”: “01000”,
“user_name”: “周明红”,
“review_hotel_id”: “cnbjbjbfjy”,
“check_in_date”: “2008-08-15”,
“check_out_date”: “2008-08-15”,
“locale”: “zh_CN”,
“content”: "",
“score”: 10,
“average_rate”: 3,
“created_at”: “2012-03-15 20:08:18”,
“mms_review_rates”: [
{
“review_type_id”: 1,
“rate”: 2
},
{
“review_type_id”: 2,
“rate”: 3
},
{
“review_type_id”: 3,
“rate”: 2
},
{
“review_type_id”: 4,
“rate”: 4
},
{
“review_type_id”: 5,
“rate”: 4
},
{
“review_type_id”: 6,
“rate”: 3
}
]
},
{
“id”: 3,
“card_id”: 1635639,
“card_no”: “01000”,
“user_name”: “周明红”,
“review_hotel_id”: “cnbjbjbfjy”,
“check_in_date”: “2008-09-20”,
“check_out_date”: “2008-09-20”,
“locale”: “zh_CN”,
“content”: "",
“score”: 10,
“average_rate”: 3.3333333333333335,
“created_at”: “2012-03-15 20:06:31”,
“mms_review_rates”: [
{
“review_type_id”: 1,
“rate”: 2
},
{
“review_type_id”: 2,
“rate”: 3
},
{
“review_type_id”: 3,
“rate”: 4
},
{
“review_type_id”: 4,
“rate”: 4
},
{
“review_type_id”: 5,
“rate”: 2
},
{
“review_type_id”: 6,
“rate”: 5
}
]
},
{
“id”: 4,
“card_id”: 1635639,
“card_no”: “01000”,
“user_name”: “周明红”,
“review_hotel_id”: “cnbjbjbfjy”,
“check_in_date”: “2008-09-09”,
“check_out_date”: “2008-09-14”,
“locale”: “zh_CN”,
“content”: “还可以下次还来，还可以下次还来，还可以下次还来，还可以下次还来，还可以下次还来，还可以下次还来~~”,
“score”: 10,
“average_rate”: 3.1666666666666665,
“created_at”: “2012-03-13 14:49:46”,
“mms_review_rates”: [
{
“review_type_id”: 1,
“rate”: 2
},
{
“review_type_id”: 2,
“rate”: 4
},
{
“review_type_id”: 3,
“rate”: 3
},
{
“review_type_id”: 4,
“rate”: 3
},
{
“review_type_id”: 5,
“rate”: 4
},
{
“review_type_id”: 6,
“rate”: 3
}
]
},
{
“id”: 5,
“card_id”: 1635639,
“card_no”: “01000”,
“user_name”: “周明红”,
“review_hotel_id”: “cnbjbjbfjy”,
“check_in_date”: “2008-09-12”,
“check_out_date”: “2008-09-12”,
“locale”: “zh_CN”,
“content”: “很不错，卫生0”,
“score”: 10,
“average_rate”: 3.5,
“created_at”: "2012-02-05 20:19:26"
},
{
“id”: 6,
“card_id”: 1635639,
“card_no”: “01000”,
“user_name”: “周明红”,
“review_hotel_id”: “cnbjbjbfjy”,
“check_in_date”: “2008-09-12”,
“check_out_date”: “2008-09-12”,
“locale”: “zh_CN”,
“content”: “很不错，卫生9”,
“score”: 10,
“average_rate”: 3.5,
“created_at”: "2012-02-05 20:19:26"
},
{
“id”: 7,
“card_id”: 1635639,
“card_no”: “01000”,
“user_name”: “周明红”,
“review_hotel_id”: “cnbjbjbfjy”,
“check_in_date”: “2008-09-12”,
“check_out_date”: “2008-09-12”,
“locale”: “zh_CN”,
“content”: “很不错，卫生8”,
“score”: 10,
“average_rate”: 3.5,
“created_at”: "2012-02-05 20:19:26"
},
{
“id”: 8,
“card_id”: 1635639,
“card_no”: “01000”,
“user_name”: “周明红”,
“review_hotel_id”: “cnbjbjbfjy”,
“check_in_date”: “2008-09-12”,
“check_out_date”: “2008-09-12”,
“locale”: “zh_CN”,
“content”: “很不错，卫生7”,
“score”: 10,
“average_rate”: 3.5,
“created_at”: "2012-02-05 20:19:26"
},
{
“id”: 9,
“card_id”: 1635639,
“card_no”: “01000”,
“user_name”: “周明红”,
“review_hotel_id”: “cnbjbjbfjy”,
“check_in_date”: “2008-09-12”,
“check_out_date”: “2008-09-12”,
“locale”: “zh_CN”,
“content”: “很不错，卫生6”,
“score”: 10,
“average_rate”: 3.5,
“created_at”: "2012-02-05 20:19:26"
},
{
“id”: 10,
“card_id”: 1635639,
“card_no”: “01000”,
“user_name”: “周明红”,
“review_hotel_id”: “cnbjbjbfjy”,
“check_in_date”: “2008-09-12”,
“check_out_date”: “2008-09-12”,
“locale”: “zh_CN”,
“content”: “很不错，卫生5”,
“score”: 10,
“average_rate”: 3.5,
“created_at”: "2012-02-05 20:19:26"
}
],
“total_entries”: 16
}
6.6获取某批酒店点评列表get_multi_hotel_review_stats
请求参数
hotel_ids 酒店编号（必填，逗号分隔）
返回结果对象
stats: 点评统计
hotel_id: 点评酒店ID
review_type_id: 点评项类型ID
review_count: 点评数
average_rate: 点评平均分
成功返回结果范例
{
“stats”: [
{
“hotel_id”: “cnbjbjbfjy”,
“review_type_id”: 1,
“review_count”: 6,
“average_rate”: 2
},
{
“hotel_id”: “cnbjbjbfjy”,
“review_type_id”: 2,
“review_count”: 6,
“average_rate”: 3
},
{
“hotel_id”: “cnbjbjbfjy”,
“review_type_id”: 3,
“review_count”: 6,
“average_rate”: 3
},
{
“hotel_id”: “cnbjbjbfjy”,
“review_type_id”: 4,
“review_count”: 6,
“average_rate”: 4
},
{
“hotel_id”: “cnbjbjbfjy”,
“review_type_id”: 5,
“review_count”: 6,
“average_rate”: 3
},
{
“hotel_id”: “cnbjbjbfjy”,
“review_type_id”: 6,
“review_count”: 6,
“average_rate”: 3
},
{
“hotel_id”: “cnbjbjs8sy”,
“review_type_id”: 1,
“review_count”: 3,
“average_rate”: 5
},
{
“hotel_id”: “cnbjbjs8sy”,
“review_type_id”: 2,
“review_count”: 3,
“average_rate”: 4
},
{
“hotel_id”: “cnbjbjs8sy”,
“review_type_id”: 3,
“review_count”: 3,
“average_rate”: 3
},
{
“hotel_id”: “cnbjbjs8sy”,
“review_type_id”: 4,
“review_count”: 3,
“average_rate”: 5
}
]
}
6.7搜索点评列表search_reviews
请求参数
condition.hotel_id 酒店编号
condition.hotelgroup_id 集团编号
condition.hotel_ids 逗号分隔的酒店ID
condition.exclude_empty 排除点评内容为空的点评（默认true）
condition.page 当前页 （允许空）
condition.page_size 页大小（允许空，空表示不分页）
返回结果对象
同接口6.5
成功返回结果范例
同接口6.5
第七部分 协议详情（信息相关）
7.1获取酒店图片列表list_hotel_photos
请求参数
hotel_id 酒店编号(必填)
返回结果对象
photos : 图片信息数组
图片信息对象字段
id: 图片编号
hotel_id: 酒店ID
album_id: 相册ID
room_type_id: 房型ID
name: 图片名称
path: 图片路径
priority: 图片显示优先级(越大越优先)
成功返回结果范例
{
“photos”: [
{
“id”: 3,
“hotel_id”: “cnbjbjbfjy”,
“room_type_id”: 1481005,
“path”: “cnbjbjbfjy/P120131103824413905S.jpg”,
“name”: “banner-012”,
“priority”: 100
},
{
“id”: 5,
“hotel_id”: “cnbjbjbfjy”,
“room_type_id”: 1480999,
“path”: “cnbjbjbfjy/P120131103913679276S.jpg”,
“name”: “banner-0134”,
“priority”: 0
},
{
“id”: 9,
“hotel_id”: “cnbjbjbfjy”,
“album_id”: 1,
“room_type_id”: 10100,
“path”: “cnbjbjbfjy/P120205142432747108S.jpg”,
“name”: “大堂”,
“priority”: 0
},
{
“id”: 29,
“hotel_id”: “cnbjbjbfjy”,
“path”: “cnbjbjbfjy/P120227234730296023S.JPG”,
“name”: “bb”,
“priority”: 0
},
{
“id”: 67,
“hotel_id”: “cnbjbjbfjy”,
“room_type_id”: 3,
“path”: “cnbjbjbfjy/1211786403239.gif”,
“name”: “五层商务会议室-采缘”,
“priority”: 0
}
]
}
7.2获取房型图片列表list_room_type_photos
请求参数
room_type_id 房型编号(必填)
返回结果对象
photos : 图片信息数组
图片信息对象字段
id: 图片编号
hotel_id: 酒店ID
album_id: 相册ID
room_type_id: 房型ID
name: 图片名称
path: 图片路径
priority: 图片显示优先级(越大越优先)
成功返回结果范例
{
“photos”: [
{
“id”: 5,
“hotel_id”: “cnbjbjbfjy”,
“room_type_id”: 1480999,
“path”: “cnbjbjbfjy/P120131103913679276S.jpg”,
“name”: “banner-0134”,
“priority”: 0
}
]
}
7.3获取酒店相册列表list_hotel_albums
请求参数
hotel_id 酒店编号
返回结果对象
albums : 相册信息数组
相册信息对象字段
id: 相册编号
name: 相册名称
priority: 相册显示优先级(越大越优先)
cover_photo_id: 相册封面图片ID（该相册下优先级最大的图片，可以为空）
成功返回结果范例
{
“albums”: [
{
“id”: 1,
“hotel_id”: “cnbjbjbfjy”,
“name”: “前台图片”,
“priority”: 100,
“cover_photo_id”: 9
},
{
id,
“hotel_id”: “cnbjbjbfjy”,
“name”: “客房相册”,
“priority”: 99
}
]
}
7.4获取相册图片列表list_album_photos
请求参数
album_id 相册编号(必填)
返回结果对象
photos : 图片信息数组
图片信息对象字段
id: 图片编号
hotel_id: 酒店ID
album_id: 相册ID
room_type_id: 房型ID
name: 图片名称
path: 图片路径
priority: 图片显示优先级(越大越优先)
成功返回结果范例
{
“photos”: [
{
“id”: 9,
“hotel_id”: “cnbjbjbfjy”,
“album_id”: 1,
“room_type_id”: 10100,
“path”: “cnbjbjbfjy/P120205142432747108S.jpg”,
“name”: “大堂”,
“priority”: 0
},
{
“id”: 10,
“hotel_id”: “cnbjbjbfjy”,
“album_id”: 1,
“path”: “cnbjbjbfjy/P120205142441547108S.jpg”,
“name”: “大堂2”,
“priority”: 0
}
]
7.5获取新闻列表list_news
请求参数
news_type_name 类型名称（选填，不填列出全部类型）
only_mobile 是否返回手机新闻
no_content 是否忽略新闻正文（为提高效率，一般建议true）
page 当前页 （允许空，从1开始）
page_size 页大小（允许空，空表示不分页）
返回结果对象
news_list : 新闻信息数组
新闻信息对象字段
id:新闻编号
hotel_id: 酒店编号
hotelgroup_id: 集团编号
title: 新闻标题
content: 新闻内容
locale: 新闻显示语言
news_type_name: 新闻类型名称
expire_date: 过期日期
show_date: 开始显示日期
priority: 优先级（越大越优先）
publisher: 发布人
created_at: 创建时间
total_entries: 总条数
成功返回结果范例
{
“news_list”: [
{
“id”: 1,
“hotel_id”: “cnbjbjbfjy”,
“title”: “春节促销2”,
“content”: “<img src=\”/wi/1/N120311205725564.jpg\“ alt=\”\“ /><img src=\”/wi/1/N120225140926444.jpg\“ alt=\”\“ /><img src=\”/wi/1/P120224170503088629S.gif\“ />”,
“locale”: “zh_CN”,
“expire_date”: “2013-02-25”,
“show_date”: “2012-02-24”,
“priority”: 0,
“publisher”: “test”,
“created_at”: "2012-03-11 20:57:48"
}
],
“total_entries”: 1
}
7.6获取新闻详情get_news_detail
请求参数
news_id 新闻ID（必填）
错误代码
error.news.not_exist 留言不存在
返回结果对象
news_detail: 新闻信息详情
新闻信息对象字段
id:新闻编号
hotel_id: 酒店编号
hotelgroup_id: 集团编号
title: 新闻标题
content: 新闻内容
locale: 新闻显示语言
news_type_name: 新闻类型名称
expire_date: 过期日期
show_date: 开始显示日期
priority: 优先级（越大越优先）
publisher: 发布人
logo: 新闻图片
created_at: 创建时间
成功返回结果范例
{
“id”: 1,
“hotel_id”: “cnbjbjbfjy”,
“title”: “春节促销2”,
“content”: “<img src=\”/wi/1/N120311205725564.jpg\“ alt=\”\“ /><img src=\”/wi/1/N120225140926444.jpg\“ alt=\”\“ /><img src=\”/wi/1/P120224170503088629S.gif\“ />”,
“locale”: “zh_CN”,
“expire_date”: “2013-02-25”,
“show_date”: “2012-02-24”,
“priority”: 0,
“publisher”: “test”,
“created_at”: "2012-03-11 20:57:48"
}
7.7获取留言列表search_questions
只能获取is_private=false的留言，如果是is_private=true的，用户只能通过留下的联系方式获得回答
请求参数
condition.page 当前页 （允许空）
condition.page_size 页大小（允许空，空表示不分页）
返回结果对象
questions : 留言信息数组
留言信息对象字段
id: 留言编号
hotel_id: 酒店编号
hotelgroup_id: 集团编号
asker_name: 留言人
asker_mobile: 手机
asker_email: 邮箱
content: 内容
reply: 回复内容
reply_user_id: 回复人id
ip: 优先级（越大越优先）
created_at: 留言时间
reply_at: 回复时间
total_entries: 总条数
成功返回结果范例
{
“questions”: [
{
“id”: 11,
“hotel_id”: “cnbjbjxj01”,
“asker_name”: “过路人”,
“asker_mobile”: “13621078862”,
“asker_email”: “[email protected]”,
“content”: “我是一名来自山西的客人几年来只要来北京我就选择入住该宾馆。理由有五点：1、交通方便，距离北京站、机场、天安门等乘车很方便。2、服务周到、热情，该宾馆服员笑得都很甜，如果你初次来肯定会感受到扑面而来的微笑和周到的服务水准。3、环境优美。客房经过装修后，给人一种典雅、舒适的感受。4、价格合理。香江宾馆是一家二星级宾馆，房价200-300元不等，如入住你就能感受到很值。5、舒适、安全。当你在办理手续时，只要抬头就会看到各种安全奖牌，估计不是假的。”,
“ip”: “124.254.12.50”,
“created_at”: "2008-07-24 10:47:05"
},
{
“id”: 33,
“hotel_id”: “cnbjbjxj01”,
“asker_name”: “haoruifei”,
“asker_mobile”: “13811811574”,
“asker_email”: “[email protected]”,
“content”: “酒店服务质量很好，干净整洁的客房让人住着很舒服。”,
“ip”: “219.238.168.2”,
“created_at”: "2008-07-25 12:41:13"
},
{
“id”: 55
“hotel_id”: “cnbjbjxj01”,
“asker_name”: “李燕”,
“asker_email”: “[email protected]”,
“content”: “网站简洁，预订也方便！”,
“reply”: “欢迎经常来网站看看！”,
“ip”: “222.212.87.245”,
“created_at”: “2008-07-29 16:57:38”,
“reply_at”: "2008-07-30 16:02:23"
}
],
“total_entries”: 3
}
7.8添加用户留言add_question
请求参数
question.asker_name 留言人姓名(必填)
question.asker_mobile 联系Mobile
question.asker_email 联系Email
question.content 问题正文(必填)
question.ip 留言人ip(必填)
question.is_private 此问题是否需要不公开
返回结果对象
{}
7.9 网站管理员回复用户留言reply_question
请求参数
question_id 留言编号
reply_content 回复内容
reply_user_id 回复人帐号
返回结果对象
{}
7.10 网站管理员回复会员点评reply_review
请求参数
review_id 留言编号
reply_content 回复内容
reply_user_id 回复人帐号
返回结果对象
{}
第八部分 协议详情（电子劵相关）
7.1销售电子优惠券sell_voucher
请求参数
voucher.voucher_type_id 电子优惠券类型ID（必填）
voucher.voucher_no 电子优惠券号（必填）
voucher.card_type_id 会员卡类型ID（选填）
voucher.card_no 会员卡号（选填）
错误代码
error.voucher.exist_voucher_no 电子券号已经被使用
error.voucher.voucher_type_disabled 电子券类型已经被禁用
error.voucher.voucher_type_expired 电子券类型已经过期
error.voucher.voucher_type_not_effective 电子券类型还未生效
error.voucher.wrong_voucher_no 非法电子券号，电子券号必须输入且需要符合电子券类型约束
error.voucher.wrong_voucher_type_id 非法电子券类型
返回结果对象
voucher : 电子优惠券信息
voucher_type_name 电子劵名称
voucher_type_id 电子劵类型ID
voucher_no 劵号
sell_time 获得时间（YYYY-MM-DD HH:MM:SS）
effective_date 有效日开始（YYYY-MM-DD）
expire_date 过期日（YYYY-MM-DD）
left_times 剩余使用次数
card_no 会员卡号
card_type_id 会员卡类型ID
成功返回结果范例
{
“voucher”: {
“voucher_type_name”: “抵用劵”,
“voucher_type_id”: “091015143902203647L”,
“voucher_no”: “10088”,
“sell_time”: “2013-07-23”,
“effective_date”: “2013-07-23”,
“expire_date”: “2013-08-02”,
“left_times”: 2,
“card_no”: “12345”,
“card_type_id”: "100132"
}
}