手持机售票接口文档v1.0

1、Qtrip365接口文档版本历史纪录日期版本说明作者2015-07-221.0接口模板邱纪伟2015-11-231.111.订单查询接口和订单明细查询接口中，票价，保险费，服务费改成总票价-总保险费-总服务费2.订单明细查询增加退款信息3.退票接口2.2.12增加请求参数：refundtotalprice4.增加2.2.11,专线查询应退款金额接口孙博2015-11-241.121.订单明细查询增加返程日期，返程日期说明，返程站名称，返程站代码，返程站说明2.专线订单查询接口2.2.6 增加请求参数cancomment说明2015-12-6线路查询接口增加返回参数增加返回

2、参数（isestimate、isdetail）2.1.6城际专车订单详情查询接口增加返回参数（isestimate、isdetail）孙博2015-12-211.13修改：2.1.22待服务内部订单查询、2.1.24司机准备出发、2.1.25司机到达出发位置、2.1.26行程开始、2.1.27行程结束新增：2.1.31获取移动客户端参数接口崔亚坤2015-12-211.13修改：2.1.28查询可还车城市、2.1.29确认还车朱宝2016-02-221.14修改：2.2.5提交订单，增加2.0版本，增加订单联系人信息必填，苹果有过渡期，旧的1.0版本仍可用修改：2.2.3班次查询接口修改，增加

3、请求参数【目的地名称reachname】新增：2.2.17目的地接口新增：2.2.18推荐班次查询孙博2016-03-091.15修改：2.2.18推荐班次查询2.2.4班次明细查询接口孙博2016-03-101.15修改：2.2.3班次查询接口崔亚坤2016-03-311.16修改2.1.6城际专车订单个查询接口 2.1.24司机准备出发 2.1.25司机到达出发位置 2.1.26行程开始 2.1.27行程结束添加2.1.32司机端上传位置接口 2.1.33根据订单号获取司机位置接口孙博1 公共信息1.1 Result参数参数名称类型（字节长度）参数说明是否可选样例status返回状态Str

4、ing见返回状态表不可选0000message返回信息String不可选调用成功1.2 ResultType参数参数名称类型（字节长度）参数说明是否可选样例success返回状态boolean是否成功不可选message返回信息String不可选1.3 Error参数参数名称类型（字节长度）参数说明是否可选样例key状态码String见返回状态表不可选SE-000message状态码说明String不可选variables变量String可选1.4 Clientinfo字段说明字段名称数据类型备注客户端类型clienttypeString0-网站1-android 2-IOS 3-移动WEB

5、4-未知浏览器名字browsernameString浏览器版本browserversionString操作系统版本osinfoString所使用机器信息computerinfoString2 接口说明2.1 城际专车2.1.1 创建订单（东超）n 使用范围：Android、IOS、移动WEBn HTTP请求类型：POSTn 是否加密：不加密n 返回格式：JSONn 请求路由：/specialcar/createorderismock?请求内容参数数据类型必填说明ismockintN0：不使用mock1：使用mock不传值为0orderOrderInfoY订单信息usertokenStirngY

6、用户登录后tokenOrderInfo名称数据类型必填说明operationrouteidLongY线路idstartaddressStringY出发地点originStringY出发地点坐标reachaddressStringY到达地点destinationStringY到达地点坐标initpriceDoubleY初始报价(前台传入，后台验证)departtimevalStringY预约时间(yyyyMMddHHmm)passengerphoneStringY订单信息接收人手机号vehiclebrandidLongN车辆品牌id（不限品牌传入空）返回内容返回内容为json串，字符串格式为对象

7、列表;对象的属性列表：参数参数名称类型参数说明是否可选样例responseCreateOrderResponse返回内容是CreateOrderResponse名称数据类型必填说明statusString是返回状态ordernoString是订单成功订单号messageString是返回状态信息说明MOCK数据返回数据2.1.2 获取支付网关（东超）n 使用范围：Android 、IOS、移动WEBn HTTP请求类型：GETn 是否加密：不加密n 返回格式：JSONn 请求路由：/specialcar/gatewaysismock?n请求内容参数数据类型必填说明ismockIntegerN0

