航交科技接口文档1.1概要

1、重庆航交科技发展有限公司游轮产品预订接口规范版本号：1.1 版权申明：本文件属于机密文件，所有权属于重庆市航交科技发展有限公司。任何接触此件的人必须遵守以下规定：1、 本文件及包含的内容均属于重庆市航交科技发展有限公司资产。2、 未经重庆市航交科技发展有限公司的书面同意，任何人不得对本文件的全部和/或部分内容进行任何形式的复制或传播扩散版本历史版本/状态作者修订章节修改原因更新日期API版本号V1.0蒋剑2013-05-2V1.1蒋剑蒋波数据的请求和获取1、 接口优化，所有数据返回改为实体对象2、 新增和删除一些冗余的查询条件2013-11-0目录一、接入方式4

2、1.接口地址配置42.会话认证参数：43.接口通用响应报文：4二、数据的请求和获取51.游轮基本资料的获取5A.游轮列表5B.游轮航班6C.游轮出发地和目的地7D.游轮系列8E.游轮视频8F.游轮行程9G.游轮图库9H.房型分布10I.游轮房型10J.游轮航期11K.游轮公司132.订单相关数据151)订单状态枚举表152)提交订单153)订单列表174)订单明细183.三峡景区基本信息19A.三峡景区列表194.接口通知20三、附录（类属性速查表）231.实体类列表232.实体类241)SerializableAttribute XmlRootAttribute("AlbumMod

3、le") public class AlbumModle242)SerializableAttribute XmlRootAttribute("Area") public class Area253)SerializableAttribute XmlRootAttribute("CallbackNotification") public class CallbackNotification264)SerializableAttribute XmlRootAttribute("Client_Order_Contace") pu

4、blic class Client_Order_Contace263.C# 签名示例代码404.地区编码42一、 接入方式接口环境地址通过http协议调用如下接口地址1. 接口地址配置测试环境地址： 正式生产环境： 数据请求方式：POST请求的数据：Http + Xml返回的数据：XML格式的字符串（具体格式参见后续章节）2. 会话认证参数：a) 查询方法指令：method (如：获取游轮列表 method = cruises.list)b) 应用程序标识：appkey (16位字符串)c) 时间戳标识: timespand) 签名标识：Sign (由上诉参数(a-c)，按照A-Z排序，经过a

5、ppsecret生成 D5加密的字符串)提示：如采用我司现有SDK（C#）,可简单配置 Apikey.Config 并放在Web应用程序 Bin目录下即可SDK文件请联系我方索取。（QQ：448995，Email:jtow）Apikey.Config 配置格式如下：<?xml version="1.0" encoding="utf-8" ?><configuration> <appSettings> <add key="appkey" value="会话标识" /

6、> <add key="appsecret" value="会话密钥" /> </appSettings></configuration>3. 接口通用响应报文：<ResultSuccess>是否响应成功</ResultSuccess><ErrorCode>响应的错误编码</ErrorCode><ErrorMessgge>具体的错误信息</ErrorMessgge>二、 数据的请求和获取1. 游轮基本资料的获取A. 游轮列表请求命令：crui

7、ses.modelList参数名值类型必须说明CompanyIDint0游轮公司编号departure,destinationstring0出发地和目的地编码（参数必须同时提供）begindatedatetime0开始日期enddatedatetime0结束日期Starint0游轮星级1-5minpricedecimal0最低价maxpricedecimal0最高价shipnamestring0游轮名称seriesidint0游轮系列IDPageIndexint1分页起始页码PageSizeint1分页每页数量<?xml version="1.0" encoding=

8、"utf-8"?><CruisesListResponse xmlns:xsi="/2001/XMLSchema-instance" xmlns:xsd="/2001/XMLSchema"> <ResultSuccess>true</ResultSuccess> <PageCount>46</PageCount> <RecordCount>46</RecordCount> <S

