预订宝/getOrderInfo
来自站长百科
getOrderInfo概述[ ]
- 接口地址：http://api.yudingbao.net/v1.0/hotel/order.ashx?act=getOrderInfo
- 动作标识：getOrderInfo
- 参数：见参数说明
- 请求方式：GET
- 响应模式：Json、JsonP、Xml
注意：动作标识是大小写敏感的，请养成良好的编码习惯！
参数说明[ ]
| 参数名称 | 参数类型 | 说明 |
|---|---|---|
| sid | string | 应用程序授权编号，在您的app通过审核后由管理员派发给您。 |
| skey | string | 应用程序授权公钥，在您的app通过审核后由管理员派发给您。 |
| orderId | int | 订单编号。 |
数据格式[ ]
- 响应头：
- Status：0为正常，非0表示处理请求时发生异常，通常是参数校验错误；
- Messages：当Status为非0时该字段肯定包含一条或多条消息文本；
- 响应体：
- 酒店信息中可能出现以下几个置换符，调用数据时应当做相应处理：
| 替代符标签 | 说明 | |
|---|---|---|
| 1 | {$Website.Domain$} | 应当替换为自己网站的域名。 |
| 2 | {$Website.Name$} | 应当替换为自己的网站名。 |
- 本接口响应体内容如下：
| 参数名称 | 参数类型 | 说明 | |
|---|---|---|---|
| 1 | OrderId | int | 订单号。 |
| 2 | Status | int | 订单状态，可能出现的数字及含义如下： |
| 0 —— 未知状态 | |||
| 1 —— 新订单。 | |||
| 2 —— 电话订单。 | |||
| 3 —— 处理中。 | |||
| 4 —— 已确认。 | |||
| 5 —— 客户取消。 | |||
| 6 —— 客服取消。 | |||
| 7 —— 已入住。 | |||
| 8 —— 已离店。 | |||
| 9 —— 审核中。 | |||
| 10 —— NOSHOW。 | |||
| 3 | Settled | bool | 指示当前订单是否已结算。 |
| 4 | SettlementAmount | double | 表示该订单的返佣总额（估算值） |
| 当Settled为true时，该属性为精确值。 | |||
| 5 | UpdateDate | date | 订单更新日期。 |
| 6 | Description | string | 备注。 |
对于数据格式的理解，请参考下列示例代码中的XML响应演示，其中每个字段都标注了数据类型（日期类型在XML响应中统一使用GMT格式，但被标注为string，请开发者注意）。
示例代码[ ]
以下示例代码是通过HTML表单实现了该接口的部分操作，您在开发过程中应当使用自己的平台语言来模拟这些操作以捕获响应体，然后对响应体做出相应的操作。
请求示例
<!-- 这是该接口的请求示例，该接口的访问类同于如下表单的提交， 请注意：该表单使用控件的方法模拟了GET请求 --> <form id="myForm" method="get" action="http://api.yudingbao.net/v1.0/hotel/order.ashx" target="_blank"> <p> <!--动作标识，注意动作标识是大小写敏感的--> <input id="act" name="act" value="getOrderInfo" type="text" /> </p> <p> <!--应用软件授权编号及公钥，在您的app通过审核后由管理员派发给您--> <input id="sid" name="sid" value="sid" type="text"> <input id="sKey" name="sKey" value="sKey" type="text"> <!--订单号--> <input id="orderId" name="orderId" value="100017" 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"> <OrderId type="number">100017</OrderId> <Status type="number">1</Status> <SettlementAmount type="number">0.0</SettlementAmount> <Settled type="boolean">false</Settled> <UpdateDate type="string">Mon, 01 Jan 0001 00:00:00 GMT</UpdateDate> <Description type="string"> </Description> </ResponseBody> </HttpResponse>
JSON响应
// Json响应
{
"Status" : 0,
"Messages" : [],
"ResponseBody" : {
"OrderId" : 100017,
"Status" : 1,
"SettlementAmount" : 0.0,
"Settled" : false,
"UpdateDate" : Date(-62135596800000),
"Description" : ""
}
}
JSONP响应
// JsonP响应
jsoncallback({
"Status" : 0,
"Messages" : [],
"ResponseBody" : {
"OrderId" : 100017,
"Status" : 1,
"SettlementAmount" : 0.0,
"Settled" : false,
"UpdateDate" : Date(-62135596800000),
"Description" : ""
}
});