8、：不使用mock 1：使用mock不传值为0返回内容返回内容为json串，字符串格式为对象列表;对象的属性列表：参数参数名称类型参数说明是否可选样例responseList返回内容是GateWay名称数据类型必填说明idstringY网关idpaywaytypeIntegerY支付方式paytradenameIntegerY支付商paytradenamevalStringy支付商名称picturepathStringY支付商logobankcodeStringN银行代码banknameStringn银行名称MOCK数据返回数据2.1.3 创建支付参数（东超）n 使用范围：Android 、IO

9、S、移动WEBn HTTP请求类型：GETn 是否加密：不加密n 返回格式：JSONn 请求路由：/specialcar/payparamismock?请求内容参数数据类型必填说明ismockIntegerN0：不使用mock 1：使用mock不传值为0gatewayidStringY支付网关idordernoStringY订单号返回内容返回内容为json串，字符串格式为对象列表;对象的属性列表：参数参数名称类型参数说明是否可选样例responseGetGateWayResponse返回内容是GetGateWayResponse名称数据类型必填说明paramSringY支付商支付参数返回par

10、am说明如果是控件支付，返回的param是普通字符串如果是表单提交，返回param为json格式Json所含数据为名称数据类型必填说明SringY支付商支付参数actionUrlStringY提交地址formSubmitMethodStringYform提交方式MOCK数据返回数据2.1.4 支付回调地址（东超）n 使用范围：支付服务器后台通知地址。n HTTP请求类型：*n 是否加密：加密n 返回格式：JSONn 请求路由：/payment/notifyismock?回调所带参数参数数据类型必填说明ismockIntegerN0：不使用mock 1：使用mock不传值为0dataString

11、Y返回数据内容(已加密)md5StringY验签数据返回内容返回内容为json串，字符串格式为对象列表;对象的属性列表：参数参数名称类型参数说明是否可选样例responsePayNotifyResponse返回内容是PayNotifyResponse名称数据类型必填说明dataStringY加密后数据md5StringY签名数据MOCK数据返回数据2.1.5 城际专车订单查询接口（徐雷）n 使用范围：Android 、IOS、移动WEBn HTTP请求类型：GETn 是否加密：不加密n 返回格式：JSONn 请求路由：/specialcar/seachordersismock?请求内容参数数据

12、类型可选说明ismockint否0-不使用mock 1-使用mockiscommentint是1-已点评 0-未点评不传参数则默认为全部订单ordernoString是订单号statusInt是订单状态usertokenString否User标记pageInteger是第几页不传获取所有的sizeInteger是每页显示几条不传获取所有的返回内容返回内容为json串，字符串格式为对象列表;对象的属性列表：参数参数名称类型参数说明是否可选样例response订单对象OrderinfosResponse返回内容是OrderinfosResponse名称数据类型必填说明orderinfosList是

13、订单信息countint是总条数OrderinfoResponse名称数据类型必填说明ordernoString是订单号orgcodeString是服务商代码orgnameString是服务商名称startnameString是出发城市名称reachnameString是到达城市名称statusInteger是订单状态(参照字典表 10-前端展示标识)orderstatusString是订单状态说明(参照字典表 10-前端展示文字)estimatehourDouble是预估小时estimaterangekmDouble是预估公里departtimeDate是预约用车时间(yyyy-MM-dd

14、HH:mm:ss)MOCK数据返回数据2.1.6 城际专车订单详情查询接口（孙博）n 使用范围：Android 、IOS、移动WEBn HTTP请求类型：GETn 是否加密：不加密n 返回格式：JSONn 请求路由：/specialcar/seachorderdetailismock?请求内容参数数据类型可选说明ismockint是0-不使用mock 1-使用mock 不传默认为0usertokenString否User标记ordernoString否订单号返回内容返回内容为json串，字符串格式为对象列表;对象的属性列表：参数参数名称类型参数说明是否可选样例response订单详情对象Ord

