POST api/Order/AddOrder
对景区类供应商发起预订的接口(包括分时段和不分时段的模式)。 为向下兼容,同功能的WebForms接口访问地址为~/Source/OrderProducts.aspx
Request Information
URI Parameters
None.
Body Parameters
预订参数。接口方可以在orderparm.senderid中指定接口方系统中的唯一订单号,电子门票系统会判断该业务单据是否被提交过,如果提交过,此过程会返回单据的最新状态(注意,系统仅会检查parm.orderinfo.senderid是否已在系统中存在,而不会比对新传入的参数的其他内容与系统中已持有的单据是否相同)。
OrderAddParm| Name | Description | Type | Additional information |
|---|---|---|---|
| orderdetails |
订单明细信息,指明定购产品及数量,此少需要包含一个明细。 |
Collection of OrderAddItemParm |
Required |
| mobile |
手机号码,如果系统有依据订单的通知(如退款完成,订单取票等),将发送到这个手机上。 如果订单整没有提供证件号,所有门票都是前台取票的,取票凭证会发送到这个手机上。 |
string |
Required Max length: 11 |
| otheruserid |
其他用户ID号,指用户在第三方系统的用户账号,主要用于官方网站和官方微信的对接,第三方OTA不能使用。 |
integer |
None. |
| identificationnumber |
身份证号,如果订单内的门票均是非实名的且需要取票的,客人可以使用这个证件号到前台或自助机上取票 |
string |
Max length: 20 |
| effectdate |
生效日期,格式:yyyyMMdd。 |
string |
Required Max length: 8 |
| needinvoice |
是否需要发票,“1”表示需要,“0”表示不需要。 |
string |
Max length: 1 |
| invoicetitle |
发票上打印的购货人单位名称 |
string |
Max length: 100 |
| invoicecode |
购货人统一社会信用代码,当需要发票为“1”,但此项为空时,则发票将开“个人”。 |
string |
Max length: 30 |
| senderid |
被接口方的业务单据ID,示例:同程网接口调用,此值表示同程网业务系统内对应的订单的单据号,此值在接口方系统内应为唯一值。不提供此参数时,系统将不会执行回调通知。提供这个参数还可以防止订单的重复提交。 |
string |
Max length: 50 |
| servicecode |
服务项目ID(线路ID),此值仅在分时段景区中必须。 |
string |
Max length: 2 |
| timespanindex |
时段序号,当门票系统处于分时段售检票模式时,此值必须;否则此值没有意义。指定时段:取值1,2,3,4,5之类的自然数,此时该时段必须是门票系统中存在的、可用的、有足够余额的,否则会占用失败;-1表示自动时段号,系统会自动检索有足够余量的时段,且时间最前的优先,来占用时段,若当天已无时段可用或没有足够的余额容纳本次占用时,预定会失败。 |
integer |
None. |
| tripbillcode |
行程单编号,在文档编写之时,此值只能对应张家界的全域通和一诚通行程单。 |
string |
None. |
| guidernumber |
导游证号 |
string |
None. |
| marketareaid |
市场区划的代码 |
string |
None. |
| reserve1 |
预留一字段(对应T_SP_YD表中的BL2字段 varchar(200)) 原保留2字段用于存储预订明细表中该订单的总人数 2019-11-09 by TangYu 应卧龙要求进行修改 |
string |
None. |
| reserve2 |
预留二字段(对应T_SP_YD表中的BZ字段 text) 原备注字段用于存储预订明细表中该订单的实名信息 2019-11-09 by TangYu 应卧龙要求进行修改 |
string |
None. |
Request Formats
application/json, text/json
{
"orderdetails": [
{
"productid": "sample string 1",
"amount": 2,
"identificationnumber": "sample string 3",
"fullname": "sample string 4",
"identificationtype": "sample string 5",
"mobile": "sample string 6",
"gateinmode": "sample string 7",
"seatitems": [
{
"seatid": "sample string 1"
},
{
"seatid": "sample string 1"
}
]
},
{
"productid": "sample string 1",
"amount": 2,
"identificationnumber": "sample string 3",
"fullname": "sample string 4",
"identificationtype": "sample string 5",
"mobile": "sample string 6",
"gateinmode": "sample string 7",
"seatitems": [
{
"seatid": "sample string 1"
},
{
"seatid": "sample string 1"
}
]
}
],
"mobile": "sample string 1",
"otheruserid": 2,
"identificationnumber": "sample string 3",
"effectdate": "sample string 4",
"needinvoice": "sample string 5",
"invoicetitle": "sample string 6",
"invoicecode": "sample string 7",
"senderid": "sample string 8",
"servicecode": "sample string 9",
"timespanindex": 10,
"tripbillcode": "sample string 11",
"guidernumber": "sample string 12",
"marketareaid": "sample string 13",
"reserve1": "sample string 14",
"reserve2": "sample string 15"
}
application/xml, text/xml
<OrderAddParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DigitalScience.DataTransfer.Tour.V5.Parm.WebInterface">
<effectdate>sample string 4</effectdate>
<guidernumber>sample string 12</guidernumber>
<identificationnumber>sample string 3</identificationnumber>
<invoicecode>sample string 7</invoicecode>
<invoicetitle>sample string 6</invoicetitle>
<marketareaid>sample string 13</marketareaid>
<mobile>sample string 1</mobile>
<needinvoice>sample string 5</needinvoice>
<orderdetails>
<OrderAddItemParm>
<amount>2</amount>
<fullname>sample string 4</fullname>
<gateinmode>sample string 7</gateinmode>
<identificationnumber>sample string 3</identificationnumber>
<identificationtype>sample string 5</identificationtype>
<mobile>sample string 6</mobile>
<productid>sample string 1</productid>
<seatitems>
<Order2SeatItem>
<seatid>sample string 1</seatid>
</Order2SeatItem>
<Order2SeatItem>
<seatid>sample string 1</seatid>
</Order2SeatItem>
</seatitems>
</OrderAddItemParm>
<OrderAddItemParm>
<amount>2</amount>
<fullname>sample string 4</fullname>
<gateinmode>sample string 7</gateinmode>
<identificationnumber>sample string 3</identificationnumber>
<identificationtype>sample string 5</identificationtype>
<mobile>sample string 6</mobile>
<productid>sample string 1</productid>
<seatitems>
<Order2SeatItem>
<seatid>sample string 1</seatid>
</Order2SeatItem>
<Order2SeatItem>
<seatid>sample string 1</seatid>
</Order2SeatItem>
</seatitems>
</OrderAddItemParm>
</orderdetails>
<otheruserid>2</otheruserid>
<reserve1>sample string 14</reserve1>
<reserve2>sample string 15</reserve2>
<senderid>sample string 8</senderid>
<servicecode>sample string 9</servicecode>
<timespanindex>10</timespanindex>
<tripbillcode>sample string 11</tripbillcode>
</OrderAddParm>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
对景区类供应商发起预订的接口(包括分时段和不分时段的模式)。 为向下兼容,同功能的WebForms接口访问地址为~/Source/OrderProducts.aspx
OrderOperatorResult| Name | 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
{
"orderid": "sample string 1",
"sendid": "sample string 2",
"orderstatus": "sample string 3",
"resultcode": 4,
"returnmessgage": "sample string 5"
}
application/xml, text/xml
<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>