统一请求类型定义OperateType

所有类型定义已此为准,后续随时业务的增加类型会增加,请求xml结构也会增加或者修改


1.更新请求类型 

  • 0: 基本信息更新
  • 1: 预约开发票请求
  • 2: 在线退房请求
  • 3: 在线选房请求
  • 4: 自助checkIn请求 (new)
  • 13:扫脸入住身份信息请求 (new)
  • 27: 自助checkIn确认请求 (new)
  • 101 通用指令
  • 103 撤销请求操作

    
2.查询请求类型 

  • 10 房态信息查询请求

3.商家pms信息上传 (通过开放平台的put接口)

  • 21 商家推送订单状态变更 (支持订单基本状态的上传(订单确认有房、订单确认无房、订单已取消、入住、离店、Noshow)
  • 23 酒店房态信息上传(上传一段时间内的酒店房态) 支持酒店房态信息上传(主要用于用户自助选房)
  • 24 对于用户自助退房请求进行确认
  • 25 在线开发票请求确认
  • 26 自助选房请求进行请求确认
  • 27 自助checkIn请求进行请求确认
  • 24 对于用户自助退房请求进行确认
  • 31 酒店房间详情上传(上传酒店的图片、描述等基本信息)


4 PMS指令类请求-通用指令类请求(包括通用请求的下传,通用请求的上传,与action配合实现想要表达的意图,内容写入请求上下文)

  • 101 通用指令类请求


5 通用请求确认(Put接口使用,对任务请求进行结果确认)

  • 102 通用请求确认

6 通用任务取消指令(当接到该指令时候,取消已接收的任务信息)

  • 103 通用任务取消指令请求


7 通用PMS结果查询请求(用于飞猪平台主动查询Pms任务的处理结果)

  • 104 通用PMS结果查询请求


8 仅供top.get接口使用,用于pms获取所有类型的请求,以减少分类查询的交互次数。

  • 105 获取所有类型的请求

1、订单信息上传更新put接口context详细介绍(类型已OperateType定义为准)


xml格式的数据上下文(类型定义参考@see com.taobao.trip.htq.client.constant.OperateTypeEnum)
1:订单状态更新
      <OrderInfo>
           <Order>
               <tid>12222</tid>
               <OutOrderId>r23323323</OutOrderId>
               <HotelCode>酒店编码</HotelCode>
               <Status>

                    1:订单已确认;

                    2:订单不确认;

                    4:已取消;

                    5:已入住;

                    6:订单已关闭;

                    7:订单已删除;

                    8:noshow;

                   9:离店 (其余状态都不需要上报)

               </Status>
           </Order>
           .....

      </OrderInfo>
      
2:水单信息上传
     <OrderInfo>
         <Order>
             <RequestID>请求唯一标识</RequestID>
             <tid>12222</tid>
             <OutOrderId>r23323323</OutOrderId>
             <HotelCode>酒店编码</HotelCode>
             <RoomNo>房间号</RoomNo>
             <TotalFee>总费用</TotalFee>
             <Price>房费</Price>
             <OtherFee>杂费</OtherFee>
             <Remark>备注</Remark>
             <DailyPrice><!--每日房费列表-->
                     <DailyPriceItem>
                         <Date>日期(格式 yyyy-MM-dd)</Date>
                         <Price>每日金额</Price>
                     </DailyPriceItem>
                     .
                     .
                     .

             </DailyPrice>
             <OtherFeeDetail><!--杂费明细列表-->
                     <OtherFeeItem>
                         <Name>杂费名称</Name>
                         <Price>杂费金额</Price>
                     </OtherFeeItem>
                     .
                     .
                     .

             </OtherFeeDetail>
         </Order>
         .
         .
         .
     </OrderInfo>
      
3:酒店房态信息上传

        <!—此老协议格式废弃,参见下边新格式定义-->
     <!--采用新的选房格式-->
     <RoomInfo>
         <Room>

            <RequestID>查询请求的ID(如果是主动上传房态此值为空)</RequestID>
             <HotelCode>外部酒店编码</HotelCode>
             <RoomTypeID>外部房型ID</RoomTypeID>
             <DailyInfo>
             <Day>
                 <AvailableDate>预订日期(格式:2016-03-15)</AvailableDate>
                 <BuildingList>
                     <Building><!—可有多栋楼-->
                         <BuildingNum>楼号</BuildingNum>
                         <FloorList><!—每栋楼多层楼-->
                             <Floor>
                                 <FloorNum>楼层</FloorNum>
                                 <RoomUnitList><!—每层楼有多个实体房间-->
                                     <RoomUnit>
                                         <RoomStatus>房间可预订状态(0:不可选;1可选)</RoomStatus>
                                         <RoomNum>房间号</ RoomNum>
                                     </RoomUnit>
                                     .
                                     .
                                     .
                                 </RoomUnitList>
                             </Floor>
                             .
                             .
                             .
                         </FloorList>
                     </Building>
                     .
                     .
                     .
                 </BuildingList>
             </Day>
             .
             .
             .
             </DailyInfo>
         </Room>
         .
         .
         .
     </RoomInfo>

4:对于用户自助退房请求进行确认
      <OrderInfo>
          <Order>
              <RequestID>请求唯一标识</RequestID>
              <tid>12222</tid>
              <OutOrderId>r23323323</OutOrderId>
              <HotelCode>酒店编码</HotelCode>
              <Status>0:退房成功;1:退房失败</Status>
              <Message>不支持退房</Message>
          </Order>
          .
          .
          .
      </OrderInfo>


5:在线开发票请求确认
      <OrderInfo>
          <Order>
              <RequestID>请求唯一标识</RequestID>
              <tid>12222</tid>
              <OutOrderId>r23323323</OutOrderId>
              <HotelCode>酒店编码</HotelCode>
              <Status>0:开发票请求受理成功;1:失败; 2:请求已受理;3:发票已经开好</Status>
              <Message>失败原因</Message>
          </Order>
          .
          .
          .
      </OrderInfo>

 

 6:自助选房请求进行请求确认

      <OrderInfo>
         <Order>
              <RequestID>请求唯一标识</RequestID>
              <tid>12222</tid>
              <OutOrderId>r23323323</OutOrderId>
              <HotelCode>酒店编码</HotelCode>
              <Status>0:选房成功;1:选房失败</Status>
              <Message>失败原因</Message>
          </Order>
          .
          .
          .
      </OrderInfo>
      

7:用户身份信息回传
      <OrderInfo>
          <Order>
              <RequestID>请求唯一标识</RequestID>
              <tid>12222</tid>
              <OutOrderId>r23323323</OutOrderId>
              <PmsId>pmsId</PmsId>
              <HotelCode>酒店编码</HotelCode>
              <RoomNo>房间号(多间房用“|”连接)</RoomNo>
              <Guests>
                  <Guest>
                      <IsMain>是否主住人 0:否;1:是</IsMain>
                      <Name>客人姓名</Name>
                      <IdNumber>身份证号码</IdNumber>
                      <Phone>手机号</Phone>
                      <IdType>证件类型</IdType>
                      <EncryptType>加密类型</EncryptType>
                  </Guest>
              </Guests>
          </Order>
          .
          .
          .
      </OrderInfo>

 

13:自助入住信息回传
      <OrderInfo>
          <Order>
              <RequestID>请求唯一标识</RequestID>
              <tid>12222</tid>
              <OutOrderId>r23323323</OutOrderId>
              <HotelCode>酒店编码</HotelCode>
              <RoomNo>房间号(多间房用“|”连接)</RoomNo>
              <RoomCardAttribute>
                   <RoomNum>101</RoomNum>
                   <InvalidTime>2016-01-23T09:14:42+08:00</InvalidTime>
                   <CardType>门卡</CardType>
                   <Floor>2层</Floor>
                   <BuildingNum>一幢</BuildingNum>
                   <LockNum>NO123456</LockNum>
               </RoomCardAttribute>
          </Order>
          .
          .
          .
      </OrderInfo>
      
30、请求认领(酒店前台人员任务的领取)
       <OrderInfo>
          <Order>
              <RequestID>请求唯一标识</RequestID>
              <HotelCode>酒店编码</HotelCode>
              <ProcessName>认领人员姓名(一般是酒店前台人员姓名)</ProcessName>
          </Order>
          .
          .
          .
      </OrderInfo>
      

102、通用请求确认(Put接口使用,对任务请求进行结果确认)
<OrderInfo>

     <Order>
         <RequestID>请求唯一标识</RequestID>
         <HotelCode>酒店编码</HotelCode>
         <ProcessName>确认人员姓名(一般是酒店前台人员姓名,如果PMS自动处理则写“PMS”)</ProcessName>
         <Status>0:成功;1:失败(处理失败、拒绝处理等)</Status>
         <Message>失败原因</Message>
    </Order>
     .
     .
     .

</OrderInfo>

 

31:酒店房间详情上传(上传酒店的图片、描述等基本信息)
<RoomDetail>
     <Room>
         <RequestID>请求唯一标识</RequestID>
         <HotelCode>酒店编码</HotelCode>
         <Vendor>给商家分配的vendor,具体咨询阿里技术</Vendor>
        <BuildingNum>楼号</BuildingNum>
        <FloorNum>楼层</FloorNum>
        <RoomNum>房间号</RoomNum>
        <RoomTypeID>商家房型</RoomTypeID>
        <Window>(0:无窗;1:有窗)</Window>
        <Smoking>(0:无烟;1:有烟)</Smoking>
        <Area>房间面积</Area>
        <Description>房间描述(比如,靠海,马路边)</Description>
         <Pics> 图片路径,图片下载url网址(多张图片用英文分号‘;’隔开)</Pics>
   </Room>
    .
    .
    .
</RoomDetail>

 

2、get(请求数据查询接口)context描述(类型已OperateType定义为准)


 xml格式的请求上下文,不同的bizType,格式不同。具体请参见对应文档描述
 当bizType=1,在线开发票请求

<Invoice><!—发票信息-->

    <InvoiceType>发票类型(1:普通发票;2:增值税专用发票)</InvoiceType>

    <InvoiceTitle>阿里巴巴集团</InvoiceTitle>

    <TaxpayerID>纳税人识别号:纳税人识别号,一律由15位、18或者20位码(字符型)组成。</TaxpayerID>

    <RegAddress>公司注册地址:抬头公司注册地址</RegAddress>

    <CompanyTel>公司电话:抬头公司电话,区号-电话号码</CompanyTel>

     <BankName>开户行: 抬头公司银行开户行名称</BankName>

     <BankAccount>银行账户:抬头公司银行账号</BankAccount>

     <PostType>0</ PostType>

     <EarlyPrepare>0</EarlyPrepare>

     <ReceiverName>张三</ReceiverName>

     <ReceiverMobile>13601083188</ReceiverMobile>

     <ReceiverAddress> 北京国家广告产业园B座</ReceiverAddress>

     <Provider>1</Provider>

     <Payer>1</Payer>

     <WantTime>需要发票时间(格式yyyy-MM-dd HH:mm:ss)</WantTime>

     <Comment>备注信息</Comment>

</ Invoice>



  当bizType=2,自助退房请求
 <CheckOutInfo><!—退房信息-->
     <ActionTime>想要退房时间 2016-03-10 14:58:00</ActionTime>
     <NeedInvoice>0:不需要开发票;1:需要开发票</NeedInvoice>
 </CheckOutInfo>

  当bizType=3,自助选房请求
 <RoomSelect><!—在线选房信息-->
     <Type>1:选房操作;2: 取消选房;3: 变更选房</Type>
     <RoomTypeID>订单绑定外部房型ID</RoomTypeID>
     <BuildingNum>楼号</BuildingNum>
     <Floor>楼层</Floor>
     <RoomNum>所选房间号(如果订单为多间房,则所选房号以字符“|”分隔。例:“8208:8205”)</ RoomNum>
     <OldRoomNum>原始房间号(变更选房时候有效)</OldRoomNum>
 </RoomSelect>


6:自助开门(用户在线利用手机app自助操作开酒店房门)(未上线)
       此指令-context没有值。主要根据tid、outOrderId\hotelCode等为入参条件。结果确认请选用通用请求确认(102)。
7:房间断电(用户在线利用手机app自助房间断电)(未上线)
       此指令-context没有值。主要根据tid、outOrderId\hotelCode等为入参条件。结果确认请选用通用请求确认(102)。
8:自助乘梯(用户在线利用手机app自助乘梯)(未上线)
       此指令-context没有值。主要根据tid、outOrderId\hotelCode等为入参条件。结果确认请选用通用请求确认(102)。 

103: 通用任务取消指令(当接到该指令时候,取消已接收的任务信息)
   通用任务取消指令-context没有值。主要根据ReqeustID\hotelCode为条件进行取消

 

10 :房态信息查询请求( 查询可选房)
    房态信息查询请求context没有值,按照tid\outOrderId\sellerId\hotelCode为查询请求条件,返回格式参见put接口定义

12:查询水单请求 (未上线)
    查询水单context没有值,按照tid\outOrderId\sellerId\hotelCode为查询请求条件,返回格式参见put接口定义 

104:通用PMS结果查询请求(用于阿里平台主动查询Pms任务的处理结果)
   通用PMS结果查询请求context没有值,按照ReqeustID\hotelCode为查询请求条件,返回格式参见put接口定义

 

 

3、部分字段类型定义(字典列表)

对于以上xml中部分字段的定义,请查询以下列表。

名称

类型

是否必需

最大长度

描述

示例值

UpdateRQ

复合类型

 

请求协议体

 

Username

String

100

第三方系统接口调用需要校验时的用户名。

Taobao

Password

String

100

第三方系统接口调用需要校验时的密码

1234

CreateToken

String

255

单次请求的token

Taoao333333333333

TaoBaoOrderId

Long

32

淘宝订单号

1387784033263

OrderId

String

32

外部订单号

R333333

RequestID

String

64

请求唯一标识,此值需要在结果中返回

taobao1387784033263

HotelCode

String

64

外部酒店编码

h00007654

OperateType

int

10

本次更新的操作类型,此值必须传入,默认0,更新基本信息。

操作类型,

 0:更新联系人、备注、入住人时间等基本信息;

 1:更新发票信息;

 2:用户在线请求退房;

 3:用户进行在线选房

 4:自助办理入住(new)

 13:扫脸入住(new)

 101:通用指令类请求(与action配合实现想要表达的意图,内容写入请求上下文)OperateTypeEnum文件定义

1

Action

int

10

* PMS处理消息的动作

0:普通,不需要特殊动作

1:弹窗提示(Pms中央模态窗)

2:托盘信息提示(给酒店广播通知或者平台公告)

3:发送请求给酒店前台人员,前台人员需要看到后确认处理(比如督促前台结账、督促前台上报入住状态)

4:请求pms自动处理(自动发起结账,自动上报订单状态等)

0

EarliestArriveTime

String

32

最早到店时间

2106-03-03 12:00:00

LatestArriveTime

String

32

最晚到店时间

2106-03-03 12:00:00

ContactName

String

32

联系人

张三

ContactTel

String

32

联系电话

13301083144

ContactEmail

String

32

联系人邮箱

qz@javatop.top

Comment

String

32

备注

喜欢暗色调房间

GuaranteeType

Int

10

担保类型

1

OrderGuests/ OrderGuest

 

 

入住人列表

 

Name

String

10

姓名

王老五

RoomPos

String

10

房间号

1009

Invoice

复合类型

 

发票协议对象,父亲节点定义

此节点是可选节点

InvoiceTitle

String

50

发票抬头

阿里巴巴集团

PostType

int

10

发票领取方式 

0:前台自取

1:邮寄

2:电子发票

3:送至房间

0

EarlyPrepare

int

10

发票是否需要提前准备

0:不提前开发票

1: 需要提前开好发票)