15、erDetailResponse返回内容是OrderDetailResponse名称数据类型必填说明feeitemList是费用项对象(费用项表)ordernoString是订单号orderstatusInteger是订单状态（参照字典表10-前端展示标识）statusdescriptionString是订单状态说明（参照字典表10-前端展示文字）hourDouble是小时rangekmDouble是公里estimatehourDouble是预估小时estimaterangekmDouble是预估公里paystatusInteger是支付状态paystatusdescriptionString

16、是支付状态说明（参照字典表9）paytimeDate是支付完成时间(yyyy-MM-dd HH:mm:ss)initpriceDouble是初始线路报价ridingpriceDouble是服务商报价paywaynameString是网关支付名称driversphoneString是司机联系电话(司机表)drivernameString司机名称【v1.16】vehiclenoString车牌号【v1.16】startnameString是出发城市名称startaddressString是出发地点originString是出发地坐标【v1.16】reachnameString是到达城市名称reac

17、haddressString是到达地点destinationString是到达地点坐标【v1.16】pictureaddressString是司机图片【v1.16】scheduleflagInteger是行程标识scheduleflagdescriptionString是行程标识说明(字典表17)orderprocessList是订单处理记录对像(订单处理记录表)ordereassessmentList是订单评价对像(字典表18的乘客点评)departtimeDate是预约用车时间(yyyy-MM-dd HH:mm:ss)passengerphoneString是联系人手机号码orgnameS

18、tring是机构名称orgphoneString是机构联系电话vehicletypenameString是车型名称vehiclebrandnameString是车品牌名称commentstatusInteger是订单点评状态commentstatusvalString是点评状态描述(字典表25)isestimatev1.13int否是否显示预估数据（时间、里程）-0:不显示预估数据，1:显示预估数据isdetailv1.13int否是否显示线路包含的时间和里程，0:不显示时间和里程，1：显示时间和里程FeeitemResponse名称数据类型必填说明feeitemString是费用项名称cod

19、eString是编码amountDouble是费用feepictureString是费用图片descriptionString是描述isactiveInteger是是可用isactivedescriptionString是1-可用0-不可用(参照字典表2)usercodeString是操作员代码usernameString是操作员名称updatetimeDate是更新时间(yyyy-MM-dd HH:mm:ss)createtimeDate是创建时间(yyyy-MM-dd HH:mm:ss)OrderprocessResponse名称数据类型必填说明orgcodeString是机构代码orde

20、rnoString是订单号rangekmDouble是公里数hourDouble是小时数linepriceDouble是线路价格createtimeDate是创建时间operatetypeInteger是操作类型operatenameString是订单处理过程(参照字典表14)explainsString是订单处理过程描述(参照字典表14)brandidLong是车辆品牌idbrandnameString是车辆品牌名称OrdereassessmentResponse名称数据类型必填说明evaluatevalueDouble是评价分值(1-5分;分高的满意度高)evaluateoptionInt

21、eger是评价选项（字典表18）ordereassessmentstring是评价选项描述MOCK数据返回数据2.1.7 城际专车取消订单接口（徐雷）n 使用范围：Android 、IOS、移动WEBn HTTP请求类型：GETn 是否加密：不加密n 返回格式：JSONn 请求路由：/specialcar/cancelorderismock?请求内容参数数据类型可选说明ismockint是0-不使用mock 1-使用mock 不传默认为0ordernoString否订单号usertokenString否User标记explainsString否订单取消原因(订单处理记录表的操作说明)返回内容返

