OTA_ReadRQ

The OTA_ReadRQ message is used to retrieve reservations from the channel manager. The message distinguishes to different scenarios.

Example 1: "Undelivered"

<?xml version="1.0" encoding="utf-8"?>
<OTA_ReadRQ EchoToken="Example123" PrimaryLangID="eng" Target="Production" TimeStamp="2018-07-29T07:38:54.729Z" Version="1.0">
  <POS>
    <Source>
      <RequestorID ID="APIKEY" MessagePassword="APIPASSWORD"/>
    </Source>
  </POS>
  <ReadRequests>
    <HotelReadRequest HotelCode="12345">
      <SelectionCriteria SelectionType="Undelivered" />
    </HotelReadRequest>
  </ReadRequests>
</OTA_ReadRQ>

Example 2: "Creation date/All"

<OTA_ReadRQ EchoToken="Example123" PrimaryLangID="eng" Target="Production" TimeStamp="2018-07-29T07:38:54.729Z" Version="1.0">
  <POS>
    <Source>
      <RequestorID ID="APIKEY" MessagePassword="APIPASSWORD"/>
    </Source>
  </POS>
  <ReadRequests>
    <HotelReadRequest HotelCode="12345">
      <SelectionCriteria Start="2018-08-12" End="2018-08-14" DateType="CreateDate" SelectionType="All" />
    </HotelReadRequest>
  </ReadRequests>
</OTA_ReadRQ>

Example 3: "Last update date/Cancel"

<OTA_ReadRQ EchoToken="Example123" PrimaryLangID="eng" Target="Production" TimeStamp="2018-07-29T07:38:54.729Z" Version="1.0">
  <POS>
    <Source>
      <RequestorID ID="APIKEY" MessagePassword="APIPASSWORD"/>
    </Source>
  </POS>
  <ReadRequests>
    <HotelReadRequest HotelCode="12345">
      <SelectionCriteria Start="2018-08-12" End="2018-08-14" DateType="LastUpdateDate" ResStatus="Cancel" />
    </HotelReadRequest>
  </ReadRequests>
</OTA_ReadRQ>

Example 4: "Send actual room IDs, instead of virtual room IDs"

<OTA_ReadRQ EchoToken="Example123" PrimaryLangID="eng" Target="Production" TimeStamp="2018-07-29T07:38:54.729Z" Version="1.0">
  <POS>
    <Source>
      <RequestorID ID="APIKEY" MessagePassword="APIPASSWORD" />
    </Source>
  </POS>
  <ReadRequests>
    <HotelReadRequest HotelCode="12345">
      <SelectionCriteria SelectionType="Undelivered" />
      <TPA_Extensions>
        <UseActualRoomIds>false</UseActualRoomIds>
      </TPA_Extensions>
    </HotelReadRequest>
  </ReadRequests>
</OTA_ReadRQ>

Element / @Attribute	Parent	Info	Values	Occurrence
ReadRequests	OTA_ReadRQ	A grouping of Read Requests.		1
HotelReadRequest	ReadRequests	To retrieve a hotel reservation when the booking reference is not known.		0..n
@HotelCode	ReadRequests	The ID of the hotel.	[integer]	1
SelectionCriteria	HotelReadRequest	The criteria to select the reservations by. Deviating from OTA standard, a HotelReadRequest element can contain only one SelectionCriteria element		1
@Start	SelectionCriteria	The starting value of the time span.	[yyyy-MM-dd]	0..1
@End	SelectionCriteria	The ending value of the time span.	[yyyy-MM-dd]	0..1
@DateType	SelectionCriteria	Specifies the type of date provided in the date time span attributes.	`ArrivalDate` `DepartureDate` `CreateDate` `LastUpdateDate`	0..1
@SelectionType	SelectionCriteria	Indicates which reservations should be selected based on delivery status.	`All` `PreviouslyDelivered` `Undelivered`	0..1
@ResStatus	SelectionCriteria	Specifies the status of the reservations to be delivered.	`Book` `Cancel` `Modify`	0..1
TPA_Extensions	HotelReadRequest	A placeholder in the schema to allow for additional elements and attributes to be included. Allows extensions to be added to the OpenTravel specification.		1
UseActualRoomIds	TPA_Extensions	Specifies whether the room IDs used in the reservation should be the booked rooms regardless of the room type (base or virtual) or if the ID of the base room should always be returned.	`true` `false` (default)	0..1
ReservationRetrievalPropertyType	TPA_Extensions	Specifies whether the bookings from only the requested property, virtual property, or both should be picked up.	`RequestedPropertyOnly` `ConnectedVirtualPropertiesOnly` `RequestedPropertyAndConnectedVirtualProperties`	0..1

Unless the selection criteria attribute with a value of Undelivered is used, the DateType, Start and End attributes are required.

When using the DateType, Start and End attributes to indicate a time span, a maximum date range of one (1) week is allowed.