9、hipModel> <MaxPrice>最低价</MaxPrice> <MinPrice>最高价</MinPrice> <ShipID>游轮编号</ShipID> <CompanyID>所属游轮公司编号</CompanyID> <ShipType>游轮类型</ShipType> <Title>游轮标题</Title> <ShipNameCN>游轮中文名称</ShipNameCN> <ShipNameEN>游轮英

10、文名称</ShipNameEN> <Logo> </Logo> <Pic> </Pic> <Highlight >游轮亮点</Highlight > <Description>游轮介绍</Description> <Registration>建造地</Registration > <DraughtDepth>吃水深度</DraughtDepth/> <Speed>航速</Speed> <Star>游轮星级

11、</Star> <Capacity >载客量<Capacity> <EmployeeCount>船员数量</EmployeeCount/> <RoomCount>房间数量</RoomCount> <DeckCount>甲板（楼层）数量<DeckCount/> <GrossTonnage>总吨位</GrossTonnage> <Width>游轮宽度</Width> <Height>游轮高度</Height> <L

12、ength>游轮长度</Length> <ManufactureDate>制造日期</ManufactureDate> <RenovationDate>重新装修日期</RenovationDate> </ShipModel></CruisesListResponse>B. 游轮航班请求命令：cruises.flightsmodellist注：1、如果查询的条件为空，将返回系统当前日期到一个月内的所有航班，便于生成月份航期表（数据较大，建议缓存）.2、起始日期和终止日期的最大跨度范围为1个月.参数名值类型必

13、须说明begindatedatetime0起始日期enddatedatetime0终止日期shipidint0游轮编号CompanyIDint0游轮公司编号SailingIDint0航期编号DepartureAreaIDstring0出发地编号ArriveAreaIDstring0目的地编号minpricedecimal0最低价maxpricedecimal0最高价Tagsstring0标签（特价、热门、内容页推荐、首页推荐）starint0游轮星级seriesidint0游轮系列ID返回值：<?xml version="1.0" encoding="utf

14、-8"?><CruisesFlightsModelList xmlns:xsi="/2001/XMLSchema-instance" xmlns:xsd="/2001/XMLSchema"> <ResultSuccess>true</ResultSuccess> <FlightsModel> <Star>5</Star> <ShipPic> <FlightsID>航班编号</

15、FlightsID> <FlightsTitle>航班名称</FlightsTitle> <FlightsName>航班名称</FlightsName> <CompanyID>所属游轮公司编号</CompanyID> <CompanyName>游轮公司名称</CompanyName> <ShipID>游轮编号</ShipID> <ShipName>游轮名称</ShipName> <SailingID>所属航期编号</Sailin

16、gID> <DepartureDate>开航日期</DepartureDate> <ArriveDate>抵港日期</ArriveDate> <DepartureTime>开航时间</DepartureTime> <ArriveTime>到港时间</ArriveTime> <DepartureAreaID>出发地编号</DepartureAreaID> <DepartureAreaName>出发地名称</DepartureAreaName> &l

17、t;ArriveAreaID>到达地城市编号</ArriveAreaID> <ArriveAreaName>到达地城市名称</ArriveAreaName> <Description>其他信息</Description> <DepartureDockID>出港码头编号</DepartureDockID> <DepartureDockName>出港码头名称</DepartureDockName> <ArrivalDockID>到港码头编号</ArrivalDockI

18、D> <ArrivalDockName>到港码头名称</ArrivalDockName> <Tags>其他标记，如特价、首页推荐等</Tags> <CreateDateTime>2013-11-18T11:37:32.9719716+08:00</CreateDateTime> </FlightsModel></CruisesFlightsModelList>C. 游轮出发地和目的地请求命令：cruises.areamodellist返回值：<?xml version="1.0

19、" encoding="utf-8"?><CruisesSailingAreaListResponse xmlns:xsi="/2001/XMLSchema-instance" xmlns:xsd="/2001/XMLSchema"> <ResultSuccess>true</ResultSuccess> <AreaModel> <DepartureAreaID>出发地编码</Departu