22、回内容为json串，字符串格式为对象列表;对象的属性列表：参数参数名称类型参数说明是否可选样例response取消订单结果对象CancelOrderResponse返回内容是CancelOrderResponse名称数据类型必填说明resultint是操作结果(1：取消订单成功)MOCK数据返回数据2.1.8 获取参数接口（王川）n 使用范围：PC、IOS、Android、移动WEB n HTTP请求类型：GETn 是否加密：不加密n 返回格式：JSONn 请求路由：/parameterconfig/ismock请求内容参数数据类型可选说明ismockbooleany0-不使用mock 1-使

23、用mock 不传默认为0paramcodestringn编码值，多个值用|分隔如006|008|015返回内容返回内容为json串，字符串格式为对象列表;对象的属性列表：参数参数名称类型参数说明是否可选样例parameterconfigs订单信息List否parameterconfig中包含的对象：参数参数名称类型参数说明是否可选样例paramcode编码值String否paramvalue参数值String否description说明String否返回失败名称数据类型长度必填说明validationValidation错误对象类型，封装到validationMOCK数据返回数据2.1.9 获

24、取车辆品牌（王川）n 使用范围：PC、IOS、Android、移动WEB n 功能说明：根据车企和车型查询车辆品牌n HTTP请求类型：GETn 是否加密：不加密n 返回格式：JSONn 请求路由：specialcar/queryvehiclebrand/ismockn 请求内容参数数据类型可选说明ismockBooleany0-不使用mock 1-使用mock 不传默认为0usertokenString否User标记orgcodeStringn机构代码vehicletypeidStringn车型id返回内容返回内容为json串，字符串格式为对象列表;对象的属性列表：参数参数名称类型参数说明是

25、否可选样例VehiclebrandsListbrandname对象：参数参数名称类型参数说明是否可选样例Id品牌idStringbrandname车品牌String返回失败名称数据类型长度必填说明validationValidation错误对象类型，封装到validationMOCK数据返回数据2.1.10 提交评价（王川）n 使用范围：PC、IOS、Android、移动WEB n 功能说明：提交评价n HTTP请求类型：POSTn 是否加密：不加密n 返回格式：JSONn 请求路由：specialcar/saveassessment/ismockn 请求内容参数数据类型可选说明ismockB

26、ooleany0-不使用mock 1-使用mock 不传默认为0usertokenString否User标记ordernoStringn订单号evaluatevalueStringN评价分值按评价选项的顺序（5|2|3）返回失败名称数据类型长度必填说明validationValidation错误对象类型，封装到validationMOCK数据返回数据2.1.11 查询评价（王川）n 使用范围：PC、IOS、Android、移动WEB n 功能说明：查询评价n HTTP请求类型：GETn 是否加密：不加密n 返回格式：JSONn 请求路由：specialcar/queryassessment/i

27、smockn 请求内容参数数据类型可选说明ismockBooleany0-不使用mock 1-使用mock 不传默认为0usertokenString否User标记ordernoStringn订单号返回内容返回内容为json串，字符串格式为对象列表;对象的属性列表：参数参数名称类型参数说明是否可选样例webassessments订单信息List否webassessment中包含的对象：参数参数名称类型参数说明是否可选样例orderno订单号Stringevaluatedescription评价选项String字典表evaluatevalue评价分值String1-5分;分高的满意度高返回失败名

28、称数据类型长度必填说明validationValidation错误对象类型，封装到validationMOCK数据返回数据2.1.12 查询业务说明（王川）n 使用范围：PC、IOS、Android、移动WEB n 功能说明：查询评价n HTTP请求类型：GETn 是否加密：不加密n 返回格式：JSONn 请求路由：/dynamichtml/ismock请求内容参数数据类型可选说明ismockBooleany0-不使用mock 1-使用mock 不传默认为0codeStringn编码值，多个值用|分隔如006|008|015返回内容返回内容为json串，字符串格式为对象列表;对象的属性列表：参

29、数参数名称类型参数说明是否可选样例dynamichtmls订单信息List否dynamichtml中包含的对象：参数参数名称类型参数说明是否可选样例code编码值String否htmldata参数值String否funcname功能名称String否description说明String否Updatetime更新时间String否名称数据类型长度必填说明validationValidation错误对象类型，封装到validationl 规划约定code:Code说明Json数据约定101手机界面首页图片num: 1,name: 首页,path: ,num: 2,name: 第二张宣传图片,pa