0

ReceiverName

String

10

收件人姓名

张三

ReceiverMobile

String

50

收件人手机号

1380987653

ReceiverAddress

String

100

收件地址

北京国家广告产业园B座

Provider

Int

10

发票提供方(发票由谁来提供)

1:酒店前台

2: 商家提供

3:去啊平台提供

1

一般由前台提供

Payer

Int

10

邮费支付方

邮费承担方

1:酒店承担

2:商家承担

3:去啊平台承担

4:客户自己承担

CheckOutInfo

 

 

退房信息

 

ActionTime

String

32

想要退房时间

2106-03-03 12:00:00

NeedInvoice

Int

10

是否需要开发票

0:不需要开发票;1:需要开发票

RoomSelect

 

 

在线选房信息

 

Type

Int

10

1:选房操作;

2: 取消选房;

3: 变更选房

1

RoomTypeID

String

10

订单绑定外部房型ID

1009

BuildingNum

String

10

楼号

1009

Floor

String

10

楼层

2

RoomNum

String

10

所选房间号(如果订单为多间房,则所选房号以字符“|”分隔。例:“8208:8205”)

1

OldRoomNum

String

10

原始房号

333

Status

Int

10

请求的处理状态

0:新建

1:请求已经被读取过

2:请求已经被认领

3:请求已经反馈

4:处理完成

5:请求失效

1

DisplayText

String

否他

512

给酒店前台的文案展示

用户张三需要提前准备发票

Extensions

String

512

扩展字符串json格式

 

 

 

FAQ

关于此文档暂时还没有FAQ
返回
顶部