20、reAreaID><DepartureAreaName>出发地名称</DepartureAreaName><DepartureStateCode>出发地三字码</DepartureStateCode> <ArriveAreaID>目的地编码</ArriveAreaID><ArriveAreaName>目的地名称</ArriveAreaName><ArriveStateCode>目的地三字码</ArriveStateCode> </AreaModel><

21、/CruisesSailingAreaListResponse>D. 游轮系列请求命令：cruises.cruisesserieslist返回值：<?xml version="1.0" encoding="utf-8"?><CruisesSeriesListResponse xmlns:xsi="/2001/XMLSchema-instance" xmlns:xsd="/2001/XMLSchema"> <Resul

22、tSuccess>true</ResultSuccess> <ShipSeriesModel> <Specialdescription>系列介绍</Specialdescription> <Id>系列ID </Id> <SpecialType>系列类型</SpecialType> <SpecialTitle>系列名称标题 </SpecialTitle> <SpecialValue>系列所包含的游轮编号，以逗号分隔</SpecialValue> &

23、lt;Tag>扩展标签</Tag> <Pic>系列图片</Pic> </ShipSeriesModel>.</CruisesSeriesListResponse>E. 游轮视频请求命令：cruises.videomodellist参数名值类型必须说明shipidint1游轮编号PageIndexint1索引页码PageSizeint1分页数量返回值：<?xml version="1.0" encoding="utf-8"?><CruisesVideoListRespons

24、e xmlns:xsi="/2001/XMLSchema-instance" xmlns:xsd="/2001/XMLSchema"> <ResultSuccess>true</ResultSuccess> <PageCount>1</PageCount> <RecordCount>2</RecordCount> <VideoModel> <ID>8</ID> <Type&

25、gt;Ship</Type> <RelationID>47</RelationID> <Name>长江贰号</Name> <Pic> <Url> </VideoModel> </CruisesVideoListResponse>F. 游轮行程请求命令：datalist参数名值类型必须说明sailingidint1航期编号返回值：<?xml version="1.0" encoding="utf-8"?><

26、;CruisesTravelListResponse xmlns:xsi="/2001/XMLSchema-instance" xmlns:xsd="/2001/XMLSchema"> <ResultSuccess>true</ResultSuccess> <TravelModel> <TravelID>IDTravelID> <Title>标题/Title> <Description>说明Descri

27、ption> <ScenicIDList>226</ScenicIDList> <ScenicNameList>宜昌市</ScenicNameList> </TravelModel></CruisesTravelListResponse>G. 游轮图库请求命令：cruises.albummodellist参数名值类型必须说明shipidint1游轮编号返回值：<?xml version="1.0" encoding="utf-8"?><CruisesAlbum

28、Response xmlns:xsi="/2001/XMLSchema-instance" xmlns:xsd="/2001/XMLSchema"> <ResultSuccess>true</ResultSuccess> <PageCount>6</PageCount> <RecordCount>57</RecordCount> <AlbumModel> <ID>538</ID>

29、 <Type>1</Type> <RelationID>47</RelationID> <Name>长江贰号足疗室</Name> <Description /> <Url> <OrderID>0</OrderID> <CreateDateTime>2013-11-12T10:44:58.2787517+08:00</CreateDateTime> </AlbumModel></CruisesAlbumResponse>H. 房型

30、分布请求命令：cruises.deckmodellist参数名值类型必须说明roomtypeidint1房型类型编号返回值：<?xml version="1.0" encoding="utf-8"?><CruisesDeckListResponse xmlns:xsi="/2001/XMLSchema-instance" xmlns:xsd="/2001/XMLSchema"> <ResultSuccess>true

31、</ResultSuccess> <ShipDeckModelList> <Floor>所在楼层</Floor> <DeckName>甲板（楼层）名称</DeckName> <DeckAddtionFee>选楼层的附加费用</DeckAddtionFee> </ShipDeckModelList></CruisesDeckListResponse>I. 游轮房型请求命令: cruises.roomtypemodellist参数名值类型必须说明shipidint1游轮编号<

