OTA_CancelRQ

1 Overview
2 Request
- 2.1 Sample
3 Response
- 3.1 Sample

Overview

The OTA_CancelRQ messaged is used to indicate to a third party system that all previously transmitted room reservations for a transaction are to be cancelled.

Request

Element / @Attribute	Quantity	Type	Description
OTA_CancelRQ	1		Root element
@TimeStamp	0..1	DateTime	ISO 8601 encoded timestamp indicating the creation date and time of the message
@EchoToken	0..1	String	A reference for additional message identification, assigned by the requesting host system
@Version	0..1	Decimal	The OpenTravel message version indicated by a decimal value
@CancelType	1	String	Specifies the type of action requested
UniqueID	0..1		The unique identifier element allows the trading partners to uniquely identify each Rate being uploaded
@Type	1	Integer	A reference to the type of object defined by the UniqueID element.
@ID	1	String	A unique identifying value assigned by the creating system
@ID_Context	0..1	String	Used to identify the source of the identifier
Verification	0..1		This is to be used for verification that the record being canceled is the specific record requested
PersonName	0..1		Detailed name information for the customer
GivenName	0..1	String	Given name, first name or names
SurName	1	String	Family name, last name
NamePrefix	0..1	StringvSalutation or honorific
Telephone	0..1		Information on a telephone number for the customer
@FormattedInd	0..1	Boolean	Specifies if the associated data is formatted or not
@PhoneTechType	1	Integer	Indicates type of technology associated with this telephone number
@PhoneNumber	1	String	Telephone number assigned to a single location
Email	0..1	String	Information on an email address for the customer
AddressInfo	0..1		Detailed information on an address for the customer
AddressLine	0..1	String	Main line of address
CityName	0..1	String	Address city
StateProv	0..1	String	Adress State or Province
CountryName	0..1	String	Address Country
TPA_Extensions	0..1		A placeholder in the schema to allow for additional elements and attributes to be included per Trading Partner Agreement
BasicPropertyInfo	0..1		Property Information for the Room Stay
@HotelCode	1	String	The code that uniquely identifies a single hotel property
@HotelName	0..1	String	A text field used to communicate the proper name of the hotel
CreatorID	0..1	String	Identifies the creator of the cancel message

Sample

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.opentravel.org/OTA/2003/05" xmlns:oas="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
   <soapenv:Header>
      <HTNGHeader xmlns="http://htng.org/1.1/Header/">
         <From>
            <systemId>Avvio</systemId>
            <Credential>
               <userName>username</userName>
               <password>password</password>
            </Credential>
         </From>
         <To>
            <systemId>46</systemId>
         </To>
         <timeStamp>2024-05-30T10:36:38+00:00</timeStamp>
         <echoToken>GL-tlZYZiPnij4Z7AAA1n4=</echoToken>
         <transactionId />
         <action />
      </HTNGHeader>
   </soapenv:Header>
   <soapenv:Body>
      <OTA_CancelRQ xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Version="4" CancelType="Cancel" EchoToken="tlZYZiPnij4Z7AAA1n4=" TimeStamp="2024-05-30T10:36:38+00:00">
         <UniqueID Type="14" ID="3QFNLAV" ID_Context="CrsConfirmNumber" />
         <Verification>
            <PersonName>
               <NamePrefix>Mr</NamePrefix>
               <GivenName>Martin</GivenName>
               <Surname>Mahony</Surname>
            </PersonName>
            <Email>martin.mahony@shrgroup.com</Email>
            <TelephoneInfo FormattedInd="false" PhoneTechType="1" PhoneNumber="+353 61335680" />
            <AddressInfo>
               <AddressLine>Avvio House, Lonsdale Road National Technology Park</AddressLine>
               <CityName>Castletroy</CityName>
               <PostalCode>V94 AW2X</PostalCode>
               <StateProv>Limerick</StateProv>
               <CountryName>IE</CountryName>
            </AddressInfo>
         </Verification>
         <TPA_Extensions>
            <BasicPropertyInfo HotelCode="1853" HotelName="TestHotel Mahony" />
         </TPA_Extensions>
      </OTA_CancelRQ>
   </soapenv:Body>
</soapenv:Envelope>

Response

Element / @Attribute	Quantity	Type	Description
OTA_CancelRS	1		Root element
@TimeStamp	0..1	DateTime	ISO 8601 encoded timestamp indicating the creation date and time of the message
@EchoToken	0..1	String	A reference for additional message identification, assigned by the requesting host system
@Version	0..1	Decimal	The OpenTravel message version indicated by a decimal value
@ResResponseType	0..1	String	An enumerated attribute that contains the status of the processing of the requested hotel reservations
Success	0..1		Indicates that the incoming request message was processed successfully
Errors	0..1		A collection of errors that occurred during the processing of a message
Warnings	0..1		A collection of warning that occurred during the processing of a message
HotelReservation	1		Contains a hotel reservation
ResGlobalInfo	0..1		ResGlobalInfo is a container for various information that affects the Reservation as a whole
HotelReservationIDs	0..1		A Collection of HotelReservationID objects for a given reservation
HotelReservationID	1		The HotelReservationID object contains various unique (ReservationID) and non unique (ConfirmationID, CancellationID) identifiers that the trading partners associate with a given reservation.
@ResID_Type	1	Integer	Defines the type of Reservation
@ResID_Value	1	String	This is the actual value associated with ResID_Type.
POS	0..1		Identifies who made the original reservation

Sample

<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <OTA_CancelRS xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Version="1.003" EchoToken="" TimeStamp="2019-11-12T09:50:24:755" ResResponseType="Cancelled">
         <Success />
         <HotelReservations>
            <HotelReservation>
               <ResGlobalInfo>
                  <HotelReservationIDs>
                     <HotelReservationID ResID_Type="14" ResID_Value="3QFNLAV" />
                  </HotelReservationIDs>
               </ResGlobalInfo>
            </HotelReservation>
         </HotelReservations>
         <POS />
      </OTA_CancelRS>
   </soap:Body>
</soap:Envelope>