30、th: ,102365服务协议由平台管理系统编辑并保存103取消订单原因cancelreason1:我的行程有变,cancelreason2:信息填写错误,重新预约,cancelreason3:发现更低价格,cancelreason4:司机未按约定时间到达,cancelreason5:其他原因MOCK数据返回数据2.1.13 出发城市接口（孙博）n 使用范围：PC、IOS、Android、移动WEB n HTTP请求类型：GETn 是否加密：不加密n 返回格式：JSONn 请求路由：/specialcar/departcitiesismock请求内容参数数据类型可选说明ismockint是0-

31、不使用mock 1-使用mock 不传默认为0iscansellInteger是0-未开通 1-开通不传获取全部wordString是关键字（）provincecodeString是省编码pageInteger是第几页（不传获取全部）sizeInteger是每页显示几条返回内容返回内容为json串，字符串格式为对象列表;对象的属性列表：参数参数名称类型参数说明是否可选样例departcities出发城市列表List出发城市集合否count总条数据String出发城市Departcity对象的属性名称数据类型长度必填说明citycodeString是出发城市codecitynameString是

32、出发城市名称city_jianpinString是出发城市简拼city_quanpinString是出发城市全拼initialString是出发城市首字母provinceString是所属省名称citybusinessList否城市开通的业务城市业务对象Citybusiness的属性名称数据类型长度必填说明businesscodeString是业务代码businessnameString是业务名称MOCK数据返回数据2.1.14 热门城市接口（孙博）n 使用范围：PC、IOS、Android、移动WEB n HTTP请求类型：GETn 是否加密：不加密n 返回格式：JSONn 请求路由：/sp

33、ecialcar/topcitiesismock请求内容参数数据类型可选说明ismockint是0-不使用mock 1-使用mock 不传默认为0letterString是获取字母区间的城市，可以传A或者A-B,或者A-Z等，默认是A-ZiscansellInteger是0-未开通 1-开通不传获取全部(影响:返回的字母集合)pageInteger是第几页（不传获取全部）(影响:热门出发城市列表)sizeInteger是每页显示几条返回内容返回内容为json串，字符串格式为对象列表;对象的属性列表：参数参数名称类型参数说明是否可选样例topcities热门出发城市列表List参照出发城市接口中

34、定义的Topcity对象否letters字母集合MapString, Listkey是a-z,value是Departcity的集合否a: ,b: ,c: count总条数据String出发城市Topcity对象的属性名称数据类型长度必填说明citycodeString是出发城市codecitynameString是出发城市名称MOCK数据返回数据2.1.15 到达站接口（孙博）n 使用范围：PC、IOS、Android、移动WEB n HTTP请求类型：GETn 是否加密：不加密n 返回格式：JSONn 请求路由：/specialcar/reachcitiesismock请求内容参数数据类型

35、可选说明ismockint是0-不使用mock 1-使用mock 不传默认为0startcodeString否出发城市codewordString是关键字（）pageInteger是第几页（不传获取全部）sizeInteger是每页显示几条返回内容返回内容为json串，字符串格式为对象列表;对象的属性列表：参数参数名称类型参数说明是否可选样例reachcities到达城市列表List到达城市集合否count总条数据String到达城市ReachCity对象的属性名称数据类型长度必填说明citycodeString是出发城市codecitynameString是到达城市codereachcode

36、String是到达城市codereachnameString是到达城市名称2.1.16 线路查询接口（孙博）n 使用范围：PC、IOS、Android、移动WEB n HTTP请求类型：GETn 是否加密：不加密n 返回格式：JSONn 请求路由： /specialcar/routesismock请求内容参数数据类型可选说明ismockint是0-不使用mock 1-使用mock 不传默认为0usertokenString否passengerphoneString否接收人手机号startcodeString否出发城市codereachcodeString否到达城市codepricesortin