32、;?xml version="1.0" encoding="utf-8"?><CruisesRoomTypeListResponse xmlns:xsi="/2001/XMLSchema-instance" xmlns:xsd="/2001/XMLSchema"> <ResultSuccess>true</ResultSuccess> <RoomTypeModel> <RoomTypeID&g

33、t;房间ID</RoomTypeID> <Pic>房间图片</Pic> <RoomTypeName>房间名称</RoomTypeName> <Description>房间说明</Description> </RoomTypeModel> </CruisesRoomTypeListResponse>J. 游轮航期航期列表：请求命令：cruises.sailingmodellist参数名值类型必须说明shipidint1游轮编号返回值：<?xml version="1.0&q

34、uot; encoding="utf-8"?><CruisesSailingListResponse xmlns:xsi="/2001/XMLSchema-instance" xmlns:xsd="/2001/XMLSchema"> <ResultSuccess>true</ResultSuccess> <SailingModel> <TravelId>13,14,15,16,</TravelId&g

35、t; <SailingID>7</SailingID> <ShipID>41</ShipID> <SailingName>航期名称</SailingName> <StartDate>航期开始时间</StartDate> <EndDate>航期结束时间</EndDate> <DepartureAreaID>出发地编号</DepartureAreaID> <DepartureAreaCoding>出发地编码（CKG）</Departure

36、AreaCoding> <ArriveAreaID>目的地编号</ArriveAreaID> <ArriveAreaCodeing>目的地编码（YIH）</ArriveAreaCodeing> <DepartureTime>出港时间</DepartureTime> <ArriveTime>到港时间</ArriveTime> <DepartureDockID>出港码头</DepartureDockID> <ArrivalDockID>到港码头</Arri

37、valDockID> <SingleTrip>单程天数</SingleTrip> <CycleTime>往返天数</CycleTime> <CreateDateTime>2013-11-12T17:30:47.6652961+08:00</CreateDateTime> <TravelList> 行程列表 <ShipTravel> <TravelID>13</TravelID> <Title>第一天 重庆朝天门港登船</Title> <De

38、scription></Description> <ScenicIDList>15</ScenicIDList> <ScenicNameList>朝天门</ScenicNameList> </ShipTravel> . </TravelList> </SailingModel> </CruisesSailingListResponse>航期详情：请求命令：cruises.getsailingmodel(已废弃) （新命令- cruises.sailingmodelnew）参数名值类

39、型必须说明shipidint?1游轮编号sailingidint?1航期编号必须且只能提供一个参数返回值：<?xml version="1.0" encoding="utf-8"?><SailingGetResponse xmlns:xsi="/2001/XMLSchema-instance" xmlns:xsd="/2001/XMLSchema"> <ResultSuccess>true</ResultSuc

40、cess> <SailingModel> <TravelId>2129,2131,2157,2160,2163,</TravelId> <SailingID>598</SailingID> <ShipID>3</ShipID> <SailingName>2013年长江海外长江一号8月28日宜昌-重庆航期</SailingName> <StartDate>2013-08-28T00:00:00</StartDate> <EndDate>2013-0

41、9-01T00:00:00</EndDate> <DepartureAreaID>420500</DepartureAreaID> <ArriveAreaID>500000</ArriveAreaID> <DepartureTime>09:00</DepartureTime> <ArriveTime>08:30</ArriveTime> <DepartureDockID>3</DepartureDockID> <ArrivalDockID>1</

42、ArrivalDockID> <SingleTrip>5</SingleTrip> <CycleTime>7</CycleTime> <CreateDateTime>2013-07-27T10:37:49.983</CreateDateTime> </SailingModel></SailingGetResponse>请求命令：cruises.sailingmodelnew参数名值类型必须说明sailingidint?1航期编号返回值：<?xml version="1.0&qu

43、ot; encoding="utf-8"?><SailingGetResponse xmlns:xsi="/2001/XMLSchema-instance" xmlns:xsd="/2001/XMLSchema"> <ResultSuccess>true</ResultSuccess> <SailingModel> <TravelId>2129,2131,2157,2160,2163,</Travel

