POST api/WebInterface/Order/Cancel
取消预订单(发起预订后,以任何形式完成支付前,订单处于预订中状态,可以使用此接口撤消订单)。
Request Information
URI Parameters
None.
Body Parameters
取消预订的参数。
OrderCancelParmName | Description | Type | Additional information |
---|---|---|---|
username |
发起预订的用户的用户名,通常是指客户单位的web用户名。 |
string |
Required Max length: 20 |
memberid |
如果是官方小程序来的请求,使用这个值传入个人会员Id。 |
integer |
None. |
guidernum |
如果是导游小程序来的请求,使用这个参数传入导游证号。 |
string |
Max length: 20 |
orderid |
订单ID号。 |
string |
Required Max length: 20 |
Request Formats
application/json, text/json
Sample:
{ "username": "sample string 1", "memberid": 2, "guidernum": "sample string 3", "orderid": "sample string 4" }
application/xml, text/xml
Sample:
<OrderCancelParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DigitalScience.DataTransfer.Tour.V5.Parm"> <guidernum>sample string 3</guidernum> <memberid>2</memberid> <orderid>sample string 4</orderid> <username>sample string 1</username> </OrderCancelParm>
application/x-www-form-urlencoded
Sample:
Sample not available.
application/bson
Sample:
Binary JSON content. See http://bsonspec.org for details.
Response Information
Resource Description
取消预订单(发起预订后,以任何形式完成支付前,订单处于预订中状态,可以使用此接口撤消订单)。
OrderOperatorResultName | Description | Type | Additional information |
---|---|---|---|
orderid |
操作对应(或产生)的电子门票系统订单号。 |
string |
None. |
sendid |
操作对应的第三方系统的订单号(如同程网发送过来的订单的编号),此编号由接口方提供,在提口方系统中应为唯一值。 |
string |
None. |
orderstatus |
订单当前所处的状态 |
string |
None. |
resultcode |
操作返回代码,0表示成功,其他值表示错误。 |
integer |
None. |
returnmessgage |
从接口返回的提示消息,用于告知成功的结果或出错的原因。 |
string |
None. |
Response Formats
application/json, text/json
Sample:
{ "orderid": "sample string 1", "sendid": "sample string 2", "orderstatus": "sample string 3", "resultcode": 4, "returnmessgage": "sample string 5" }
application/xml, text/xml
Sample:
<OrderOperatorResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DigitalScience.DataTransfer.Tour.V5.Result.WebInterface"> <orderid>sample string 1</orderid> <orderstatus>sample string 3</orderstatus> <resultcode>4</resultcode> <returnmessgage>sample string 5</returnmessgage> <sendid>sample string 2</sendid> </OrderOperatorResult>
application/bson
Sample:
Binary JSON content. See http://bsonspec.org for details.