37、t是价格排序（0-升序，1-降序）默认0pricescopestring是价格区间（如：1-50;51-100;1000-;）使用系统参数定义json格式价格区间orgcodeString是机构代码vehicletypeidString是车型idscheduleflagInteger否往返标识（1-单程，2-往返）departtimevalString否预约时间(yyyy-MM-dd HH:mm)startaddressString否出发地点originString否出发地点坐标（纬度,经度如：40.060677,116.308342）reachaddressString否到达地点destin

38、ationString否到达地点坐标（纬度,经度如：31.290369,121.615924）pageInteger是第几页（不传获取全部）sizeInteger是每页显示几条返回内容返回内容为json串，字符串格式为对象列表;对象的属性列表：参数参数名称类型参数说明是否可选样例routes线路列表List营运路线集合否orgs机构信息列表List机构集合否vehicletypes车型信息列表List车型集合否count总条数int线路总个数distanceval起终点之间距离（公里）String否durationval起终点方案耗时(小时)String否营运路线OperationRoute对

39、象的属性名称数据类型长度必填说明idString是线路idorgcodeString是机构代码orgnameString是机构名称vehicletypeidString是车型idvehicletypenameString是车型名称orgpictureString是机构图片地址seatnumString是客位数rangekmString否公里数hourString否小时数linepriceString是线路价格productdetailsList否套餐明细集合scheduleflagString是行程标识-参照字典表scheduleflagvalString是行程标识对应的汉字（如单乘单程单乘往

40、返共乘单程）isestimatev1.13int否是否显示预估数据（时间、里程）-0:不显示预估数据，1:显示预估数据isdetailv1.13int否是否显示线路包含的时间和里程，0:不显示时间和里程，1：显示时间和里程套餐明细ProductDetail对象的属性名称数据类型长度必填说明descriptionString描述feeitemString费用名称amountString费用feepictureString费用图片地址abbrchar费用名缩写iscontainString1-包含0-不含机构Org对象的属性名称数据类型长度必填说明orgcodeString是机构代码orgname

41、String是机构名称车型VehicleType对象的属性名称数据类型长度必填说明vehicletypeidString是车型idvehicletypenameString是车型名称MOCK数据返回数据2.1.17 地点建议接口（孙博）n 使用范围：PC、IOS、Android、移动WEB n HTTP请求类型：GETn 是否加密：不加密n 返回格式：JSONn 请求路由： /placesuggestionismock请求内容参数数据类型可选说明ismockint是0-不使用mock 1-使用mock 不传默认为0qString否输入建议关键字（支持拼音）regionString否所属城市/区

42、域名称或代号locationString是传入location参数后，返回结果将以距离进行排序(纬度,经度)返回内容返回内容为json串，字符串格式为对象列表;对象的属性列表：参数参数名称类型参数说明是否可选样例results查询到地址的集合List建议地址集合否建议地址Suggestion对象的属性名称数据类型长度必填说明nameString是地址名称cityString是所属市名称districtString否所属区名称businessString否cityidString是城市idlocationLocation是坐标coordinateString坐标（lat,lng）坐标Locati

43、on对象的属性名称数据类型长度必填说明latString纬度lngString经度MOCK数据返回数据2.1.18 方位接口（孙博）n 使用范围：PC、IOS、Android、移动WEB n HTTP请求类型：GETn 是否加密：不加密n 返回格式：JSONn 请求路由： /directionismock请求内容参数数据类型可选说明ismockint是0-不使用mock 1-使用mock 不传默认为0originString否起始点坐标destinationString否目的地点坐标origin_regionString否起点所在市destination_regionString否目的地点所在市tacticsString是导航策略（导航策略。导航路线类型，10，不走高速；11、最少时间；12、最短路径）默认11返回内容返回内容为json串，字符串格式为对象列表;对象的属性列表：参数参数名称类型参数说明是否可选样例direction方