行啊推送服务接口资料.docx
《行啊推送服务接口资料.docx》由会员分享,可在线阅读,更多相关《行啊推送服务接口资料.docx(33页珍藏版)》请在冰豆网上搜索。
行啊推送服务接口资料
行啊推送服务接口说明书
变更记录
版本号
修改原因/内容
修改人
审核/批准人
修改时间
2.0.0
增加内容:
1.增加火车票节点
2.最低价
3.出票完成、出保险未完成推送到小太阳的情况的缺陷修复
王松
王松
2016/04/13
2.1.0
增加内容:
1.机票航段对应关系(有开关,可控制是否推送)
2.支付信息
3.增加GP验证方式的字段(公务员身份验证/采购卡验证)
王松
王松
2016/05/03
2.2.1
增加内容:
1.行程导入的TC账号
2.航段添加打票机号
(本次新增内容参见黄色部分)
王松
王松
2016/05/23
2.2.2
增加内容:
1.GP采购卡号
2.行程数据来源
(本次新增内容参见黄色部分)
王松
王松
2016/06/27
接口说明
本接口用于将代理人在行啊系统中预定出票的行程数据推送到代理人后台系统。
需要提供推送地址及合作同步账号。
推送采用http的post传输,数据格式是utf-8编码的json字符串。
加密方式采用3Des加密算法,参见ThirdDes.java。
推送后需返回结果给行啊系统,json格式如下:
{"msgCode":
"1", "errMsg":
"null"}
msgCode:
1-同步成功0-同步失败
errMsg:
同步失败用于记录同步失败原因到行啊系统
接口推送数据说明:
推送对象:
AgentSysSynReqVo
属性
说明
accountName
同步账号,String
journeySynVO
行程详情,JourneySynVO
JourneySynVO
属性
说明
agentId
代理人idNUMBER
airItemPayStatus
航空单元是否已支付:
(n非在线支付c支付成功,等待收款(分润失败)f支付失败0待支付1支付成功2待补款3补款成功4支付取消5退款中6退款成功7补款取消),String
airItemSynVOList
航空单元列表,List
alterTicketReason
改签原因String
alterTicketRemark
改签说明String
appJourneyDesc
approvalUrgency
紧急送审标志1紧急送审0null正常送审String
apvLevel
当前审批级别String
apvType
审批类型:
0:
web审批1:
通过parid审批2:
通过邮箱审批String
apvruleId
审批规则类型IDNUMBER
bookUserType
预订人用户类型,1-个人型,0-秘书型,2-TCString
bookerEmail
预订人邮箱String
bookerId
预订人OBT账户idNUMBER
bookerMobile
预订人手机号码String
bookerName
预订人姓名String
bookerTel
预订人电话String
booktime
已定妥时间NUMBER
contactEmail
联系人emailString
contactName
联系人姓名String
contactParId
联系人paridNUMBER
contactTel
联系人电话String
corpCode
公司编码String
corpId
公司IDNUMBER
costCenterInfo
成本中心String
createtime
创建时间NUMBER
dataFrom
数据来源,1为手机端,2为web端String
description
行程说明(出差原因)String
di
国际国内标识(d-国内,i-国际)String
emailType
邮件类型String
hotelItemSynVOList
酒店单元列表List
icsAttachment
邮件附件String
ifSyncOA
是否同步OA(0-否1-是)String
isApplyEndorseTicket
用户是否已申请改签0否,1是String
isApplyRefundTicket
用户是否已申请退票0否,1是String
isEndorseTicket
是否改期0否,1是
jourState
行程状态(0-已取消,1-计划中,2-审批中,3-已通过,4-已拒绝,5-待订妥,6-已订妥)String
journeyNo
行程号NUMBER
needApv
是否需要审批String
needMailPassenger
标记是否需要给乘机人发送邮件(0-不需要1-需要)String
needSendItineraryPdf
标记是否需要发送PDF行程单0-不需要1-需要String
oaOrderNo
结算单号String
parId
预订人常客idNUMBER
payCancelReason
支付取消原因String
payFailTimes
审批类型:
0:
web审批1:
通过parid审批2:
通过邮箱审批String
payconfirm
是否已点击过“确认支付”0否1是String
policyUserId
差旅政策人idNUMBER
psgRemark
psg备注String
pushDownState
下推状态,SUCCESS或这FAILString
refundTicketReason
退票原因String
refundTicketRemarks
退票说明String
remark
备注(TC转线下处理回填备注用)String
returnReason
订单退回理由String
selectedApvers
所选审批人(多个使用,分隔)String
serviceCodeId
服务代码IDNUMBER
serviceCodeName
服务代码名称String
stateUpTime
状态修改时间NUMBER
submitDirectly
标记审批通过后是否直接提交订单(0-不直接提交1-直接提交)String
supplierId
供应商idNUMBER
synOaFlag
同步oa标志位0-未同步;1-自动同步失败;2-人工同步失败;3-同步成功String
tcRemark1
tc备注String
tcRemark2
tc备注String
tcRemark3
tc备注String
tcRemark4
tc备注String
tcRemark5
tc备注String
tcRemark6
tc备注String
tcRemark7
tc备注String
tcRemark8
tc备注String
ticketSyns
票面信息List
tktIssueType
出票类型1-TC出2自动出票3TC确认自动出票4易行String
travelPolicyId
差旅政策idNUMBER
travelPurpose
旅行目的String
travelPurposeEn
旅行目的英文描述String
updatePnrRemark
pnr更新备注String
workName
预订人工作用名String
bookerUserName
预订人用户名String
orderType
订单类型(0-默认1-gp行程)String
tktTcAccountName
出票人TC用户账户名String
apvHistorySynVOList
审批历史List
customFieldSynVals
自定义字段列表List
trainItemSynVOList
火车单元列表List
bcTktSynVOList
票列表List
jourPayedRepayedHisSynVoList
已支付已补款历史信息List
importTcAccount
导入行程的TC账号String
journeySource
行程数据来源0-bde1-易行,默认为0CHAR
(1)
AirItemSynVO
属性
说明
agentId
代理人IDNUMBER
airItemNo
航空单元号NUMBER
airItemState
航空单元的状态(1-正常,0-已删除)String
airportTax
机建税NUMBER
autoCancelFlag
自动取消标识String
bookedLowestType
预定时差旅政策类型,0-全天最低价,1-以期望时间为基准最低价,3-以所选航班为基准最低价,4-本次航班最低价String
bpnr
航空公司大编码String
cancelFlag
pnr是否取消标识,“1”已取消;“0”未取消;默认为“0”String
contrContent
违背了哪些差旅政策String
contrContentEn
违背政策内容(英文)String
contrPolicy
是否违背差旅政策(1-违背,0-不违背)String
contrReason
违背差旅政策的原因String
contrReasonEn
违背差旅政策的原因(英文)String
createtime
航空单元创建日期NUMBER
ei
退改签规定String
eiEn
英文退改签规定String
fuelTax
燃油税NUMBER
hasServiceFee
是否需要服务费(0-不需要,1-需要)String
ifSupplement
是否需要补位(0-不需要补位1-正在补位2-自动补位成功3-自动补位失败4-手工补位成功5-手工补位失败)String
isAutoTkt
用于移动判断该航空单元是否需要自动出票,0--不需要1--需要String
jourType
行程类型(OW-单程,RT-往返)String
journeyCreatetime
行程创建日期NUMBER
journeyNo
行程号NUMBER
lostVolume
措施节约成本NUMBER
lowestType
最低价类型(0-全天最低价,1-时段最低价,为空是正常价)String
officeNo
代理人Office号String
oi
用来标志是去程还是回程,o去程i回程String
otherPrice
其他价格说明String
parGuestname
旅客姓名String
passengerSynVOList
乘客列表List
pnrCreatetime
pnr创建时间NUMBER
pnrNo
pnr号String
priceType
//价格类型(RTNET,RTPUB,NET,PUB,NET+NET,PUB+PUB,NET+PUB,PUB+NET)String
priceTypeDesc
价格类型String
referenceId
分开预订的航空单元UUIDString
segmentSynVOList
航段列表List
serviceFee
服务费NUMBER
tktResult
出票结果0--出票失败1--出票成功String
tktl
出票时限NUMBER
totalPrice
总价(不含税)NUMBER
totalTax
总税NUMBER
issueBy
出票方式:
0-待定(tc手动确定);m-TC手动出票;1-BSP自动出票;2-外采平台出票;3-航空公司B2BString
gpOrderNo
GP政府采购订单号String
airItemInsureSynVOList
List
typeForLowest
参考航班最低价-最低价类型(0-全天最低价,1-时段最低价,空-本身是最低价)String
airportTaxForLowest
参考航班最低价-机建税NUMBER
fuelTaxForLowest
参考航班最低价-燃油税NUMBER
totalPriceForLowest
参考航班最低价-总价(不含税)NUMBER
totalTaxForLowest
参考航班最低价-总税NUMBER
gpPayType
GP政府采购订单支付方式1-公务卡验证2-预算单位验证CHAR
(1)
issueMachineNo
bsp打票机号String
gpPurchaseCardNo
GP采购卡号String
PassengerSynVO
属性
说明
agentId
代理人idNUMBER
airItemNo
航空单元号NUMBER
birthday
出生日期NUMBER
certNo
证件号String
certType
证件类型(1-身份证;2-护照;3-其他(暂时不用))String
corpCode
公司编码String
corpId
公司idNUMBER
costCenterDepartMentId
成本中心部门idNUMBER
costCenterInfo
成本中心信息String
departMentId
乘客部门idNUMBER
departmentName
部门名称String
email
乘机人emailString
employeeNo
员工号String
expireDate
证件有效期NUMBER
gender
性别(M-男;F-女)String
(1)
holderNationality
国籍两字码String
hostName
主机姓名String
hotelItemId
酒店单元IDNUMBER
isCheckInPerson
是否是入住人:
1表示入住人,0表示是同住人String
isTempPsg
临客为“1”,常客不为“0”String
issueCountry
证件签发国String
journeyCreatetime
此乘机人所属行程创建时间NUMBER
memCard
常客卡号String
mobile
乘机人手机String
parSynVOList
常客列表List
passengerId
idNUMBER
passengerType
乘机人类型1-成人,2-儿童String
psgName
乘机人姓名String
psgNameEn
乘客英文名字String
psgParCode
乘客常旅客代码String
psgParId
常客IDNUMBER
seatPrice
席别价格NUMBER
seatType
席别String
sequenceNo
乘客在PNR中的序号String
ticketNumber
票号String
issueChannel
出票渠道:
1-其他;2-外采;3-B2B;(与票号顺序一一对应)String
issueExPlatform
出票外部平台:
1-易行平台2-支付宝3-其他(与票号顺序一一对应)String
ticketType
客票类型:
1-BSP;2-B2B;(与票号顺序一一对应)String
issueRemark
出票说明(当出票渠道选择其他时,此字段为tc输入的自由文本)String
insureNumber
保险单号String
ticketState
机票客票状态(1出票、2退废票、3改期、9拒绝出票)String
trainBCStatus
火车票退改状态0已出票、1申请退票中、2已退票、3申请退票失败String
trainItemID
火车票单元IDNUMBER
trainPrice
火车票单价NUMBER
trainInsureType
火车票保险险种String
trainInsureNo
火车票保单号String
trainInsurePrice
火车票保险价格NUMBER
trainInsureNum
火车票保险份数NUMBER
trainBox
火车票列车车厢号码String
trainSeatNo
火车票座位号String
trainSeatType
火车票座位类型String
trainRefundID
火车票退票通知IDNUMBER
trainRefundAmount
火车票单票退款金额NUMBER
trainRefundStatus
火车票退票处理结果0为SUCCESS/1为FAILURE成功/拒绝退票String
trainRefundFailReason
火车票退票失败原因String
showInSchedule
是否在我的日程中显示,0不显示1显示默认为1String
ParSynVO
属性
说明
agentId
代理人idNUMBER
apvruleId
关联国内审批规则idString
birthday
出生日期NUMBER
chngName
中文名String
chnsName
中文姓String
city
所属城市String
contactEmail
联系人邮箱String
contactMobile
联系人手机String
contactName
联系人姓名String
corpCode
所属总公司代码String
corpId
所属总公司IDNUMBER
departmentId
常客所属部门idNUMBER
docaTakeoffStn
默认DOCA出发地信息String
email
个人邮件String
emergencyContact
紧急联系人String
emergencyContactEmail
紧急联系人邮箱String
emergencyContactMobile
紧急联系人手机String
employeeNo
员工号String
enggName
英文名String
engsName
英文姓String
hostName
主机格式姓名(国内预定相关)String
inApvruleId
关联国际审批规则idString
inHostName
主机格式姓名(国际预定相关)String
inTravelId
关联国际差旅政策IDString
isTemp
是否临时旅客(0:
否;1:
是)String
mobile
个人手机String
nation
国籍String
parId
IdNUMBER
parLevel
常旅客级别(C:
普通;V:
VIP;S:
最高级)String
parreMark
常旅客备注String
related
该常客是否已关联了前台账号(0-否1-是)String
sex
性别(M:
男;F:
女)String
status
状态(A:
有效;I:
无效;B:
黑名单)String
title
职务String
travelId
关联差旅政策idString
updateTime
创建时间NUMBER
workName
工作用名String
SegmentSynVO
属性
说明
accountCode
大客户编码String
actionCode
行动代码String
agentId
代理人idNUMBER
airItemNo
航空单元号NUMBER
airlineShortName
航空公司简称String
airportTax
机建税NUMBER
arriveAirportName
到达机场名称String
arriveCity
到达城市三字码String
arriveCityName
到达城市名称String
arriveStn
到达机场三字码String
arriveTerminal
到达地航站楼String
arriveTime
到达时间NUMBER
bankStringges
刷卡费NUMBER
bankStringgesRate
刷卡费率NUMBER
baseCabin
基础舱位(F-头等舱,C-商务舱,Y-经济舱)String
baseFare
运价基础String
cabinCode
舱位代码String
cabinDiscount
折扣String
cabinType
舱位类型(F-头等舱,C-商务舱,Y-经济舱,其他为超级经济舱)String
carriageAirline
承运方航空公司String
carriageFltNo
承运方航班号String
craftTypeCode
机型String
externalPriceFormula
对外价格公式String
flytime
飞行时间String
formulaName
公式名称String
fuelTax
燃油税NUMBER
fullPrice
该航段所属舱位类型全价NUMBER
inPrice
对外价格NUMBER
journeyCreatetime
此航段所属行程创建时间NUMBER
marketAirline
市场航空公司两字码String
marketFltNo
市场航空公司航班号String
mealcode
餐食代码String
oi
去回程标识String
outDiscount
营销策略idString
price
航段票价(不含税)NUMBER
salePrice
售价NUMBER
salePriceFormula
售价公式String
saleStrategyId
贴扣点String
seat
0-未知,1-支持,2-不支持String
segmentId
IdNUMBER
sequenceNo
航段序号String
standardPrice
标准价NUMBER
stopTime
经停时间String
stopover
是否有经停String
stoppingPlaces
经停点String
takeoffAirprotName
起飞机