Content Comparison

OTA_ResRetrieveRS

1

Main element

@EchoToken

1

Return the EchoToken from the request message

@Version

1

Current Version 1

@TimeStamp

1

Time of the transaction in xml schema dateTime format

OTA_ResRetrieveRS / Success

0 - 1

Should only be present if the request processed successfully. The Errors node will not be present if the Success node is present

OTA_ResRetrieveRS / Errors

0 - 1

Contains a list of errors if the request failed to process

Errors / Error

1 - n

Should be at least one node if there is an Errors Node

@Type

1

Mandatory if Error present.
Any type from the OTA code table for 'Error Warning Type (EWT)' can be used

@Code

0 - 1

Any code from the OTA code table for 'Error Codes (ERR)' can be used

OTA_ResRetrieveRS / ReservationsList

0 - 1

ReservationList is only present if there are HotelReservation elements

ReservationsList / HotelReservation

1 - n

List of reservations

@CreateDateTime

1

This is the date when the reservation was first made. Mandatory if ResStatus is "Book

@LastModifyDateTime

0 - 1

This indicates the last date and time when the reservation was last modified. Mandatory if ResStatus is "Modify" or "Cancel"

@ResStatus

1

Status is "Book", "Modify" or "Cancel"

HotelReservation / UniqueID

2

The reservation reference in ChannelManager.

The first UniqueID element will contain the unique identifier for the entire reservation. This identifier will identify the reservation through any subsequent modifications or cancellations.

The second UniqueID element with ID_Context="MESSAGE_UNIQUE_ID" is the unique id for this message. This identifier should be used to confirm the message once processed

@Type

1

Value '14' is the unique id for the reservation in ChannelManager. Value '16' is the unique id for the message transferring the reservation.

@ID

1

Identifier of the reservation according to ChannelManager. Note, this is NOT the reservation id according to the upstream system. This is located in the HotelReservationID element.

@ID_Context

0 - 1

Only present for the second UniqueID element and when present it will always be "MESSAGE_UNIQUE_ID"

HotelReservation / POS

1

Point of sale

POS / Source

1

Source of the reservation

Source / RequestorID

1

This identifies the system which is sending the reservation. This element will only appear in the first Source element.

@Type

1

Fixed at 22 (ESRP)

@ID

1

Value is your ChannelManager Name

Source / BookingChannel

1

Contains booking channel information

@Primary

1

Indicates the primary booking source

@Type

1

Always '7' for 'Internet'.

BookingChannel / CompanyName

1

Name of the Booking Channel.

@Code

1

Channel Manager code to identify the Booking Channel.

HotelReservation / RoomStays / RoomStay

0 - n

One instance of RoomStay per room booked.
A RoomStay element will always exist if ResStatus is "Book" or "Modify".
If ResStatus is "Cancel" it is possible that no RoomStay element exists. 

See RoomStay

Reservation / ResGuests / ResGuest

0 - n

One instance of ResGuest per reservation guests. This guest information is dependent on the sometimes limited information retrieved from the booking agents. ResGuests might not always be directly linkable to the RoomStays. Either all ResGuests are linked to RoomStays or none are.

See ResGuest

HotelReservation / Services / Service

0 - n

A list of service fees and extra charges linked to the HotelReservation

See Service

HotelReservation / ResGlobalInfo

1

Contains general information about the Reservation

See ResGlobalInfo

@ResGuestRPH

0 - 1

This value links the ResGuest to RoomStay(s) where possible. You can find the links in RoomStay / ResGuestRPHs. 

@ArrivalTime

0..1

The arrival time of the guest in the form HH:mm:ss.

@PrimaryIndicator

0..1

When true indicates this is the primary guest

ResGuest / Profiles

1

Contains the guest profile information

See Profiles

ResGuest / Comments / Comment

0 - 1

Container for extra information about the guest

@Name

0 - 1

Identifier for the comment

Comment / Text

1

Text for the guest extra information

HotelReservationIDs / HotelReservationID

1

Reference number/string or PNR as supplied by the Booking agent will be supplied here

@ResID_Type

1

Always ‘14’
14: OTA code for 'Travel Agent PNR'. If this type is used the @ResID_Value will be the reservation identifier as provided by the source booking channel.

@ResID_Value

1

Reference number/string supplied by the Booking agent

Total

0 - 1

The total amount for the Reservation. Will add up to the sum of the RoomStay totals PLUS any additional fees sent by the BookingAgent.

@CurrencyCode

0 - 1

The ISO currency code for the total

@AmountAfterTax

0 - 1

The total amount after tax

@AmountBeforeTax

0 - 1

The total amount before tax

Profiles

0 - 1

This is a listing of Profiles associated with the reservation that are not Guests. This includes Customers, Travel Agents and Travel Arrangers. The Customer is the contact person for the Reservation. If the customer is also a guest, they will also be included in the ResGuest profile.

See Profile

DepositPayments

0 - 1

Contains the deposit information

DepositPayments / GuaranteePayment / AmountPercent

1

@Amount

0 - 1

The deposit as a currency amount. At least @Amount or @Percent will be populated.

@CurrencyCode

0 - 1

This is the ISO currency code of the deposit. Mandatory if @Amount exists.

@Percent

0 - 1

This is the percentage of the Total charge for the deposit (rounded to 3 decimal places). If the the Total.amountAfterTax is provided, it will be a percentage of this value. If only the amountBeforeTax is provided it will be the percentage of this value. At least @Amount or @Percent will be populated.

@TaxInclusive

0 - 1

Indicates if tax is included in @Amount

Guarantee

0 - 1

Guarantee information

Guarantee / GuaranteesAccepted / GuaranteeAccepted / PaymentCard

0 - 1

Contains payment card information

@CardCode

0..1

The 2 character code of the credit card issuer. Please see the OTA Payment Card Provider Codes table for reference

@CardType

0 - 1

The type of payment card, refer to the OTA Card Type code table for reference. Common usages are:

1: Credit
2: Debit

@CardNumber

0 - 1

The number embossed on the payment card

@ExpireDate

0 - 1

This is the expiry date of the payment card used in the format MMyy

PaymentCard / CardHolderName

0 - 1

This is the name of the card holder.