44、Id> <SailingID>598</SailingID> <ShipID>3</ShipID> <SailingName>航期名称</SailingName> <StartDate>航期开航时间</StartDate> <EndDate>航期终航时间</EndDate> <DepartureAreaID>出发地编号</DepartureAreaID> <DepartureAreaCoding>出发地三字码</Departur

45、eAreaCoding> <ArriveAreaID>目的地编码</ArriveAreaID> <ArriveAreaCodeing>目的地三字码</ArriveAreaCodeing> <DepartureTime>出港时间</DepartureTime> <ArriveTime>到港时间</ArriveTime> <DepartureDockID>出港码头编号</DepartureDockID> <ArrivalDockID>到港码头编号</Arr

46、ivalDockID> <SingleTrip>单程天数</SingleTrip> <CycleTime>往返天数</CycleTime> <CreateDateTime>创建日期</CreateDateTime> <ShipTravelList> <ShipTravel> <TravelID>行程编号</TravelID> <Title>行程标题</Title> <Description>行程说明</Description&g

47、t; <ScenicIDList>景点编号列表，以逗号分隔</ScenicIDList> <ScenicNameList>景点名称列表，以逗号分隔</ScenicNameList> </ShipTravel> </ShipTravelList> </SailingModel></SailingGetResponse>K. 游轮公司公司列表：请求命令：panymodellist返回值：<?xml version="1.0" encoding="utf-8"

48、?><CruisesCompanyListResponse xmlns:xsi="/2001/XMLSchema-instance" xmlns:xsd="/2001/XMLSchema"> <ResultSuccess>true</ResultSuccess> <CompanyModel> <CompanyID>游轮公司ID</CompanyID> <CompanyName>游轮公司名称</Co

49、mpanyName> <Logo>游轮公司标识图片 </Logo> <Description>游轮公司介绍</Description> </CompanyModel> </CruisesCompanyListResponse>公司详情：请求命令：panyget参数名值类型必须说明companyidint1油轮公司编号返回值：<?xml version="1.0" encoding="utf-8"?><CompanyGetResponse xmlns:xsi=&

50、quot;/2001/XMLSchema-instance" xmlns:xsd="/2001/XMLSchema"> <ResultSuccess>true</ResultSuccess> <CompanyModel> <CompanyID>公司编号</CompanyID> <CompanyName>公司名称</CompanyName> <Logo>公司标识</Logo> <Des

51、cription>公司介绍</Description> </CompanyModel></CompanyGetResponse>2. 订单相关数据1) 订单状态枚举表名称值说明Unknown-1未知状态Wait_Seller_Confirm100等待审核Wait_Buyer_Payment200等待买家付款Payment_Success300付款成功Trade_Finished400交易成功Trade_Closed500交易关闭2) 提交订单请求命令：crusises.postorder参数名值类型必须说明travelerliststring1乘客明细

52、列表 HtmlEncode编码orderinfostring1订单基本信息，如联系人等 HtmlEncode编码参数示例：1、 Orderinfo （订单联系人相关）<Client_Order_Contace><Boby>世纪神话重庆-宜昌(2013-11-19)(豪华标准间)(￥2,450)1人;</Boby><Title>纪神话(重庆宜昌)(2013-11-19)</Title><Shipid>游轮编号（int）</Shipid><FlightsID>航班编号（int）</FlightsI

53、D><Contact>张三</Contact><ReceiverAddress>重庆市渝中区</ReceiverAddress><ReceiverMobile>1234567890</ReceiverMobile><ReceiverEmail>abc</ReceiverEmail></Client_Order_Contace>2、travelerlist（游客列表）<ArrayOfClient_Order_Passenger><Client_Order_Passe

54、nger><Extend><Extend><Title>世纪神话重庆-宜昌(2013-11-19)</Title><Floor>楼层</ Floor><AgeType>1</AgeType><Num>1</Num><UserName>张三</UserName><ShipID>65</ShipID><ShipName>世纪神话</ShipName><FlightsID>5415</F

