预订宝/getOrderRoomStatus
来自站长百科
getOrderRoomStatus概述[ ]
- 接口地址：http://api.yudingbao.net/v1.0/hotel/order.ashx?act=getOrderRoomStatus
- 动作标识：getOrderRoomStatus
- 参数：见参数说明
- 请求方式GET
- 响应模式：JSON、JSONP、XML
注意：动作标识是大小写敏感的，请养成良好的编码习惯！
参数说明[ ]
| 参数名称 | 参数类型 | 说明 |
|---|---|---|
| sid | string | 应用程序授权编号，在您的app通过审核后由管理员派发给您。 |
| skey | string | 应用程序授权公钥，在您的app通过审核后由管理员派发给您。 |
| hotelCode | string | 酒店编号。 |
| roomCode | string | 房型编号。 |
| roomRatePlan | int | 房价排期编号。 |
| checkInDate | date | 入住日期。 |
| checkOutDate | date | 退房日期。 |
数据格式[ ]
- 响应头：
- Status：0为正常，非0表示处理请求时发生异常，通常是参数校验错误；
- Messages：当Status为非0时该字段肯定包含一条或多条消息文本；
- 响应体：
酒店信息中可能出现以下几个置换符，调用数据时应当做相应处理：
| 替代符标签 | 说明 | |
|---|---|---|
| 1 | {$Website.Domain$} | 应当替换为自己网站的域名。 |
| 2 | {$Website.Name$} | 应当替换为自己的网站名。 |
- 本接口响应体包含两个几点：
- OrderToken：每次调用房态实时查询接口都会生成一个新的订单token，提交订单时需要此参数；
- Hotel：包含最新房态信息的酒店对象节点，其详细格式请参考getHotelInfo和getHotelList。
- 对于数据格式的理解，请参考下列示例代码中的XML响应演示，其中每个字段都标注了数据类型（日期类型在XML响应中统一使用GMT格式，但被标注为string，请开发者注意）。
示例代码[ ]
以下示例代码是通过HTML表单实现了该接口的部分操作，在开发过程中应当使用自己的平台语言来模拟这些操作以捕获响应体，然后对响应体做出相应的操作。
请求示例
<!-- 这是该接口的请求示例，该接口的访问类同于如下表单的提交， 请注意：该表单使用控件的方法模拟了GET请求 --> <form id="myForm" method="get" action="http://api.yudingbao.net/v1.0/hotel/order.ashx"> <p> <!--动作标识，注意动作标识是大小写敏感的--> <input id="act" name="act" value="getOrderRoomStatus" type="text" /> </p> <p> <!--应用程序授权编号及公钥，在您的app通过审核后由管理员派发给您--> <input id="sid" name="sid" value="xxxxx" type="text"> <input id="sKey" name="sKey" value="xxxxx" type="text"> <!--酒店编号--> <input id="HotelCode" name="HotelCode" value="h010t40101203" type="text"> <!--房间编号--> <input id="RoomCode" name="RoomCode" value="1017" type="text"> <!--房价排期编号--> <input id="RoomRatePlan" name="RoomRatePlan" value="46220" type="text"> <!--入住日期--> <input id="CheckInDate" name="CheckInDate" value="2011-05-18" type="text"> <!--退房日期--> <input id="CheckOutDate" name="CheckOutDate" value="2011-05-21" type="text"> </p> <p> <!--指定响应格式为XML，这里以XML为例--> <input id="format" name="format" value="xml" type="text" /> <!--指定响应体应当是已格式化的，便于阅读代码，在生产环境中应当将该值设置为false--> <input id="indent" name="indent" value="true" type="text" /> <!--产品编号。在我的账户-分销产品的应用列表中可以找到该参数的值。--> <input id="aid" name="aid" value="78663" type="text" /> <!--接口密钥。在我的账户-分销产品的应用列表中可以找到该参数的值。--> <input id="key" name="key" value="0925ed633d24577eb3ffe13f00c55a4f9739f51a77eefb1dba29bb9568acddfd" type="text" /> <!--应用程序授权编号及公钥，这是可选的--> <input id="sid" name="sid" value="" type="text"> <input id="sKey" name="sKey" value="" type="text"> </p> <p> <input id="submit" name="submit" value="提交" type="submit"> </p> </form>
XML响应
<!--XML响应--> <?xml version="1.0" encoding="utf-8"?> <HttpResponse> <Status type="number">0</Status> <Messages type="array"> </Messages> <ResponseBody type="object"> <OrderToken type="string">gu0cl7j4ip3kbllw</OrderToken> <Hotel type="object"> <_id type="string">h010t40101203</_id> <Rooms type="array"> <item type="object"> <TypeId type="string">1017</TypeId> <Name type="string">标准间（大床）</Name> <Broadband type="number">2</Broadband> <TypeNumber type="number">0</TypeNumber> <Area type="number">26</Area> <Floor type="string">2-6</Floor> <BedDescription type="string">大床,收费上网,宽带,普通楼层,其他,</BedDescription> <Note type="string"> </Note> <RatePlans type="array"> <item type="object"> <_id type="number">46220</_id> <Name type="string">含单早</Name> <Rates type="array"> <item type="object"> <Date type="string">Sat, 17 May 0042 16:00:00 GMT</Date> <RetailRate type="number">920.0</RetailRate> <MemberRate type="number">498.0</MemberRate> <AddBedRate type="number">0.0</AddBedRate> <CanBook type="boolean">true</CanBook> </item> <item type="object"> <Date type="string">Sun, 18 May 0042 16:00:00 GMT</Date> <RetailRate type="number">920.0</RetailRate> <MemberRate type="number">498.0</MemberRate> <AddBedRate type="number">0.0</AddBedRate> <CanBook type="boolean">true</CanBook> </item> <item type="object"> <Date type="string">Mon, 19 May 0042 16:00:00 GMT</Date> <RetailRate type="number">920.0</RetailRate> <MemberRate type="number">498.0</MemberRate> <AddBedRate type="number">0.0</AddBedRate> <CanBook type="boolean">true</CanBook> </item> </Rates> <TotalPrice type="number">1494.0</TotalPrice> <LowestPrice type="number">498.0</LowestPrice> <HighestPrice type="number">498.0</HighestPrice> <AveragePrice type="number">498.0</AveragePrice> <NonBookingPercentage type="number">0.0</NonBookingPercentage> <IsGuaranteeable type="boolean">false</IsGuaranteeable> <GaranteeRules type="array"> </GaranteeRules> <Code type="string"> </Code> </item> </RatePlans> </item> </Rooms> <Distance type="number">0.0</Distance> <Status type="number">2</Status> <Landmarks type="object"> <a:item xmlns:a="item" item="0080" type="string">琉璃厂古文化街</a:item> <a:item xmlns:a="item" item="0154" type="string">菜市口百货商场</a:item> </Landmarks> <CCAccepted type="string">Visacard,牡丹卡,金穗卡,长城卡,龙卡,太平洋卡,东方卡,万事达卡,运通卡,大莱卡,JCBcard</CCAccepted> <AvailPolicy type="string"> </AvailPolicy> <AirportPickUpService type="string"> </AirportPickUpService> <Thumbnail type="string">http://static.yudingbao.net/images/hotel/a/11/40101203_1_5_0_1.jpg</Thumbnail> <Description type="string">酒店开业时间1956年7月，新近装修时间2002年3月，楼高8层，客房总数410间（套）。</Description> <IntroEditor type="string">北京前门建国饭店是北京著名的八大饭店之一。 饭店建筑形式独特，2007年被北京市列为《北京优秀近现代建筑保护名录》中。 入住饭店宾客将感受到中国悠久文化与欧式建筑完美结合的多元之旅。 饭店地处天安门南侧，周边旅游资源丰富，去往气势恢宏的天安门以及国家艺术圣殿——国家大剧院十分便利。 当宾客度过繁忙的一天回到酒店，更能体会宾至如归——家的温暖。 饭店拥有各种尊贵客房，房间设计同时关注休憩与工作，使宾客倍感房间的舒适。 专业的会议支援团队深谙会议需求，全力助宾客成功筹办每一个会议。各具风格的餐厅、酒吧汇集东西方美食文化的精粹。 能容纳千人，驰名海外的梨园剧场每晚由北京京剧院的艺术家们联袂献艺，为宾客演出精彩绝伦的国粹——京剧。 酒店开业时间1956年7月，新近装修时间2002年3月，楼高8层，客房总数410间（套）。</IntroEditor> <BusinessZoneId type="string">010139</BusinessZoneId> <DistrictId type="string">0004</DistrictId> <CityId type="string">0101</CityId> <ProvinceId type="string">0100</ProvinceId> <RegionId type="string"> </RegionId> <Country type="string">中国</Country> <Lat type="number">39.88644733</Lat> <Lng type="number">116.385974</Lng> <Rating type="number">0</Rating> <Typology type="number">72</Typology> <Category type="number">4</Category> <Address type="string">北京市宣武区永安路175号</Address> <Name type="string">北京前门建国饭店</Name> <TotalPrice type="number">1494.0</TotalPrice> <LowestPrice type="number">498.0</LowestPrice> <HighestPrice type="number">498.0</HighestPrice> <AveragePrice type="number">498.0</AveragePrice> <NonBookingPercentage type="number">0.0</NonBookingPercentage> </Hotel> </ResponseBody> </HttpResponse>
JSON响应
// Json响应
{
"Status" : 0,
"Messages" : [],
"ResponseBody" : {
"OrderToken" : "1h0ppzydqgdhehl3",
"Hotel" : {
"_id" : "h010t40101203",
"Rooms" : [{
"TypeId" : "1017",
"Name" : "标准间（大床）",
"Broadband" : 2,
"TypeNumber" : 0,
"Area" : 26,
"Floor" : "2-6",
"BedDescription" : "大床,收费上网,宽带,普通楼层,其他,",
"Note" : "",
"RatePlans" : [{
"_id" : 46220,
"Name" : "含单早",
"Rates" : [{
"Date" : Date(1305648000000),
"RetailRate" : 920.0,
"MemberRate" : 498.0,
"AddBedRate" : 0.0,
"CanBook" : true
}, {
"Date" : Date(1305734400000),
"RetailRate" : 920.0,
"MemberRate" : 498.0,
"AddBedRate" : 0.0,
"CanBook" : true
}, {
"Date" : Date(1305820800000),
"RetailRate" : 920.0,
"MemberRate" : 498.0,
"AddBedRate" : 0.0,
"CanBook" : true
}],
"TotalPrice" : 1494.0,
"LowestPrice" : 498.0,
"HighestPrice" : 498.0,
"AveragePrice" : 498.0,
"NonBookingPercentage" : 0.0,
"IsGuaranteeable" : false,
"GaranteeRules" : [],
"Code" : ""
}]
}],
"Distance" : 0.0,
"Status" : 2,
"Landmarks" : {
"0080" : "琉璃厂古文化街",
"0154" : "菜市口百货商场"
},
"CCAccepted" : "Visacard,牡丹卡,金穗卡,长城卡,龙卡,太平洋卡,东方卡,万事达卡,运通卡,大莱卡,JCBcard",
"AvailPolicy" : "",
"AirportPickUpService" : "",
"Thumbnail" : "http://static.yudingbao.net/images/hotel/a/11/40101203_1_5_0_1.jpg",
"Description" : "酒店开业时间1956年7月，新近装修时间2002年3月，楼高8层，客房总数410间（套）。",
"IntroEditor" : "北京前门建国饭店是北京著名的八大饭店之一。
饭店建筑形式独特，2007年被北京市列为《北京优秀近现代建筑保护名录》中。入住饭店宾客将感受到中国悠久文化与欧式建筑完美结合的多元之旅。
饭店地处天安门南侧，周边旅游资源丰富，去往气势恢宏的天安门以及国家艺术圣殿——国家大剧院十分便利。
当宾客度过繁忙的一天回到酒店，更能体会宾至如归——家的温暖。\n 饭店拥有各种尊贵客房，房间设计同时关注休憩与工作，使宾客倍感房间的舒适。
专业的会议支援团队深谙会议需求，全力助宾客成功筹办每一个会议。
各具风格的餐厅、酒吧汇集东西方美食文化的精粹。
能容纳千人，驰名海外的梨园剧场每晚由北京京剧院的艺术家们联袂献艺，为宾客演出精彩绝伦的国粹——京剧。\n
酒店开业时间1956年7月，新近装修时间2002年3月，楼高8层，客房总数410间（套）。",
"BusinessZoneId" : "010139",
"DistrictId" : "0004",
"CityId" : "0101",
"ProvinceId" : "0100",
"RegionId" : "",
"Country" : "中国",
"Lat" : 39.88644733,
"Lng" : 116.385974,
"Rating" : 0,
"Typology" : 72,
"Category" : 4,
"Address" : "北京市宣武区永安路175号",
"Name" : "北京前门建国饭店",
"TotalPrice" : 1494.0,
"LowestPrice" : 498.0,
"HighestPrice" : 498.0,
"AveragePrice" : 498.0,
"NonBookingPercentage" : 0.0
}
}
}
JSONP响应
// JsonP响应
jsoncallback({
"Status" : 0,
"Messages" : [],
"ResponseBody" : {
"OrderToken" : "1h0ppzydqgdhehl3",
"Hotel" : {
"_id" : "h010t40101203",
"Rooms" : [{
"TypeId" : "1017",
"Name" : "标准间（大床）",
"Broadband" : 2,
"TypeNumber" : 0,
"Area" : 26,
"Floor" : "2-6",
"BedDescription" : "大床,收费上网,宽带,普通楼层,其他,",
"Note" : "",
"RatePlans" : [{
"_id" : 46220,
"Name" : "含单早",
"Rates" : [{
"Date" : Date(1305648000000),
"RetailRate" : 920.0,
"MemberRate" : 498.0,
"AddBedRate" : 0.0,
"CanBook" : true
}, {
"Date" : Date(1305734400000),
"RetailRate" : 920.0,
"MemberRate" : 498.0,
"AddBedRate" : 0.0,
"CanBook" : true
}, {
"Date" : Date(1305820800000),
"RetailRate" : 920.0,
"MemberRate" : 498.0,
"AddBedRate" : 0.0,
"CanBook" : true
}],
"TotalPrice" : 1494.0,
"LowestPrice" : 498.0,
"HighestPrice" : 498.0,
"AveragePrice" : 498.0,
"NonBookingPercentage" : 0.0,
"IsGuaranteeable" : false,
"GaranteeRules" : [],
"Code" : ""
}]
}],
"Distance" : 0.0,
"Status" : 2,
"Landmarks" : {
"0080" : "琉璃厂古文化街",
"0154" : "菜市口百货商场"
},
"CCAccepted" : "Visacard,牡丹卡,金穗卡,长城卡,龙卡,太平洋卡,东方卡,万事达卡,运通卡,大莱卡,JCBcard",
"AvailPolicy" : "",
"AirportPickUpService" : "",
"Thumbnail" : "http://static.yudingbao.net/images/hotel/a/11/40101203_1_5_0_1.jpg",
"Description" : "酒店开业时间1956年7月，新近装修时间2002年3月，楼高8层，客房总数410间（套）。",
"IntroEditor" : "北京前门建国饭店是北京著名的八大饭店之一。饭店建筑形式独特，2007年被北京市列为《北京优秀近现代建筑保护名录》中。
入住饭店宾客将感受到中国悠久文化与欧式建筑完美结合的多元之旅。
饭店地处天安门南侧，周边旅游资源丰富，去往气势恢宏的天安门以及国家艺术圣殿——国家大剧院十分便利。
当宾客度过繁忙的一天回到酒店，更能体会宾至如归——家的温暖。\n
饭店拥有各种尊贵客房，房间设计同时关注休憩与工作，使宾客倍感房间的舒适。
专业的会议支援团队深谙会议需求，全力助宾客成功筹办每一个会议。各具风格的餐厅、酒吧汇集东西方美食文化的精粹。
能容纳千人，驰名海外的梨园剧场每晚由北京京剧院的艺术家们联袂献艺，为宾客演出精彩绝伦的国粹——京剧。\n
酒店开业时间1956年7月，新近装修时间2002年3月，楼高8层，客房总数410间（套）。",
"BusinessZoneId" : "010139",
"DistrictId" : "0004",
"CityId" : "0101",
"ProvinceId" : "0100",
"RegionId" : "",
"Country" : "中国",
"Lat" : 39.88644733,
"Lng" : 116.385974,
"Rating" : 0,
"Typology" : 72,
"Category" : 4,
"Address" : "北京市宣武区永安路175号",
"Name" : "北京前门建国饭店",
"TotalPrice" : 1494.0,
"LowestPrice" : 498.0,
"HighestPrice" : 498.0,
"AveragePrice" : 498.0,
"NonBookingPercentage" : 0.0
}
}
});