OTA_ReadRQ / OTA_HotelResNotifRQ or OTA_ResRetrieveRS

OTA_ReadRQ / OTA_HotelResNotifRQ or OTA_ResRetrieveRS

a

The OTA_ReadRQ messages are used to request the following elements in the Hotel-Spider system:

  • New reservations

  • Modified reservations

  • Cancelled reservations

 

Prior to retrieving reservations/modifications/cancellations from the Hotel-Spider servers, the room types and rate plans need to be mapped. For this purpose, a third party software provider can use either the OTA_HotelRoomListRQ/OTA_HotelRoomListRS pair or the combination of the OTA_HotelDescriptiveInfoRQ/OTA_HotelDescriptiveInfoRS and OTA_HotelRatePlanRQ/OTA_HotelRatePlanRS request pairs.

 

Response format

Depending on the preferences of the third party software provider, the Hotel-Spider system will either reply to an OTA_ReadRQ with an OTA_HotelResNotifRQ (asynchronous usage) or with an OTA_ResRetrieveRS response.  By default, our system will reply with the OTA_HotelResNotifRQ format. For other formats, please contact us.

Confirming successful import

Disregarding which response format the Hotel-Spider system will return the third party software client needs to confirm every reservation/modification/cancellation it has imported via an OTA_HotelResNotifRS / OTA_HotelResNotifRS or an OTA_NotifReportRQ / OTA_NotifReportS call.

Reservation are automatically flagged as exported after 5 reads

After any reservation has been returned 5 times (with SelectionType set to Undelivered) it will be marked as exported, and thus will not be returned in the subsequent responses to OTA_ReadRQ requests.

Credit-card information specifics

If your system is PCI-DSS compliant and you are using the secure endpoints, please be aware that credit-card number is returned in clear text in response to the first read request only

The next responses will contain only the masked card number.

Regarding the CVC code, please be aware that it can be exported only one time, either on the extranet or through the API. If the CVC code as been shown in the extranet, it will be be present in the response.

Endpoints

Example request and response