55、lightsID><FlightsName>世纪神话重庆-宜昌(2013-11-19)</FlightsName><FlightsDepartureDate>2013-11-19T00:00:00</FlightsDepartureDate><RoomTypeID>246</RoomTypeID><RoomTypeName>豪华标准间</RoomTypeName><PriceTypeID>971</PriceTypeID><PriceTypeName>内宾-

56、成人</PriceTypeName></Client_Order_Passenger></ArrayOfClient_Order_Passenger>返回值：<?xml version="1.0" encoding="utf-8"?><OrderResponse> <ResultSuccess>true</ResultSuccess> <OrderID>订单号（请本地记录，对应自己的会员等）</OrderID> <OrderModel>

57、 <FlowID>订单流水号</FlowID> <OrderID>订单号</OrderID> <SellCompanyID>卖家企业ID</SellCompanyID> <BuyCompanyID>买家企业ID</BuyCompanyID> <ReceiverPhone>订单联系人座机</ReceiverPhone /> <CompanyID>买家企业ID</CompanyID> <MemberID/> <ReceiverName&g

58、t;订单联系人姓名</ReceiverName> <TotalFee>金额</TotalFee> <DiscountFee>优惠金额</DiscountFee> <Payment>已付款金额（接口订单为0）</Payment> <ReceiverAddress>订单联系人地址</ReceiverAddress> <ShipID>所属游轮编号</ShipID> <FlightsID>所属航班编号</FlightsID> <Title&g

59、t;标题</Title> <Body>详情</Body> <Extend>扩展信息</Extend> <BuyerMemo>买家备注</BuyerMemo /> <ReceiverMobile>订单联系人电话</ReceiverMobile> <SellerMemo>卖家备注</SellerMemo /> <ReceiverEmail>订单联系人信箱</ReceiverEmail> <Status>订单状态（详见2.A）<

60、/Status> <ConfirmDateTime>订单确认时间</ConfirmDateTime/> <LastPaymentDateTime >最后一次付款时间</LastPaymentDateTime > <PaymentDateTime>付款时间</PaymentDateTime/> <TimeoutActionDateTime>付款超时日期</TimeoutActionDateTime> <CreateDateTime>订单创建日期</CreateDateTime&

61、gt; </OrderModel></OrderResponse>3) 订单列表请求命令：method=cruises.ordermodellist参数名值类型必须说明OrderIDsstring0以逗号分隔的订单号列表返回值：<?xml version="1.0" encoding="utf-8"?><CruisesOrderModelListResponse xmlns:xsi="/2001/XMLSchema-instance" xmlns:xsd=&qu

62、ot;/2001/XMLSchema"> <ResultSuccess>true</ResultSuccess> <OrderModel> <FlowID>流水号</FlowID> <OrderID>订单号</OrderID> <SellCompanyID>卖家企业编号</SellCompanyID> <BuyCompanyID>买家企业编号</BuyCompanyID> <ReceiverPhone>乘

63、客联系人电话</ReceiverPhone /> <CompanyID>>买家企业编号</CompanyID> <MemberID>买家操作员编号</MemberID> <ReceiverName>乘客联系人姓名</ReceiverName> <TotalFee>订单总金额</TotalFee> <DiscountFee>优惠金额</DiscountFee> <Payment>已支付金额（如果订单来自接口，该值为0）</Payment>

64、; <ReceiverAddress>乘客联系人地址</ReceiverAddress> <ShipID>游轮编号</ShipID> <FlightsID>航班编号</FlightsID> <Title>标题</Title> <Body>内容</Body> <Extend>扩展信息如(;BookingNumber:1)标识预定人数1人</Extend> <BuyerMemo >买家备注</BuyerMemo > <ReceiverMobile>乘客联系人手机号码</ReceiverMobile> <SellerMemo>卖家备注</SellerMemo> <ReceiverEmail>乘客联系人信箱</ReceiverEmail> <Status>订单状态，请参考订单状态枚举表</Status> <ConfirmDateTime xsi:nil="true" /> <LastPaymentDateTime xsi:nil="tr