POST api/Order/YearCard/AddOrder
对互联网年卡发起预订的接口。
Request Information
URI Parameters
None.
Body Parameters
预订参数。接口方可以在orderparm.senderid中指定接口方系统中的唯一订单号,电子门票系统会判断该业务单据是否被提交过,如果提交过,此过程会返回单据的最新状态(注意,系统仅会检查parm.orderinfo.senderid是否已在系统中存在,而不会比对新传入的参数的其他内容与系统中已持有的单据是否相同)。
YearCardOrderAddParm| Name | Description | Type | Additional information |
|---|---|---|---|
| productid |
订购的产品类别的ID(门票类型的ID,该值不能为空) |
string |
Required |
| amount |
订购产品的数量(数量为1 一次一张) |
integer |
Required |
| mobile |
手机号码,下单成功后,依据订单的通知(如退款完成,订单取票等),将发送到这个手机上。 |
string |
Required Max length: 11 |
| otheruserid |
其他用户ID号,指用户在第三方系统的用户账号,主要用于官方网站和官方微信的对接,第三方OTA不能使用。 |
integer |
None. |
| fullname |
订票人姓名 |
string |
Max length: 20 |
| identificationtype |
订票人证件类型,'1'身份证,‘2’ 护照、回乡证、港澳台胞证,‘3’现役车官证、士兵证,‘4’学生证,‘5’老年证,‘6’残疾证,‘9’其他。 |
string |
Max length: 1 |
| 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 |
| remark |
备注(对应T_SP_YD_NK表中的BZ字段 Varchar(50)) |
string |
Max length: 100 |
| reserve1 |
预留一字段(对应T_SP_YD_NK表中的BL1字段 Varchar(50)) |
string |
Max length: 50 |
| reserve2 |
预留二字段(对应T_SP_YD_NK表中的BL2字段 Varchar(50)) |
string |
Max length: 50 |
| guidernum |
导游证号 2024-06-14添加 |
string |
None. |
| BuyInsurance |
是否同时购买保险,1是,0否。 默认为否,当系统强制购买保险时,不论设置什么,此值都是为“1”。 |
string |
Required Max length: 1 |
| InsurancePrice |
保险的单价,当购买保险时此值必填,且必须与提交时刻系统中的当前配置一置,否则提交会失败。 |
decimal number |
None. |
| InsuranceCount |
每张门票的保险份数,一般为1 ,此值应等于门票的支持凭证数,当购买保险时此值必填,且必须与提交时刻系统中的当前配置一置,否则提交会失败。 |
integer |
None. |
| InsurancePlanCode |
保险产品计划代码,客户端可以不输入,在提交时将会被服务器端的设置复盖。 |
string |
Max length: 30 |
| InsurancePlanName |
保险产品计划名称,客户端可以不输入,在提交时将会被服务器端的设置复盖。 |
string |
Max length: 30 |
| InsuranceDestZone |
目的地,客户端可以不输入,在提交时将会被服务器端的设置复盖。 |
string |
Max length: 50 |
| InsuranceTimeRange |
保险天数,客户端可以不输入,在提交时将会被服务器端的设置复盖。 |
integer |
None. |
| InsuranceHolderType |
投保类型,投保类型[1(个人),2(企业)],客户端可以不输入,在提交时将会被服务器端的设置复盖。 |
string |
Max length: 1 |
| InsuranceHolderCompanyName |
投保企业名称,投保类型企业必填,客户端可以不输入,在提交时将会被服务器端的设置复盖。 |
string |
Max length: 60 |
| InsuranceHolderCompanyCode |
投保企业代码(组织机构代码),客户端可以不输入,在提交时将会被服务器端的设置复盖。 |
string |
Max length: 20 |
| InsuranceHolderAddress |
企业联系地址,客户端可以不输入,在提交时将会被服务器端的设置复盖。 |
string |
Max length: 60 |
| InsuranceHolderContactName |
企业联系人,客户端可以不输入,在提交时将会被服务器端的设置复盖。 |
string |
Max length: 40 |
| InsuranceHolderContactPhone |
企业联系人电话,客户端可以不输入,在提交时将会被服务器端的设置复盖。 |
string |
Max length: 20 |
| InsuranceHolderEmail |
企业联系人Email,在提交时将会被服务器端的设置复盖。 |
string |
Max length: 60 |
| XB |
性别,W女性,M男性,购买保险时,此项必填,当您输入的主要证件类型为二代证,主要证件号为二代证号时,此值将被自动分析程序复位,其他的情况必须提供这个参数值。 |
string |
Max length: 1 |
| Birthday |
生日,购买保险时,此项必填。格式YYYYMMDD。当您输入的主要证件类型为二代证,主要证件号为二代证号时,此值将被自动分析程序复位,其他的情况必须提供这个参数值。 |
string |
Max length: 8 |
| AdditonalReduceIdType |
附加优惠证件名。学生证,老年证,残疾证等,这个值不是随便写的汉字,要根据接口定义的字典供游客选取。这个主要用于匹配命中更细节的优惠条件。 |
string |
Max length: 1 |
| AdditonalReduceId |
附加优惠证件号。 |
string |
Max length: 30 |
| InsuranceSex |
用于购买保险的性别的数据,客户端不需要输入,输入是无效的,会在参数较验的过程中,替换为对应保险公司要求的代码。 |
string |
Max length: 1 |
| InsuranceBirthDay |
用于提交到保险的生日的数据,客户端不需要输入,输入是无效的,会在参数较验的过程,替换为对应保险公司要求的格式。 |
string |
Max length: 10 |
| InsuranceCertTypeName |
购买保险时使用的证件类型名,客户端不需要输入,输入是无效的,会在参数较验的过程,替换为对应保险公司要求的格式。 |
string |
Max length: 40 |
| InsuranceCertTypeCode |
购买保险时使用的证件类型代码,客户端不需要输入,输入是无效的,会在参数较验的过程,替换为对应保险公司要求的格式。 |
string |
Max length: 20 |
Request Formats
application/json, text/json
{
"productid": "sample string 1",
"amount": 2,
"mobile": "sample string 3",
"otheruserid": 4,
"fullname": "sample string 5",
"identificationtype": "sample string 6",
"identificationnumber": "sample string 7",
"effectdate": "sample string 8",
"needinvoice": "sample string 9",
"invoicetitle": "sample string 10",
"invoicecode": "sample string 11",
"senderid": "sample string 12",
"remark": "sample string 13",
"reserve1": "sample string 14",
"reserve2": "sample string 15",
"guidernum": "sample string 16",
"BuyInsurance": "sample string 17",
"InsurancePrice": 1.0,
"InsuranceCount": 1,
"InsurancePlanCode": "sample string 18",
"InsurancePlanName": "sample string 19",
"InsuranceDestZone": "sample string 20",
"InsuranceTimeRange": 1,
"InsuranceHolderType": "sample string 21",
"InsuranceHolderCompanyName": "sample string 22",
"InsuranceHolderCompanyCode": "sample string 23",
"InsuranceHolderAddress": "sample string 24",
"InsuranceHolderContactName": "sample string 25",
"InsuranceHolderContactPhone": "sample string 26",
"InsuranceHolderEmail": "sample string 27",
"XB": "sample string 28",
"Birthday": "sample string 29",
"AdditonalReduceIdType": "sample string 30",
"AdditonalReduceId": "sample string 31",
"InsuranceSex": "sample string 32",
"InsuranceBirthDay": "sample string 33",
"InsuranceCertTypeName": "sample string 34",
"InsuranceCertTypeCode": "sample string 35"
}
application/xml, text/xml
<YearCardOrderAddParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DigitalScience.DataTransfer.Tour.V5.Parm.WebInterface"> <AdditonalReduceId>sample string 31</AdditonalReduceId> <AdditonalReduceIdType>sample string 30</AdditonalReduceIdType> <Birthday>sample string 29</Birthday> <BuyInsurance>sample string 17</BuyInsurance> <InsuranceBirthDay>sample string 33</InsuranceBirthDay> <InsuranceCertTypeCode>sample string 35</InsuranceCertTypeCode> <InsuranceCertTypeName>sample string 34</InsuranceCertTypeName> <InsuranceCount>1</InsuranceCount> <InsuranceDestZone>sample string 20</InsuranceDestZone> <InsuranceHolderAddress>sample string 24</InsuranceHolderAddress> <InsuranceHolderCompanyCode>sample string 23</InsuranceHolderCompanyCode> <InsuranceHolderCompanyName>sample string 22</InsuranceHolderCompanyName> <InsuranceHolderContactName>sample string 25</InsuranceHolderContactName> <InsuranceHolderContactPhone>sample string 26</InsuranceHolderContactPhone> <InsuranceHolderEmail>sample string 27</InsuranceHolderEmail> <InsuranceHolderType>sample string 21</InsuranceHolderType> <InsurancePlanCode>sample string 18</InsurancePlanCode> <InsurancePlanName>sample string 19</InsurancePlanName> <InsurancePrice>1</InsurancePrice> <InsuranceSex>sample string 32</InsuranceSex> <InsuranceTimeRange>1</InsuranceTimeRange> <XB>sample string 28</XB> <amount>2</amount> <effectdate>sample string 8</effectdate> <fullname>sample string 5</fullname> <guidernum>sample string 16</guidernum> <identificationnumber>sample string 7</identificationnumber> <identificationtype>sample string 6</identificationtype> <invoicecode>sample string 11</invoicecode> <invoicetitle>sample string 10</invoicetitle> <mobile>sample string 3</mobile> <needinvoice>sample string 9</needinvoice> <otheruserid>4</otheruserid> <productid>sample string 1</productid> <remark>sample string 13</remark> <reserve1>sample string 14</reserve1> <reserve2>sample string 15</reserve2> <senderid>sample string 12</senderid> </YearCardOrderAddParm>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
对互联网年卡发起预订的接口。
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>