OTA_ReadRQ request
<OTA_ReadRQ xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.opentravel.org/OTA/2003/05 OTA_ReadRQ.xsd" TimeStamp="2018-03-17T09:30:47-05:00" Target="Test" Version="2.0"> <POS> <Source> <RequestorID ID="USERNAME" MessagePassword="PASSWORD" /> </Source> </POS> <UniqueID Type="14" ID="" /> <ReadRequests> <HotelReadRequest HotelCode="" HotelName=""> <SelectionCriteria SelectionType="Undelivered" DateType="" Start="" End="" /> </HotelReadRequest> </ReadRequests> </OTA_ReadRQ>
OTA_HotelReservationNotifRQ response
<OTA_HotelResNotifRQ Target="Production" TimeStamp="2011-08-01T14:47:59" Version="2.0" PrimaryLangID="en" xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.opentravel.org/OTA/2003/05 OTA_HotelResNotifRQ.xsd"> <Success /> <HotelReservations> <HotelReservation ResStatus="Book" ForcedSellIndicator="0" OriginalDeliveryMethodCode="11" RoomStayReservation="1" WalkInIndicator="0" CreateDateTime="2015-10-29T17:06:02+01:00" LastModifyDateTime="2015-10-29T17:06:03+01:00"> <POS> <Source> <RequestorID ID="0" Type="22"/> <BookingChannel Type="5"> <CompanyName>Hotel-Spider</CompanyName> </BookingChannel> </Source> </POS> <RoomStays> <RoomStay IndexNumber="1" RoomStayStatus="Book"> <RoomTypes> <RoomType RoomID="00F55f80d7db845a" IsRoom="1"> <RoomDescription Name="Single room standard"/> </RoomType> </RoomTypes> <RatePlans> <RatePlan RatePlanID="00P561b590116e60"> <MealsIncluded MealPlanIndicator="1" MealPlanCodes="4.MPT"/> </RatePlan> </RatePlans> <RoomRates> <RoomRate EffectiveDate="2015-09-16" ExpireDate="2015-09-19" RatePlanID="00F55f80f515c377"> <Rates> <Rate EffectiveDate="2015-09-16" ExpireDate="2015-09-16"> <Base CurrencyCode="EUR" AmountBeforeTax="0.00" AmountAfterTax="160.00" DecimalPlaces="2" /> <Total CurrencyCode="EUR" AmountBeforeTax="0.00" AmountAfterTax="160.00" DecimalPlaces="2" /> </Rate> <Rate EffectiveDate="2015-09-17" ExpireDate="2015-09-17"> <Base CurrencyCode="EUR" AmountBeforeTax="0.00" AmountAfterTax="160.00" DecimalPlaces="2" /> <Total CurrencyCode="EUR" AmountBeforeTax="0.00" AmountAfterTax="160.00" DecimalPlaces="2" /> </Rate> <Rate EffectiveDate="2015-09-18" ExpireDate="2015-09-18"> <Base CurrencyCode="EUR" AmountBeforeTax="0.00" AmountAfterTax="160.00" DecimalPlaces="2" /> <Total CurrencyCode="EUR" AmountBeforeTax="0.00" AmountAfterTax="160.00" DecimalPlaces="2" /> </Rate> <Rate EffectiveDate="2015-09-19" ExpireDate="2015-09-19"> <Base CurrencyCode="EUR" AmountBeforeTax="0.00" AmountAfterTax="160.00" DecimalPlaces="2" /> <Total CurrencyCode="EUR" AmountBeforeTax="0.00" AmountAfterTax="160.00" DecimalPlaces="2" /> </Rate> </Rates> <RoomRateDescription> <Text>Standard with breakfast</Text> </RoomRateDescription> </RoomRate> </RoomRates> <GuestCounts> <GuestCount AgeQualifyingCode="10" Count="1"/> </GuestCounts> <TimeSpan Start="2015-09-16" End="2015-09-20" Duration="P4D"/> <CancelPenalties> <CancelPenalty PolicyCode="STD" Fri="1" Mon="1" Sat="1" Sun="1" Thur="1" Tue="1" Weds="1"> <AmountPercent FeesInclusive="1" Amount="0.0000"/> <PenaltyDescription Name="Standard"/> </CancelPenalty> </CancelPenalties> <DepositPayments> <GuaranteePayment GuaranteeType="PrePay" Type="RequiredPayment" NonRefundableIndicator="False"> <AcceptedPayments> <AcceptedPayment GuaranteeTypeCode="4" PaymentTransactionTypeCode="charge"> <PaymentCard CardCode="VI" ExpireDate="0917"> <CardHolderName>Dr WhoWho II</CardHolderName> <CardNumber> <PlainText>4970497049704971</PlainText> </CardNumber> <SeriesCode> <PlainText>124</PlainText> </SeriesCode> </PaymentCard> </AcceptedPayment> </AcceptedPayments> <AmountPercent Percent="10" CurrencyCode="EUR" Amount="5.90" DecimalPlaces="2" ApplyAs="FirstAndLastNightDeposit" /> <Description> <Text>This is a test DepositPayment on the RoomStay level</Text> </Description> </GuaranteePayment> </DepositPayments> <Total CurrencyCode="EUR" AmountBeforeTax="0.00" AmountAfterTax="680.00" DecimalPlaces="2" /> <BasicPropertyInfo HotelCode="00F55f7e28de4a33" HotelName="Hotel Ennit PO" CurrencyCode="EUR"/> <ResGuestRPHs>1</ResGuestRPHs> </RoomStay> <RoomStay IndexNumber="2" RoomStayStatus="Book"> <RoomTypes> <RoomType RoomID="00F55f80d7db845a" IsRoom="1"> <RoomDescription Name="Single room standard"/> </RoomType> </RoomTypes> <RatePlans> <RatePlan RatePlanID="00P561b58e7250da"> <MealsIncluded MealPlanIndicator="0"/> </RatePlan> </RatePlans> <RoomRates> <RoomRate EffectiveDate="2015-09-16" ExpireDate="2015-09-19" RatePlanID="00F55f80f515c377"> <Rates> <Rate EffectiveDate="2015-09-16" ExpireDate="2015-09-16"> <Base CurrencyCode="EUR" AmountBeforeTax="0.00" AmountAfterTax="160.00" DecimalPlaces="2" /> <Total CurrencyCode="EUR" AmountBeforeTax="0.00" AmountAfterTax="160.00" DecimalPlaces="2" /> </Rate> <Rate EffectiveDate="2015-09-17" ExpireDate="2015-09-17"> <Base CurrencyCode="EUR" AmountBeforeTax="0.00" AmountAfterTax="160.00" DecimalPlaces="2" /> <Total CurrencyCode="EUR" AmountBeforeTax="0.00" AmountAfterTax="160.00" DecimalPlaces="2" /> </Rate> <Rate EffectiveDate="2015-09-18" ExpireDate="2015-09-18"> <Base CurrencyCode="EUR" AmountBeforeTax="0.00" AmountAfterTax="160.00" DecimalPlaces="2" /> <Total CurrencyCode="EUR" AmountBeforeTax="0.00" AmountAfterTax="160.00" DecimalPlaces="2" /> </Rate> <Rate EffectiveDate="2015-09-19" ExpireDate="2015-09-19"> <Base CurrencyCode="EUR" AmountBeforeTax="0.00" AmountAfterTax="160.00" DecimalPlaces="2" /> <Total CurrencyCode="EUR" AmountBeforeTax="0.00" AmountAfterTax="160.00" DecimalPlaces="2" /> </Rate> </Rates> <RoomRateDescription> <Text>Standard with breakfast</Text> </RoomRateDescription> </RoomRate> </RoomRates> <GuestCounts> <GuestCount AgeQualifyingCode="10" Count="1"/> </GuestCounts> <TimeSpan Start="2015-09-16" End="2015-09-20" Duration="P4D"/> <CancelPenalties> <CancelPenalty PolicyCode="STD" Fri="1" Mon="1" Sat="1" Sun="1" Thur="1" Tue="1" Weds="1"> <AmountPercent FeesInclusive="1" Amount="0.00" DecimalPlaces="2" /> <PenaltyDescription Name="Standard"/> </CancelPenalty> </CancelPenalties> <Total CurrencyCode="EUR" AmountBeforeTax="0.00" AmountAfterTax="680.00" DecimalPlaces="2" /> <BasicPropertyInfo HotelCode="00F55f7e28de4a33" HotelName="Hotel Ennit PO" CurrencyCode="EUR"/> <ResGuestRPHs>1</ResGuestRPHs> </RoomStay> </RoomStays> <ResGuests> <ResGuest ResGuestRPH="1"> <Profiles> <ProfileInfo> <UniqueID ID="00R5615405a213c7" ID_Context="Internal" Type="1"/> <Profile StatusCode="4" CreateDateTime="2015-10-07T17:55:06+02:00" LastModifyDateTime="2015-10-29T17:06:05+01:00" ProfileType="1" OptInStatus="Unknown"> <Customer MaritalStatus="Unknown" Gender="Unknown"> <PersonName> <GivenName>Friedrichstraße</GivenName> <Surname>Crescenzio</Surname> </PersonName> <Email EmailType="1" TextFormat="text/html" ShareMarketInd="Inherit" ShareSynchInd="Inherit">fabio.crescenzio@hotel-spider.com</Email> <Address UseType="2" ValidationStatus="NotChecked" ValidInd="1" ShareMarketInd="Inherit" ShareSynchInd="Inherit"> <AddressLine>Friedrichstraße 7</AddressLine> <CityName>Montcherand</CityName> <PostalCode>1354</PostalCode> <CountryName>Switzerland</CountryName> </Address> </Customer> </Profile> </ProfileInfo> </Profiles> </ResGuest> </ResGuests> <ResGlobalInfo> <GuestCounts> <GuestCount AgeQualifyingCode="10" Count="1"/> </GuestCounts> <TimeSpan Start="2015-09-16" End="2015-09-19" Duration="P3D"/> <Comments> <Comment CreateDateTime="2015-10-29T17:06:03+01:00" LastModifyDateTime="2015-10-29T17:06:03+01:00" Language="en"> <Text>This reservation has been sent to test if everything is working fine with the OTA messages, you can ignore it</Text> </Comment> </Comments> <Guarantee GuaranteeType="CC/DC/Voucher" GuaranteeCode="00F563243eb94a3c"> <GuaranteesAccepted> <GuaranteeAccepted> <PaymentCard CardCode="VI" ExpireDate="1111"> <CardHolderName>Fabio Crescenzio</CardHolderName> <CardNumber Mask="xxxxxxxxxxxx1111"> <PlainText>4242424242421111</PlainText> </CardNumber> <SeriesCode> <PlainText>011</PlainText> </SeriesCode> </PaymentCard> </GuaranteeAccepted> </GuaranteesAccepted> </Guarantee> <DepositPayments> <GuaranteePayment GuaranteeType="PrePay" Type="RequiredPayment" NonRefundableIndicator="False"> <AcceptedPayments> <AcceptedPayment GuaranteeTypeCode="4" PaymentTransactionTypeCode="charge"> <PaymentCard CardCode="VI" ExpireDate="0917"> <CardHolderName>Dr WhoWho II</CardHolderName> <CardNumber> <PlainText>4970497049704971</PlainText> </CardNumber> <SeriesCode> <PlainText>124</PlainText> </SeriesCode> </PaymentCard> </AcceptedPayment> </AcceptedPayments> <AmountPercent Percent="10" CurrencyCode="EUR" Amount="5.90" DecimalPlaces="2" ApplyAs="FirstAndLastNightDeposit" /> <Description> <Text>This is a test DepositPayment on the Reservation level</Text> </Description> </GuaranteePayment> </DepositPayments> <Total CurrencyCode="EUR" AmountBeforeTax="0.00" AmountAfterTax="1360.00" DecimalPlaces="2" /> <HotelReservationIDs> <HotelReservationID ResID_Date="2015-10-29T17:06:04+01:00" ResID_Source="1" ResID_SourceContext="Tourisoft" ResID_Type="14" ResID_Value="12315465678914guiguifbuif"/> <HotelReservationID ResID_Date="2015-10-29T17:06:04+01:00" ResID_SourceContext="Hotel Spider" ResID_Type="34" ResID_Value="00F563243ea41b11"/> </HotelReservationIDs> <Profiles> <ProfileInfo> <UniqueID ID="00R5615405a213c7" ID_Context="Internal" Type="1"/> <Profile StatusCode="4" CreateDateTime="2015-10-07T17:55:06+02:00" LastModifyDateTime="2015-10-29T17:06:05+01:00" ProfileType="1" OptInStatus="Unknown"> <Customer MaritalStatus="Unknown" Gender="Unknown"> <PersonName> <GivenName>Friedrichstraße</GivenName> <Surname>Crescenzio</Surname> </PersonName> <Email EmailType="1" TextFormat="text/html" ShareMarketInd="Inherit" ShareSynchInd="Inherit">fabio.crescenzio@hotel-spider.com</Email> <Address UseType="2" ValidationStatus="NotChecked" ValidInd="1" ShareMarketInd="Inherit" ShareSynchInd="Inherit"> <AddressLine>Friedrichstraße 7</AddressLine> <CityName>Montcherand</CityName> <PostalCode>1354</PostalCode> <CountryName>Switzerland</CountryName> </Address> </Customer> </Profile> </ProfileInfo> </Profiles> <BasicPropertyInfo HotelCode="00F55f7e28de4a33" HotelName="Hotel Ennit PO" CurrencyCode="EUR"/> </ResGlobalInfo> </HotelReservation> </HotelReservations> </OTA_HotelResNotifRQ>