Hotel information (mapping).
By retrieving hotel information from Smarthotel you are able to map the room types and rate codes between the external system and Smarthotel.
To Retrieve Room type information a OTA_HoteldescriptiveInfoRQ needs to be posted. In the response, the room types can be found (Note: ‘SendGuestRooms‘ should be set to ‘True‘)
To Retrieve rate Codes a OTA_HotelRatePlanRQ should be sent. Within the response to this request, Sell-able products can be found, which refer to the Room Types in the OTA_HoteldescriptiveInfoRQ. By combining these two responses the setup Room-Rate combinations can be defined.
OTA_HotelDescriptiveInfoRQ/RS.
The OTA_HotelDescriptiveInfoRQ message allows a trading partner to query for specific hotel descriptive data.
OTA_HotelDescriptiveInfoRQ
| Element / @Attribute | Parent | Info | Values | Occurrence |
|---|---|---|---|---|
| HotelDescriptiveInfos | OTA_HotelDescriptiveInfoRQ | Collection of items for data from multiple hotels. | 1 | |
| HotelDescriptiveInfo | HotelDescriptiveInfos | This allows the requestor to indicate which specific information is requested if complete hotel details are not required. | 1 | |
| @HotelCode | HotelDescriptiveInfo | The ID of the hotel. | [integer] | 1 |
| AffiliationInfo | HotelDescriptiveInfo | Is used to the indicate the specific affiliation information being requested. | 0..1 | |
| @SendAwards | AffiliationInfo | Send this data. "True" means send the data. | True False | 0..1 |
| ContactInfo | HotelDescriptiveInfo | Is used to the indicate whether contact information is being requested. | 0..1 | |
| @SendData | ContactInfo | Send this data. "True" means send the data. | True False | 0..1 |
| FacilityInfo | HotelDescriptiveInfo | Is used to the indicate the specific facility information being requested. | 0..1 | |
| @SendGuestRooms | FacilityInfo | Send this data. "True" means send the data. | True False | 0..1 |
| HotelInfo | HotelDescriptiveInfo | Is used to indicate whether hotel information is being requested. | 0..1 | |
| @SendData | HotelInfo | Send this data. "True" means send the data. | True False | 0..1 |
| MultimediaObjects | HotelDescriptiveInfo | Is used to the indicate whether multimedia information is being requested. | 0..1 | |
| @SendData | MultimediaObjects | Send this data. "True" means send the data. | True False | 0..1 |
<?xml version="1.0" encoding="UTF-16"?>
<OTA_HotelDescriptiveInfoRQ 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>
<HotelDescriptiveInfos>
<HotelDescriptiveInfo HotelCode="21052">
<AffiliationInfo SendAwards="True" />
<ContactInfo SendData="True" />
<FacilityInfo SendGuestRooms="True" />
<HotelInfo SendData="True" />
<MultimediaObjects SendData="True" />
</HotelDescriptiveInfo>
</HotelDescriptiveInfos>
</OTA_HotelDescriptiveInfoRQ>
OTA_HotelDescriptiveInfoRS
The OTA_HotelDescriptiveInfoRS is a message used to provide detailed descriptive information about a hotel property.
| Element / @Attribute | Parent | Info | Values | Occurrence |
|---|---|---|---|---|
| HotelDescriptiveContents | OTA_HotelDescriptiveInfoRS | A collection of hotel descriptive information. | 1 | |
| HotelDescriptiveContent | HotelDescriptiveContents | Hotel descriptive information. | 0..n | |
| @HotelCode | HotelDescriptiveContent | The ID of the hotel. | [integer] | 1 |
| @HotelName | HotelDescriptiveContent | A text field used to communicate the proper name of the hotel. | [string] | 1 |
| @ChainCode | HotelDescriptiveContent | The ID of the chain. | [integer] | 0..1 |
| @CurrencyCode | HotelDescriptiveContent | An ISO 4217 (3) alpha character code that specifies a monetary unit. | [string] | 1 |
| ContactInfos | HotelDescriptiveContent | Provides contact information. A collection of ContactInfo elements that provides detailed contact information. | 0..1 | |
| ContactInfo | ContactInfos | Used to define specific contact information such as phone and address. The ContactInfo class is used to define the contacts for consumers and technical people at the hotel facility, including various telephone numbers and e-mail addresses, or any respective attribute or affiliation for the hotel. | 1 | |
| Names | ContactInfo | A collection of Name elements. Provides detailed name information. | 1 | |
| Name | Names | Used to pass detailed name information regarding a contact. | 1 | |
| GivenName | Name | Given name. | [string] | 1 |
| Addresses | ContactInfo | A collection of Address elements. | 1 | |
| Address | Addresses | An address. | 1 | |
| @FormattedInd | Address | Specifies if the associated data is formatted or not. When true, then it is formatted; when false, then not formatted. | True,False | 1 |
| StreetNmbr | Address | May contain the street number and optionally the street name. | [string] | 0..1 |
| AddressLine | Address | When the address is unformatted (FormattedInd="false") these lines will contain free form address details. When the address is formatted and street number and street name must be sent independently, the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence. | [string] | 1 |
| PostalCode | Address | Post Office Code number. | [string] | 1 |
| CityName | Address | City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address). | [string] | 1 |
| StateProv | Address | State or Province name (e.g., Zuid-Holland). | [string] | 1 |
| CountryName | Address | Country name (e.g., Ireland). | [string] | 1 |
| TPA_Extensions | Address | A placeholder in the schema to allow for additional elements and attributes to be included per Trading Partner Agreement (TPA). | 1 | |
| StateID | TPA_Extensions | The ID of the state. | [integer] | 1 |
| CountryID | TPA_Extensions | The ID of the country. | [integer] | 1 |
| Emails | ContactInfo | A collection of email elements. | 1 | |
| Emails | An email address. | [string] | 1 | |
| Phones | ContactInfo | A collection of Phone elements. Provides detailed phone information. | 1 | |
| Phone | Phones | Used to pass detailed phone information. | 0..n | |
| @PhoneTechType | Phone | Indicates type of technology associated with this telephone number. | Refer to OpenTravel Code List Phone Technology Type (PTT). Values: | 1 |
| @CountryAccessCode | Phone | Code assigned by telecommunications authorities for international country access identifier. | [integer] | 0..1 |
| @AreaCityCode | Phone | Code assigned for telephones in a specific region, city, or area. | [integer] | 0..1 |
| @PhoneNumber | Phone | Telephone number assigned to a single location. | [integer] | 1 |
| URLs | ContactInfo | A collection of URL elements. Used to pass detailed URL information. The URLs class identifies URI information. | 1 | |
| URL | URLs | Provides a Website address. | [string] | 1 |
| DestinationSystemsCode | HotelDescriptiveContent | A collection of destination systems codes. A collection of DestinationSystemCode. | 0..1 | |
| DestinationSystemCode | DestinationSystemsCode | The ID of the channel. | [integer] | 1..n |
| FacilityInfo | HotelDescriptiveContent | Provides information pertaining to the hotel facility itself. The FacilityInfo class that describes the facilities provided at the hotel, including rooms. | 0..1 | |
| GuestRooms | FacilityInfo | Collection of guest room types that are comprised within the hotel. | 0..1 | |
| GuestRoom | GuestRooms | The accommodation occupied by a guest. | 0..n | |
| Code | GuestRoom | The ID of the room. | [integer] | 1 |
| @MinOccupancy | GuestRoom | Minimum number of guests allowed in a room type. | [integer] | 1 |
| @MaxOccupancy | GuestRoom | Maximum number of guests allowed in a room type. | [integer] | 1 |
| @MaxAdultOccupancy | GuestRoom | Maximum number of adults allowed in a room type. | [integer] | 0..1 |
| @MaxChildOccupancy | GuestRoom | Maximum number of children allowed in a room type. | [integer] | 0..1 |
| @Sort | GuestRoom | Used to define the display order. | [integer] | 1 |
| DescriptiveText | GuestRoom | Descriptive text that describes the guest room. | [string] | 1 |
| TypeRoom | GuestRoom | Describes the guest room type; in composite types there can be multiple occurrences. | 1 | |
| @Name | TypeRoom | Text name of the type of room such as "Two Bedroom Villas". | [string] | 1 |
| @RoomTypeCode | TypeRoom | Specific system room type code, ex: A1K, A1Q etc. | [string] | 1 |
| @Composite | TypeRoom | Indicates that the room (suite) is a composite of smaller units. True for a virtual room / package, false for a room. | True, False | 1 |
| Amenities | GuestRoom | Collection of room amenity items available to the guest. | 0..1 | |
| Amenity | Amenities | Tangible room item(s) (e.g., newspaper) available to the guest. | 1..n | |
| @ID | Amenity | The ID of the amenity. | [integer] | 1 |
| @RoomAmenityCode | Amenity | The code of the amenity. | Refer to OpenTravel Code List Room Amenity Type (RMA). | 0..1 |
| @CodeDetail | Amenity | May be used to give further detail on the code. | [string] | 1 |
| MultimediaDescriptions | GuestRoom | Multimedia information about a collection of multimedia objects. Contains multimedia item(s). | 0..1 | |
| MultimediaDescription | MultimediaDescriptions | A multimedia item. Describes multimedia item(s). | 1 | |
| ImageItems | MultimediaDescription | A collection of image items. Collection of image items. | 1 | |
| ImageItem | ImageItems | Image of a given category. | 1..n | |
| ImageFormat | ImageItem | A set of images for a given category which may be provided in multiple formats. | 1 | |
| URL | ImageFormat | URL of the multimedia item for a specific format. | [string] | 1 |
| HotelInfo | HotelDescriptiveContent | Contains descriptive information about a hotel. The HotelInfo class that describes general information about the hotel. | 0..1 | |
| @HotelStatusCode | HotelInfo | This indicates the operating status of the hotels to be returned in the response. | Refer to OpenTravel Code List HotelStatusCode. Values: | 1 |
| HotelName | HotelInfo | The full name of the hotel. | 1 | |
| Position | HotelInfo | Describes the geocoded location of the hotel. | 1 | |
| @Latitude | Position | The measure of the angular distance on a meridian north or south of the equator. | [decimal] | 1 |
| @Longitude | Position | The measure of the angular distance on a meridian east or west of the prime meridian. | [decimal] | 1 |
| Services | HotelInfo | Collection of hotel services and/or amenities available to the guest. | 0..1 | |
| Service | Services | A hotel service or amenity available to the guest such as a business center, concierge, valet parking, massage, newspapers, etc. | 1..n | |
| @ID | Service | The ID of the amenity. | [integer] | 1 |
| @Code | Service | The code of the amenity. | Refer to OpenTravel Code List Hotel Amenity Code (HAC). | 0..1 |
| @CodeDetail | Service | May be used to give further detail on the code. | [string] | 1 |
| AffiliationInfo | HotelDescriptiveContent | Provides information regarding affiliations, loyalty programs and award ratings. The AffiliationInfo object is used to identify the brand or franchise affiliations of the hotel. | 0..1 | |
| Awards | AffiliationInfo | A collection of Award elements. | 1 | |
| Award | Awards | Provides detailed information regarding each award for this hotel. | 1 | |
| @Rating | Award | The actual award or rating received by the hotel facility (e.g. 4 stars). If used in conjunction with RatingSymbol only the numeric rating would be passed here. | [integer] | 1 |
| @RatingSymbol | Award | Provides the symbol used in the rating. Used in conjunction with the Rating. | Star | 1 |
| MultimediaDescriptions | HotelDescriptiveContent | Multimedia information about a collection of multimedia objects. Contains multimedia item(s). | 0..1 | |
| MultimediaDescription | MultimediaDescriptions | A multimedia item. Describes multimedia item(s). | 0..1 | |
| ImageItems | MultimediaDescription | A collection of image items. Collection of image items. | 1 | |
| ImageItem | ImageItems | Image of a given category. | 1..n | |
| ImageFormat | ImageItem | A set of images for a given category which may be provided in multiple formats. | 1 | |
| URL | ImageFormat | URL of the multimedia item for a specific format. | [string] | 1 |
| Policies | HotelDescriptiveContent | A collection of policy information as it applies to the hotel. | 1 | |
| Policy | Policies | Describes the policies of the hotel, such as the type of payments, or whether children or pets are accepted. | 1..n | |
| CancelPolicy | Policy | Defines the cancellation policy of the hotel facility. A collection of CancelPenalty. | 0..1 | |
| CancelPenalty | CancelPolicy | Defines the cancellation penalty of the hotel facility. The CancelPenalty class defines the cancellation policy of the hotel facility. | 1 | |
| PenaltyDescription | CancelPenalty | Text description of the Penalty in a given language. An indication of a new paragraph for a sub-section of a formatted text message. | 1 | |
| Text | PenaltyDescription | Formatted text content. Provides text and indicates whether it is formatted or not. | [string] | 1 |
| GuaranteePaymentPolicy | Policy | A collection of deposit policies, guarantees policy, and/or accepted forms of payment. | 0..1 | |
| GuaranteePayment | GuaranteePaymentPolicy | Used to define the deposit policy, guarantees policy, and/or accepted forms of payment. | 1 | |
| Description | GuaranteePayment | Text description of the Payment in a given language. An indication of a new paragraph for a sub-section of a formatted text message. | 1 | |
| @Language | Description | The ID of the language. | Refer to Languages code list | 1 |
| Text | Description | Formatted text content. Provides text and indicates whether it is formatted or not. | [string] | 1 |
| AcceptedPayments | GuaranteePayment | Collection of forms of payment accepted for payment. Used to define the types of payments accepted. | 0..1 | |
| AcceptedPayment | AcceptedPayments | An acceptable form of payment. | 1..n | |
| Cash | AcceptedPayment | Used to indicate payment in cash. | 0..1 | |
| @CashIndicator | Cash | If true, this indicates cash is being used. | True, False | 1 |
| PaymentCard | AcceptedPayment | Details of a debit or credit card. Specific payment card information. | 0..1 | |
| CardType | PaymentCard | Payment card type. | 1 | |
| @Description | PaymentCard | The card description. | MasterCard American Express Visa | 1 |
| PolicyInfo | Policy | Basic property policy information. | 1 | |
| @CheckInTime | PolicyInfo | The usual check-in time for the hotel. | [hh:mm:ss] | 1 |
| CheckOutTime | PolicyInfo | The usual check-out time for the hotel. | [hh:mm:ss] | 1 |
| @Name | PolicyInfo | The name of the policy. | Child Policy, Smoking Policy | 0..1 |
| Description | PolicyInfo | Text description of the Payment in a given language. An indication of a new paragraph for a sub-section of a formatted text message. | 1 | |
| @Language | Description | The ID of the language. | Refer to Languages code list | 1 |
| Text | Description | Formatted text content. Provides text and indicates whether it is formatted or not. | [string] | 1 |
| PetsPolicies | Policy | Property pet policies. | 0..1 | |
| PetsPolicy | PetsPolicies | Detailed policy information when pets are allowed. | 1 | |
| Description | PetsPolicy | A description of the pet policy. An indication of a new paragraph for a sub-section of a formatted text message. | 1 | |
| @Language | Description | The ID of the language. | Refer to Languages code list | 1 |
| Text | Description | Formatted text content. Provides text and indicates whether it is formatted or not. | [string] | 1 |
| TPA_Extensions | HotelDescriptiveContent | A placeholder in the schema to allow for additional elements and attributes to be included per Trading Partner Agreement (TPA). Allows extensions to be added to the OpenTravel specification per trading partner agreement. | 1 | |
| HotelInfo | TPA_Extensions | Contains descriptive information about a hotel. The HotelInfo class that describes general information about the hotel. | 0..1 | |
| ImportantInformations | HotelInfo | A collection with important information. | 0..1 | |
| ImportantInformation | ImportantInformations | Important information about the hotel. | 1..n | |
| Description | ImportantInformation | Text description of the Important Information in a given language. An indication of a new paragraph for a sub-section of a formatted text message. | 1 | |
| @Language | Description | The ID of the language. | Refer to Languages code list | 1 |
| Text | Description | Formatted text content. Provides text and indicates whether it is formatted or not. | [string] | 1 |
| TravelInformations | HotelInfo | A collection with travel information. | 0..1 | |
| TravelInformation | TravelInformations | Travel information about the hotel. | 1..n | |
| Description | TravelInformation | Text description of the Important Information in a given language. An indication of a new paragraph for a sub-section of a formatted text message. | 1 | |
| @Language | Description | The ID of the language. | Refer to Languages code list | 1 |
| Text | Description | Formatted text content. Provides text and indicates whether it is formatted or not. | [string] | 1 |
| HotelServices | HotelInfo | A collection of services. | 0..1 | |
| Service | HotelServices | A Service object represents a non-room product provided to guests. | 1..n | |
| @ID | Service | A unique identifying value assigned by the creating system. | [integer] | 1 |
| @ServiceInventoryCode | Service | The code of the service. | [string] | 1 |
| @ServiceStatusCode | Service | The status of the service. | Active, Inactive | 1 |
| @ServiceCategoryCode | Service | The representation of the specific service category for this specific service. | None Standard ExtraBed ExtraBabyCot ExtraInfant ExtraChild BreakfastAndDinner Dinner3Course Dinner4Course Breakfast TouristTax ReservationCharge ExtraNight3 ExtraNight4 | 1 |
| @ServicePricingType | Service | An enumerated type that defines how a service is priced. | None PerStay PerNight PerAdultPerStay PerAdultPerNight SelectedDates SelectedDatesPerAdult PercentagePerStay PercentagePerStayPerChild PerPiece PerPiecePerNight PerPiecePerAdult PerPiecePerAdultPerNight SelectedDatesPerChild PercentagePerStayPerAdult PerChildPerStay PerChildPerNight | 1 |
| @Inclusive | Service | Whether the price for this service is included. | True False | 1 |
| @Sort | Service | Used to define the display order. | [integer] | 1 |
| ServiceDetails | Service | Details on the Service. | 1 | |
| ServiceNames | ServiceDetails | A collection of ServiceName. | 0..1 | |
| ServiceName | ServiceNames | Name of the service. | 1..n | |
| @Language | ServiceName | The ID of the language. | Refer to Languages code list | 1 |
| Text | ServiceName | Formatted text content. Provides text and indicates whether it is formatted or not. | [string] | 1 |
| ServiceDescriptions | ServiceDetails | A collection of ServiceDescription. | 0..1 | |
| ServiceDescription | ServiceDescriptions | Description of the service. | 1..n | |
| @ Language | ServiceDescription | The ID of the language. | Refer to Languages code list | 1 |
| Text | ServiceDescription | Formatted text content. Provides text and indicates whether it is formatted or not. | [string] | 1 |
| MultimediaDescriptions | ServiceDetails | Multimedia information about a collection of multimedia objects. Contains multimedia item(s). | 0..1 | |
| MultimediaDescription | MultimediaDescriptions | A multimedia item. Describes multimedia item(s). | 0..1 | |
| ImageItems | MultimediaDescription | A collection of image items. Collection of image items. | 1 | |
| ImageItem | ImageItems | Image of a given category. | 1..n | |
| ImageFormat | ImageItem | A set of images for a given category which may be provided in multiple formats. | 1 | |
| URL | ImageFormat | URL of the multimedia item for a specific format. | [string] | 1 |
| FacilityInfo | TPA_Extensions | Provides information pertaining to the hotel facility itself. The FacilityInfo class that describes the facilities provided at the hotel, including meeting rooms restaurants. | 0..1 | |
| GuestRooms | FacilityInfo | Collection of guest room types that are comprised within the hotel. | 0...1 | |
| GuestRoom | GuestRooms | The accommodation occupied by a guest. | 0..n | |
| @Code | GuestRoom | The ID of the room. | [integer] | 1 |
| @Default | GuestRoom | The default number of packages to offer. | [integer] | 1 |
| @Threshold | GuestRoom | The threshold at which to stop offering the package. | [integer] | 1 |
| @MasterID | GuestRoom | The ID of the master room (for master/slave). If 0, this is a master room. | [integer] | 1 |
| RoomPlans | GuestRoom | The room plans belonging to the room. | 0..1 | |
| RoomPlan | RoomPlans | A room plan. | 1..n | |
| @Code | RoomPlan | The ID of the room plan. | [integer] | 1 |
| @RoomTypeCode | RoomPlan | The code of the room plan. | [string] | 1 |
| @Name | RoomPlan | The name. | [string] | 1 |
| @DestinationSystemsCode | RoomPlan | The ID of the channel. | [integer] | 1 |
| @Sort | RoomPlan | The sort index. | [integer] | 1 |
<?xml version="1.0" encoding="UTF-16"?>
<OTA_HotelDescriptiveInfoRS EchoToken="Example123" PrimaryLangID="eng" Target="Production" TimeStamp="2018-07-29T07:38:54.729Z" Version="1.0">
<Success />
<HotelDescriptiveContents>
<HotelDescriptiveContent HotelCode="21052" HotelName="Hotel SmartPMS" CurrencyCode="EUR">
<HotelInfo HotelStatusCode="Open">
<HotelName>Hotel SmartPMS</HotelName>
<Position Latitude="5204056" Longitude="4719406" />
<Services>
<Service ID="40" Code="0" CodeDetail="Air conditioning" />
<Service ID="41" Code="0" CodeDetail="Anti allergenic rooms" />
<Service ID="42" Code="0" CodeDetail="Car hire" />
<Service ID="155" Code="0" CodeDetail="Balcony" />
</Services>
</HotelInfo>
<AffiliationInfo>
<Awards>
<Award Rating="2" RatingSymbol="Star" />
</Awards>
</AffiliationInfo>
<ContactInfos>
<ContactInfo>
<Names>
<Name>
<GivenName>SmartPMS</GivenName>
</Name>
</Names>
<Addresses>
<Address FormattedInd="True">
<StreetNmbr>5-7</StreetNmbr>
<AddressLine>Einsteinstraat</AddressLine>
<PostalCode>2811 EP</PostalCode>
<CityName>Reeuwijk</CityName>
<StateProv>Zuid-Holland</StateProv>
<CountryName>Netherlands</CountryName>
<TPA_Extensions>
<StateID>2</StateID>
<CountryID>151</CountryID>
</TPA_Extensions>
</Address>
</Addresses>
<Emails>
<Email>support@smarthotel.nl</Email>
</Emails>
<Phones>
<Phone PhoneTechType="1" CountryAccessCode="31" AreaCityCode="182" PhoneNumber="751118" />
</Phones>
<URLs>
<URL>www.smartpms.nl</URL>
</URLs>
</ContactInfo>
</ContactInfos>
<DestinationSystemsCode>
<DestinationSystemCode>1</DestinationSystemCode>
<DestinationSystemCode>2</DestinationSystemCode>
<DestinationSystemCode>3</DestinationSystemCode>
</DestinationSystemsCode>
<FacilityInfo>
<GuestRooms>
<GuestRoom Code="DBL" MinOccupancy="2" MaxOccupancy="4" MaxAdultOccupancy="3" MaxChildOccupancy="2" Sort="1">
<DescriptiveText>test</DescriptiveText>
<TypeRoom Name="Comfort Room" RoomTypeCode="STD" Composite="False" />
<Amenities>
<Amenity ID="1" RoomAmenityCode="0" CodeDetail="Air conditioning" />
<Amenity ID="17" RoomAmenityCode="0" CodeDetail="Heating" />
<Amenity ID="20" RoomAmenityCode="0" CodeDetail="LAN" />
<Amenity ID="29" RoomAmenityCode="0" CodeDetail="Shower" />
</Amenities>
<MultimediaDescriptions>
<MultimediaDescription>
<ImageItems>
<ImageItem>
<ImageFormat>
<URL>https://smhimages.blob.core.windows.net/imagescontainer/1000_21052_C2E1D7511AC44780A4B1D2EF39D0230C97368A75_1_o.png?v=635773879793002651</URL>
</ImageFormat>
</ImageItem>
</ImageItems>
</MultimediaDescription>
</MultimediaDescriptions>
</GuestRoom>
</GuestRooms>
</FacilityInfo>
<MultimediaDescriptions>
<MultimediaDescription>
<ImageItems>
<ImageItem>
<ImageFormat>
<URL>https://smhdev.blob.core.windows.net/imagescontainer/1000_21052_249AF65BB33DA0DC7D73CC02DF918439231F6290_1_o.png?v=636038302856283386</URL>
</ImageFormat>
</ImageItem>
</ImageItems>
</MultimediaDescription>
</MultimediaDescriptions>
<Policies>
<Policy>
<PolicyInfo CheckInTime="14:00:00" CheckOutTime="11:05:00" />
</Policy>
<Policy>
<PetsPolicies>
<PetsPolicy>
<Description Language="1">
<Text>Dieren</Text>
</Description>
<Description Language="2">
<Text>Pets</Text>
</Description>
</PetsPolicy>
</PetsPolicies>
<CancelPolicy>
<CancelPenalty>
<PenaltyDescription Language="1">
<Text>
<em>Bij annulering of niet komen opdagen, berekenen wij de volgende kosten door aan de klant:</em>
<br>Binnen 24 uur voor incheck datum -> 100% van de kamerkosten<br>Langer dan 24 uur -> geen kosten<br>
<br>Bij reserveringen van meer dan 3 kamers hanteren wij de Uniforme Voorwaarden Horeca<br>Langer dan 14 dagen voor aankomst -> geen kosten<br>Tussen 7 en 14 dagen voor aankomst -> 35% van de kamerkosten<br>Tussen 3 en 7 dagen voor aankomst -> 60% van de kamerkosten<br> Tussen 24 uur en 3 dagen voor aankomst -> 85% van de kamerkosten<br>Binnen 24 uur voor aankomst -> 100% van de kamerkosten</Text>
</PenaltyDescription>
<PenaltyDescription Language="2">
<Text>48 hours in advance of arriving cancellation is free of charge.</Text>
</PenaltyDescription>
<PenaltyDescription Language="3">
<Text>48 Stunden im Voraus Stornogebühr.</Text>
</PenaltyDescription>
</CancelPenalty>
</CancelPolicy>
<GuaranteePaymentPolicy>
<GuaranteePayment>
<Description Language="1">
<Text>Direct bevestigd!</Text>
</Description>
<Description Language="2">
<Text>Guaranteed!</Text>
</Description>
<AcceptedPayments>
<AcceptedPayment>
<Cash CashIndicator="True" />
</AcceptedPayment>
<AcceptedPayment>
<PaymentCard>
<CardType Description="AmericanExpress" />
</PaymentCard>
</AcceptedPayment>
<AcceptedPayment>
<PaymentCard>
<CardType Description="MasterCard" />
</PaymentCard>
</AcceptedPayment>
<AcceptedPayment>
<PaymentCard>
<CardType Description="Visa" />
</PaymentCard>
</AcceptedPayment>
</AcceptedPayments>
</GuaranteePayment>
</GuaranteePaymentPolicy>
</Policy>
<Policy>
<PolicyInfo Name="Child Policy">
<Description Language="1">
<Text>Kindjes</Text>
</Description>
</PolicyInfo>
</Policy>
<Policy>
<PolicyInfo Name="Smoking Policy">
<Description Language="1">
<Text>Roken niet toegestaan</Text>
</Description>
</PolicyInfo>
</Policy>
</Policies>
<TPA_Extensions>
<HotelInfo>
<ImportantInformations>
<ImportantInformation>
<Description Language="1">
<Text>
<b>Gaarne vooraf contact opnemen indien u of uw gast later dan 20.00 uur wilt inchecken.</b> Met een door ons toegewezen persoonlijke code kunt u zelf inchecken en heeft u daarna te allen tijde toegang tot het hotel.<br>
<br>
<b>Because the reception is closed at 20.00 pm please contact us in advance if you want to check in later.</b> With a programmed code, self in check is possible after 20.00 pm and with the key you have 24 access to the hotel. www.khn.nl/uvh-nl <https://www.khn.nl/uvh-nl>
</Text>
</Description>
</ImportantInformation>
</ImportantInformations>
<TravelInformations>
<TravelInformation>
<Description Language="2">
<Text>The Hotel is located at 'De Reeuwijkse Plassen'</Text>
</Description>
</TravelInformation>
<TravelInformation>
<Description Language="3">
<Text>Das Hotel liegt an den Seen Reeuwijkse entfernt.</Text>
</Description>
</TravelInformation>
</TravelInformations>
<HotelServices>
<Service ID="212384" ServiceInventoryCode="CHA" ServiceStatusCode="Active" ServiceCategoryCode="Standard" ServicePricingType="SelectedDates" Inclusive="False" Sort="0">
<ServiceDetails>
<ServiceNames>
<ServiceName Language="1">
<Text>Champagne</Text>
</ServiceName>
<ServiceName Language="2">
<Text>Champagne!</Text>
</ServiceName>
</ServiceNames>
<ServiceDescriptions>
<ServiceDescription Language="1">
<Text>Wilt u graag iets extra's aan uw verblijf toevoegen, bestel nu alvast een fles Champagne op uw kamer.</Text>
</ServiceDescription>
<ServiceDescription Language="2">
<Text>Bottle of Bubbles in the room!</Text>
</ServiceDescription>
</ServiceDescriptions>
<MultimediaDescriptions>
<MultimediaDescription>
<ImageItems>
<ImageItem>
<ImageFormat>
<URL>https://smhimages.blob.core.windows.net/imagescontainer/1000_21052_E6DD34D3D9386249DE264F1CAE3F6E9763057FF3_1_o.png?v=635711755060758113</URL>
</ImageFormat>
</ImageItem>
</ImageItems>
</MultimediaDescription>
</MultimediaDescriptions>
</ServiceDetails>
<Price Mon="true" Tue="true" Weds="true" Thur="true">
<Base AmountAfterTax="1800" DecimalPlaces="2" />
</Price>
<Price Fri="true" Sat="true" Sun="true">
<Base AmountAfterTax="2000" DecimalPlaces="2" />
</Price>
</Service>
</HotelServices>
</HotelInfo>
<FacilityInfo>
<GuestRooms>
<GuestRoom Code="1" Default="0" Threshold="0" MasterID="0">
<RoomPlans>
<RoomPlan Code="6" RoomTypeCode="STD" Name="Comfort Room" DestinationSystemsCode="0" Sort="1" />
</RoomPlans>
</GuestRoom>
</GuestRooms>
</FacilityInfo>
</TPA_Extensions>
</HotelDescriptiveContent>
</HotelDescriptiveContents>
</OTA_HotelDescriptiveInfoRS>
Occupancies:
In the OTA_HotelDescriptiveInfoRS there are several possibilities for the attributes @MinOccupancy and @MaxOccupancy. In below schema you can find the possible occupancies for a room based on the MinOccpuancy and MaxOccupancy.
| @MinOccupancy | @MaxOccupancy | Pricing sent for: |
|---|---|---|
| 1 | 1 | 1 person |
| 2 | 2 | 1 & 2 persons |
| 2 | 3 | 1,2 & 3 persons |
| 2 | 4 | 1,2,3 & 4 persons |
| 3 | 3 | 3 persons |
| 4 | 4 | 4 persons |
OTA_HotelRatePlanRQ/RS.
This message provides the ability to request rate plan details for hotel properties by specific criteria.
| Element / @Attribute | Parent | Info | Values | Occurrence |
|---|---|---|---|---|
| RatePlans | OTA_HotelRatePlanRQ | Collection of rate plans. | 1 | |
| RatePlan | RatePlans | Provides the criteria to identify the rate plan to be returned. | 1..n | |
| HotelRef | RatePlan | Indicates the detail of hotel reference information. | 1 | |
| @HotelCode | HotelRef | The ID of the hotel | [integer] | 1 |
| DestinationSystemsCode | RatePlan | A collection of destination system codes. These are systems for which this rate plan is targeted. A collection of DestinationSystemCode. | 0..1 | |
| DestinationSystemsCode | DestinationSystemsCode | The ID of the channel | [integer] | 1 |
| RatePlanCandidates | RatePlan | Collection of requested rateplans | 0..1 | |
| RatePlanCandidate | RatePlanCandidates | Element used to identify available products and rates. | 1 |
<?xml version="1.0" encoding="UTF-16"?>
<OTA_HotelRatePlanRQ 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>
<RatePlans>
<RatePlan>
<HotelRef HotelCode="21052" />
<DestinationSystemsCode>
<DestinationSystemCode>1</DestinationSystemCode>
</DestinationSystemsCode>
<RatePlanCandidates>
<RatePlanCandidate RatePlanCode="STD" />
</RatePlanCandidates>
</RatePlan>
</RatePlans>
</OTA_HotelRatePlanRQ>
OTA_HotelRatePlanRS
In the TPA_Extensions you will find some attributes which are specific for the Smarthotel channel manager. The values for this will be explained below:
RateType: the RateType will define what kind of rate this rate code is. There are several values:
- Base Rate: Calculated rates will be calculated from the Base rate
- Default: This is the standard setting for a rate code
- Calculated: This rate will be calculated from the Base Rate
- Best Bar by Day: Rate type used for specific setup with RMS systems
- No R&A update: This rate will not send any messages to an OTA.
Masterrate: Thick this box if the rate code needs to be a master rate and the standard availability needs to be sent for this rate code.
Default: number of rooms to be send to an OTA for the Single, Triple and Quadruple column in case of a master rate.
Threshold: The number of rooms on which the Single, Triple and Quadruple colums will be closed on an OTA in case of a master rate.
CorporateType: What type of corporate rate this rate code is (currently only for selected OTAs
- Not Applicable: This is no corporate rate
- Fixed corporate: No rate update sent to connected OTA (specific OTA functionality)
- Corporate: In use for specific OTA.
- Trade fair: not in use
BBARTrigger: Specific RMS setup
| Element / @Attribute | Parent | Info | Values | Occurrence |
|---|---|---|---|---|
| RatePlans | OTA_HotelRatePlanRS | A collection of rate plans. | 1 | |
| RatePlan | RatePlans | An individual rate plan. All details pertaining to a specific rate plan. | 0..n | |
| @RatePlanCode | RatePlan | The ID of the rate. | [integer] | 1 |
| @DestinationSystemsCode | RatePlan | The ID of the channel. | [integer] | 1 |
| HotelRef | RatePlan | Indicates the detail of hotel reference information. | 1 | |
| @HotelCode | HotelRef | The ID of the hotel. | [integer] | 1 |
| Description | RatePlan | Description of the RatePlan. An indication of a new paragraph for a sub-section of a formatted text message. | 1 | |
| @Name | Description | Indicates the type of the description. | Name | 1 |
| Text | Description | Formatted text content. | 1 | |
| RatePlanLevelFee | RatePlan | A Fee that is attached directly to the RatePlan. Can be used to send a global surcharge at the RatePlan level. | 0..1 | |
| Fee | RatePlanLevelFee | Fee Amount that is applied to the rate. Fees are used for non-tax amounts like service charges. | 1 | |
| @MealPlanCode | Fee | This describes meal plans associated with a rate plan. | Refer to OpenTravel Code Table Meal Plan Type (MPT). | 1 |
| BookingRules | RatePlan | A collection of booking rules. | 1 | |
| BookingRule | BookingRules | The BookingRule element defines restrictions to rates and stays at the hotel for a given rate plan, room type or rate plan/room type combination. | 1 | |
| @MaxAdvancedBookingOffset | BookingRule | Maximum days before the arrival date for which this rate plan may be booked. | [integer] | 0..1 |
| RequiredPaymts | BookingRule | A collection of required payments that are part of the booking restriction. A collection of required payments. | 0..1 | |
| GuaranteePayment | RequiredPaymts | Used to define the deposit policy, guarantees policy, and/or accepted forms of payment. | 1 | |
| AmountPercent | GuaranteePayment | Payment expressed as a fixed amount, or a percentage of/or room nights. | 1 | |
| @Percent | AmountPercent | The percentage used to calculate the amount. | [double] | 1 |
| CancelPenalties | BookingRule | A collection of required payments that are part of the booking restriction. A collection of CancelPenalty. | 1 | |
| @CancelPolicyIndicator | CancelPenalties | When true, indicates a cancel policy exists. When false, no cancel policy exists. Typically this indicator is used when details are not being sent. | True, False | 1 |
| CancelPenalty | CancelPenalties | Defines the cancellation penalty of the hotel facility. The CancelPenalty class defines the cancellation policy of the hotel facility. | 1 | |
| @NonRefundable | CancelPenalty | Indicates that any prepayment for the reservation is non-refundable, therefore a 100% penalty on the prepayment is applied, irrespective of deadline. | True, False | 1 |
| @PolicyCode | CancelPenalty | The ID of the cancellation policy. | 0 = None, 1 = Non-cancellable 2 = Time pre-arrival day 3 = Time arrival day 4 = Days before arrival day 5 = UVH | 1 |
| Deadline | CancelPenalty | Cancellation deadline, absolute or relative. | 0..1 | |
| @AbsoluteDeadline | Deadline | Defines the absolute deadline. Either this or the offset attributes may be used. | [hh:mm:ss] | 0..1 |
| @OffsetDropTime | Deadline | An enumerated type indicating when the deadline drop time goes into effect. | BeforeArrival | 0..1 |
| @OffsetTimeUnit | Deadline | The units of time, e.g.: days, hours, etc., that apply to the deadline. | Days, Hours | 0..1 |
| @OffsetUnitMultiplier | Deadline | The number of units of DeadlineTimeUnit. | [integer] | 0..1 |
| PenaltyDescription | CancelPenalty | Text description of the Penalty in a given language. An indication of a new paragraph for a sub-section of a formatted text message. | 0..1 | |
| Text | PenaltyDescription | Formatted text content. | [string] | 0..1 |
| AmountPercent | CancelPenalty | Cancellation fee expressed as a fixed amount, or percentage of/or room nights. Defines the percentage basis for calculating the fee amount or the amount. | 0..1 | |
| @ApplyAs | AmountPercent | Used to specify how the amount needs to be applied with respect to the stay. | FirstNightPayment | 0..1 |
| @NmbrOfNights | AmountPercent | The number of nights of the hotel stay that are used to calculate the fee amount. | [integer] | 0..1 |
| @Percent | AmountPercent | The percentage used to calculate the amount. | [double] | 0..1 |
| @BasisType | AmountPercent | Provides the basis for how the amount of the guarantee is calculated. | FullStay, Nights | 1 |
| SellableProducts | RatePlan | A collection of Sellable Products. The SellableProduct class defines the inventoried item for this rate plan. | 0..1 | |
| SellableProduct | SellableProducts | The individual sellable product. A sellable product may be a guest room, a meeting room or an inventory block. Attributes of SellableProduct are the inventory codes, information on the use, application and sequencing of the inventory information. | 1..n | |
| @InvTypeCode | SellableProduct | The ID of the room to link to as mentioned in the @Code attribute in the GuestRoom element in the OTA_HotelDescriptiveInfoRS | [integer] | 1 |
| TPA_Extensions | OTA_HotelRatePlanRS | A placeholder in the schema to allow for additional elements and attributes to be included per Trading Partner Agreement (TPA). Allows extensions to be added to the OpenTravel specification per trading partner agreement. | 1 | |
| RatePlans | TPA_Extensions | A collection of rate plans. | 1 | |
| RatePlan | RatePlans | An individual rate plan. All details pertaining to a specific rate plan. | 0..n | |
| @RatePlanCode | RatePlan | The ID of the rate code | [integer] | 1 |
| @RatePlanTypeCode | RatePlan | The code of the rate. | [string] | 1 |
| @Sort | RatePlan | The sort index. | [integer] | 1 |
| @IncludesTaxInd | RatePlan | Indicates whether tax is included (true/false). | True, False | 1 |
| @RateType | RatePlan | The type of the rate: | BaseRate, Default, CalculatedRate, BestBarByDay, NoRnAUpdate | 1 |
| @MasterRate | RatePlan | Indicates whether the rate is a master rate. | True, False | 1 |
| @Default | RatePlan | The rate default. | [integer] | 1 |
| @Threshold | RatePlan | The rate threshold. | [integer] | 1 |
| @CorporateType | RatePlan | The corporate type. | NotApplicable, Corporate, FixedCorporate, TradeFair | 1 |
| @BBARTrigger | RatePlan | The BBAR trigger. | None, OpenClose, CTA, FPLOS | 1 |
| RatePlanGroups | TPA_Extensions | A collection of RatePlanGroup | 1 | |
| RatePlanGroup | RatePlanGroups | A RatePlan | 0..n | |
| @RatePlanCode | RatePlanGroup | The ID of the rate plan group. | [integer] | 1 |
| @RatePlanTypeCode | RatePlanGroup | The code of the rate plan group. | [string] | 1 |
| @Sort | RatePlanGroup | The sort index | [integer] | 1 |
| Description | RatePlanGroup | Description of the rate plan group. | 1 | |
| @Name | Description | Indicates the type of the description. | Name | 1 |
| Text | Description | Formatted text content. | [string] | 1 |
<?xml version="1.0" encoding="UTF-16"?>
<OTA_HotelRatePlanRS EchoToken="Example123" PrimaryLangID="eng" Target="Production" TimeStamp="2018-07-29T07:38:54.729Z" Version="1.0">
<Success />
<RatePlans>
<RatePlan RatePlanCode="1" DestinationSystemsCode="1">
<HotelRef HotelCode="21052" />
<Description Name="Name">
<Text>Standard rate</Text>
</Description>
<RatePlanLevelFee>
<Fee MealPlanCode="3" />
</RatePlanLevelFee>
<BookingRules>
<BookingRule>
<CancelPenalties CancelPolicyIndicator="True">
<CancelPenalty NonRefundable="True" PolicyCode="3">
<Deadline AbsoluteDeadline="02:00:00" />
<AmountPercent Percent="100" />
</CancelPenalty>
</CancelPenalties>
</BookingRule>
</BookingRules>
<SellableProducts>
<SellableProduct InvTypeCode="1" />
<SellableProduct InvTypeCode="2" />
<SellableProduct InvTypeCode="3" />
<SellableProduct InvTypeCode="4" />
<SellableProduct InvTypeCode="8" />
<SellableProduct InvTypeCode="10" />
<SellableProduct InvTypeCode="13" />
</SellableProducts>
</RatePlan>
</RatePlans>
<TPA_Extensions>
<RatePlans>
<RatePlan RatePlanCode="1" RatePlanTypeCode="STD" Sort="4" IncludesTaxInd="False" RateType="BaseRate" MasterRate="True" Default="2" Threshold="2" CorporateType="NotApplicable" BBARTrigger="None" />
</RatePlans>
<RatePlanGroups>
<RatePlanGroup RatePlanCode="1" RatePlanTypeCode="RATEPLAN" Sort="2">
<Description Name="Name">
<Text>Rateplan</Text>
</Description>
</RatePlanGroup>
</RatePlanGroups>
</TPA_Extensions>
</OTA_HotelRatePlanRS>
Rates & Availability.
To update rates and availability from a PMS to the Smarthotel channel manager, 3 types of messages are used. All three have their specific function and updates rates, inventory or restrcictons.
The OTA_HotelInvCountNotifRQ/RS sends a notification to the channel manager that synchronizes the inventory available for sale at the hotel.
The OTA_HotelRateAmountNotifRQ/RS sends a notification to the channel manager which updates the values in the channel manager for the given rate code or rate plan, timespan and number of guests.
The OTA_BookingRuleNotifRQ/RS is the message that sends the notification of the rules and restrictions affecting the availability status of the hotel. Currently, Smarthotel supports the following restrictions: Master Open/Close, Open/Closed to Arrival, Open/Closed to Departure, Minimum Length of Stay, and Maximum Length of Stay.
It is now possible to push your inventory, rate, and restrictions messages on room and rate codes instead of ids. This is mandatory for interfaces connecting with SmartCONNECT for CRS. This can be done to add the following lines with as parent OTA_HotelInvCountNotifRQ, OTA_HotelRateAmountNotifRQ, and OTA_HotelBookingRuleNotifRQ.
<TPA_Extensions>
<CodeUsage>Code</CodeUsage>
</TPA_Extensions>
OTA_HotelInvCountNotifRQ/RS.
OTA_HotelInvCountNotifRQ
This message sends a notification to the channel manager that synchronizes the inventory available for sale at the hotel.
| Element / @Attribute | Parent | Info | Values | Occurrence |
|---|---|---|---|---|
| Inventories | OTA_HotelInvCountNotifRQ | A collection of Inventory. Hotel identification information are the attributes of this element. | 1..n | |
| @HotelCode | Inventories | The ID of the hotel. | [integer] | 1 |
| Inventory | Inventories | This is the inventory information for a given rate plan, room type, date, etc. The set of changes in the number of units of base inventory for one inventory type (code) to be made on the server. The server must successfully update all messages. Failure to update any single status message will result in the failure of all messages. | 1..n | |
| StatusApplicationControl | Inventory | Information on what the InvCountNotif Message applies to (i.e. the combination of inventory and/or rate codes) and the period of application. The StatusApplicationControl class is used to indicate to which block codes/rate plans/inventory codes a status should be applied. | 1 | |
| @InvTypeCode | StatusApplicationControl | The ID of the room, or the ID of the room plan (in case InvCodeApplication has been set to InvGroupingCode). | [integer] | 1 |
| @InvType | StatusApplicationControl | Optional attribute to be included when a bed type in a room needs to be updated. Always set to BedType. Omit when updating a room. | BedType | 0..1 |
| @InvCode | StatusApplicationControl | Optional attribute to be included when a bed type in a room needs to be updated. Indicates the ID of the bed type. | [integer] | 0..1 |
| @InvCodeApplication | StatusApplicationControl | Omit when updating a room, set to ‘InvGroupingCode’ when updating a room plan. | InvGroupingCode | 0..1 |
| @Start | StatusApplicationControl | The starting value of the time span. | [yyyy-MM-dd] | 1 |
| @End | StatusApplicationControl | The ending value of the time span. | [yyyy-MM-dd] | 1 |
| @Mon, @Tue, @Weds, @Thur, @Fri, @Sat, @Sun | StatusApplicationControl | When true, applies only to a particular day. | True False | 0..1 |
| InvCounts | Inventory | A collection of inventory counts. | 1..n | |
| InvCount | InvCounts | Individual inventory count. | 1 | |
| Count | InvCount | An integer representing the count. | [integer] | 1 |
| CountType | InvCount | This identifies the type of inventory count being reported. Refer to OpenTravel Code List Inventory Count Type (INV). | 1 = Physical | 0..1 |
<?xml version="1.0" encoding="UTF-16"?>
<OTA_HotelInvCountNotifRQ 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>
<Inventories HotelCode="21052">
<Inventory>
<StatusApplicationControl InvTypeCode="DBL" Start="2018-07-24" End="2018-07-31" Mon="true" Fri="true" />
<InvCounts>
<InvCount Count="5" CountType="1" />
</InvCounts>
</Inventory>
</Inventories>
</OTA_HotelInvCountNotifRQ>
OTA_HotelInvCountNotifRS
| Element / @Attribute | Parent | Info | Values | Occurrence |
|---|---|---|---|---|
| UniqueID | OTA_HotelInvCountNotifRS | An identifier used to uniquely reference an object in a system. | 1 | |
| @ID | UniqueID | The queue ID. | [integer] | 1 |
| @Type | UniqueID | A reference to the type of object defined by the UniqueID element. | Refer to OpenTravel Code List Unique ID Type (UIT). Value: 18 = Other | 1 |
Extra note;
Only the exact data stated in the request message will be processed; this data needs to be different then the data present in the channel manager.
Other data present in the channel manager will not be modified.
<?xml version="1.0" encoding="UTF-16"?> <OTA_HotelInvCountNotifRS EchoToken="Example123" PrimaryLangID="eng" Target="Production" TimeStamp="2018-07-29T07:38:54.729Z" Version="1.0"> <Success /> <UniqueID ID="123456" Type="18" /> </OTA_HotelInvCountNotifRS>
OTA_HotelRateAmountNotifRQ/RS.
OTA_HotelRateAmountNotifRQ
This message is used to provide a notification of a new rate plan created for a hotel and to synchronize the rate plan between the PMS and the channel manager.
| Element / @Attribute | Parent | Info | Values | Occurrence |
|---|---|---|---|---|
| RateAmountMessages | OTA_HotelRateAmountNotifRQ | A collection of RateAmountMessages that define the rate changes to be made. | 1..n | |
| @HotelCode | RateAmountMessages | The ID of the hotel. | [integer] | 1 |
| RateAmountMessage | RateAmountMessages | RateAmountMessages that define the rate changes to be made. | 1..n | |
| StatusApplicationControl | RateAmountMessage | Information on what the RateAmount Message applies to (i.e. the combination of inventory and rate codes) and the period of application. The StatusApplicationControl class is used to indicate to which block codes/rate plans/inventory codes a status should be applied. | 1 | |
| @InvTypeCode | StatusApplicationControl | The ID of the room. Required when updating rates, not required when updating a rate plan. | [integer] | 0..1 |
| @InvType | StatusApplicationControl | Optional attribute to be included when a bed type in a room needs to be updated. Always set to BedType. Omit when updating a room. | BedType | 0..1 |
| @InvCode | StatusApplicationControl | Optional attribute to be included when a bed type in a room needs to be updated. Indicates the ID of the bed type. | [integer] | 0..1 |
| @RatePlanCode | StatusApplicationControl | The ID of the rate, or the ID of the rate plan (in case RatePlanCodeApplication has been set to ‘RatePlanGroupingCode’). | [integer] | 1 |
| @RatePlanCodeApplication | StatusApplicationControl | Omit when updating a rate, set to ‘RatePlanGroupingCode’ when updating a rate plan. | RatePlanGroupingCode | 0..1 |
| @Start | StatusApplicationControl | The starting value of the time span. | [yyyy-MM-dd] | 1 |
| @End | StatusApplicationControl | The ending value of the time span. | [yyyy-MM-dd] | 1 |
| @Mon, @Tue, @Weds, @Thur, @Fri, @Sat, @Sun | StatusApplicationControl | When true, applies only to a particular day. | False True | 0..1 |
| Rates | RateAmountMessage | A collection of rate changes to be synchronized between systems. | 1 | |
| Rate | Rates | An individual rate, which is a collection of amounts by guest, additional guests, and the unique id to identify the rate. | 1 | |
| BaseByGuestAmts | Rate | A collection of Base charges by number of guests. | 1 | |
| BaseByGuestAmt | BaseByGuestAmts | Base charge for a given number of guests for a given age qualifying code. | 1..n | |
| @NumberOfGuests | BaseByGuestAmt | The number of guests associated with this base charge. Only required for AgeQualifyingCode 10 (Adult). | 1 = Single use 2 = Standard use 3 = Triple use 4 = Quad use | 0..1 |
| @AgeQualifyingCode | BaseByGuestAmt | Defines an age range or age category of a guest. | Refer to OpenTravel Code List Age Qualifying Code (AQC). 10=Adult (Default) | 0..1 |
| @DecimalPlaces | BaseByGuestAmt | The ISO 4217 standard "minor unit" for the number of decimal places for a particular currency. | [integer] | 0..1 |
| @AmountAfterTax | BaseByGuestAmt | The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax). | [numeric] | 1 |
| AdditionalGuestAmounts | Rate | A collection of charges that apply to for additional guests. | 0..1 | |
| AdditionalGuestAmount | AdditionalGuestAmounts | Collection of incremental charges for additional guests. | 1 | |
| @Amount | AdditionalGuestAmount | A monetary amount, including tax. | [numeric] | 1 |
| @DecimalPlaces | AdditionalGuestAmount | Decimal places for currency code. | [integer] | 1 |
<?xml version="1.0" encoding="UTF-16"?>
<OTA_HotelRateAmountNotifRQ 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>
<RateAmountMessages HotelCode="21052">
<RateAmountMessage>
<StatusApplicationControl InvTypeCode="DBL" RatePlanCode="STD" RateTier="1" Start="2018-07-24" End="2018-07-31" Mon="true" Fri="true" />
<Rates>
<Rate>
<BaseByGuestAmts>
<BaseByGuestAmt NumberOfGuests="1" AgeQualifyingCode="10" AmountAfterTax="3895" DecimalPlaces="2" />
<BaseByGuestAmt NumberOfGuests="2" AgeQualifyingCode="10" AmountAfterTax="4995" DecimalPlaces="2" />
</BaseByGuestAmts>
<AdditionalGuestAmounts>
<AdditionalGuestAmount Amount="1000" DecimalPlaces="2" />
</AdditionalGuestAmounts>
</Rate>
</Rates>
</RateAmountMessage>
</RateAmountMessages>
</OTA_HotelRateAmountNotifRQ>
OTA_HotelRateAmountNotifRS
This message is used to indicate the status of processing the OTA_HotelRateAmountNotifRQ message
| Element / @Attribute | Parent | Info | Values | Occurrence |
|---|---|---|---|---|
| UniqueID | OTA_HotelRateAmountNotifRS | An identifier used to uniquely reference an object in a system. | 1 | |
| @ID | UniqueID | The queue ID. | [integer] | 1 |
| @Type | UniqueID | A reference to the type of object defined by the UniqueID element. | Refer to OpenTravel Code List Unique ID Type (UIT). Value: 18 = Other | 1 |
Extra note;
Only the exact data stated in the request message will be processed; this data needs to be different then the data present in the channel manager.
Other data present in the channel manager will not be modified.
<?xml version="1.0" encoding="UTF-16"?> <OTA_HotelRateAmountNotifRS EchoToken="Example123" PrimaryLangID="eng" Target="Production" TimeStamp="2018-07-29T07:38:54.729Z" Version="1.0"> <Success /> <UniqueID ID="123456" Type="18" /> </OTA_HotelRateAmountNotifRS>
OTA_HotelBookingRuleNotifRQ/RS.
OTA_HotelBookingRuleNotifRQ
The OTA_HotelBookingRuleNotifRQ is the message that sends the notification of the rules and restrictions affecting the availability status of the hotel. Currently Smarthotel supports the following restrictions: Master Open/Close, Open/Closed to Arrival, Open/Closed to Departure, Minimun Length of Stay and Maximum Length of Stay.
| Element / @Attribute | Parent | Info | Values | Occurrence |
|---|---|---|---|---|
| RuleMessages | OTA_HotelBookingRuleNotifRQ | Container for the individual RuleMessage(s). An OTA_HotelBookingRuleNotifRQ contains the booking rules for a single hotel. Hotel identification information are the attributes of this element. | 1..n | |
| @HotelCode | RuleMessages | The ID of the hotel. | [integer] | 1 |
| RuleMessage | RuleMessages | Container for the collection of Booking Rules for a given hotel or chain. | 1..n | |
| StatusApplicationControl | RuleMessage | Information on what the BookingRule Message applies to (i.e. the combination of inventory and rate codes) and the period of application. The StatusApplicationControl class is used to indicate to which block codes/rate plans/inventory codes a status should be applied. | 1 | |
| @InvTypeCode | StatusApplicationControl | The ID of the room. | [integer] | 1 |
| @InvType | StatusApplicationControl | Optional attribute to be included when a bed type in a room needs to be updated. Always set to BedType. Omit when updating a room. | BedType | 0..1 |
| @InvCode | StatusApplicationControl | Optional attribute to be included when a bed type in a room needs to be updated. Indicates the ID of the bed type. | [integer] | 0..1 |
| @RatePlanCode | StatusApplicationControl | The ID of the rate. | [integer] | 1 |
| @Start | StatusApplicationControl | The starting value of the time span. | [yyyy-MM-dd] | 1 |
| @End | StatusApplicationControl | The ending value of the time span. | [yyyy-MM-dd] | 1 |
| @Mon, @Tue, @Weds, @Thur, @Fri, @Sat, @Sun | StatusApplicationControl | When true, applies only to a particular day. | True False | 0..1 |
| BookingRules | RuleMessage | Container for the collection of Booking Rules which apply for the information indicated in the StatusApplicationControl element. A collection of BookingRule. | 1 | |
| BookingRule | BookingRules | The BookingRule element defines restrictions to rates and stays at the hotel for a given rate plan, room type or rate plan/room type combination. | 1..n | |
| RestrictionStatus | BookingRule | Availability status assigned to the room rate combination for this booking rule. | 0..n | |
| @Restriction | RestrictionStatus | Indicates the type of the restriction. | Arrival Departure Master (default) | 0..1 |
| @Status | RestrictionStatus | The status. | Open Close | 1 |
| LengthsOfStay | BookingRule | A collection of lengths of stay. A collection of LengthOfStay. | 0..1 | |
| LengthOfStay | LengthsOfStay | A collection of patterns defining allowable lengths of stay (LOS). | 1..n | |
| @MinMaxMessageType | LengthOfStay | An enumerated type used to define how the minimum and maximum LOS is applied. | SetMinLOS SetMaxLOS | 1 |
| @Time | LengthOfStay | Used in conjunction with the MinMaxMessageType and the TimeUnit to define the length of stay requirements. (Only applicable for MinMaxMessageType ‘SetMinLOS’ and ‘SetMaxLOS’.) | [integer] | 0..1 |
<?xml version="1.0" encoding="UTF-16"?>
<OTA_HotelBookingRuleNotifRQ 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>
<RuleMessages HotelCode="21052">
<RuleMessage>
<StatusApplicationControl InvTypeCode="DBL" RatePlanCode="STD" RateTier="1" Start="2018-07-24" End="2018-07-31" Mon="true" Fri="true" />
<BookingRules>
<BookingRule>
<RestrictionStatus Restriction="Master" Status="Open" />
<RestrictionStatus Restriction="Arrival" Status="Close" />
<RestrictionStatus Restriction="Departure" Status="Close" />
<LengthsOfStay>
<LengthOfStay MinMaxMessageType="SetMinLOS" Time="2" />
<LengthOfStay MinMaxMessageType="SetMaxLOS" Time="7" />
</LengthsOfStay>
</BookingRule>
</BookingRules>
</RuleMessage>
</RuleMessages>
</OTA_HotelBookingRuleNotifRQ>
OTA_HotelBookingRuleNotifRS
The OTA_HotelBookingRuleNotifRS is the message used to indicate the status of processing the OTA_HotelBookingRuleNotifRQ message.
| Element / @Attribute | Parent | Info | Values | Occurrence |
|---|---|---|---|---|
| UniqueID | OTA_HotelBookingRuleNotifRS | An identifier used to uniquely reference an object in a system. | 1 | |
| @ID | UniqueID | The queue ID. | [integer] | 1 |
| @Type | UniqueID | A reference to the type of object defined by the UniqueID element. | Refer to OpenTravel Code List Unique ID Type (UIT). Value: 18 = Other | 1 |
Extra note;
Only the exact data stated in the request message will be processed; this data needs to be different then the data present in the channel manager.
Other data present in the channel manager will not be modified.
<?xml version="1.0" encoding="UTF-16"?> <OTA_HotelBookingRuleNotifRS EchoToken="Example123" PrimaryLangID="eng" Target="Production" TimeStamp="2018-07-29T07:38:54.729Z" Version="1.0"> <Success /> <UniqueID ID="123456" Type="18" /> </OTA_HotelBookingRuleNotifRS>
Reservations.
The reservation flow for a PMS connected to the Smarthotel channel manager consists of 3 messages. The PMS first will send a request to the channel manager to retrieve one or more reservations with the OTA_ReadRQ.
The channel manager will respond with the OTA_ResRetrieveRS which will deliver the reservations requested to the PMS.
As the channel manager needs to know if the PMS was able to handle the reservations without any errors, the PMS needs to send a OTA_HotelResModifyRQ. With this request, the channel manager will change the status of the reservation to “picked up”.
OTA_ReadRQ.
The OTA_ReadRQ message is used to retrieve reservations from the channel manager. The message distinguishes to different scenarios.
This scenario covers the retrieval of reservations based on selection criteria
| 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. | False (default) True | 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 |
Additional notes:
- 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.
Example 1: “Undelivered”
<?xml version="1.0" encoding="UTF-16"?>
<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>
OTA_ResRetrieveRS.
OTA_ResRetrieveRS
Both OTA_ReadRQ scenarios result in the same OTA_ResRetrieveRS response message.
All elements that contain a textual value that is marked as “formatted text” in OTA standard is written as a CDATA section. All other elements, including elements containing a textual value that is not a formatted text that is not formatted text, are written as normal elements.
| Element / @Attribute | Parent | Info | Values | Occurrence | |
|---|---|---|---|---|---|
| ReservationsList | OTA_ResRetrieveRS | This message returns a list of reservations. | 0..1 | ||
| HotelReservation | ReservationsList | One line in a list of hotel reservations. | 0..n | ||
| POS | HotelReservation | Identifies who made the original reservation.Point of Sale (POS) identifies the party or connection channel making the request. | 1 | ||
| Source | POS | This holds the details about the requestor. It may be repeated to also accommodate the delivery systems.Provides information on the source of a request. | 1 | ||
| BookingChannel | Source | Specifies the booking channel type and whether it is the primary means of connectivity of the source. | 1 | ||
| @Type | BookingChannel | The type of booking channel (e.g. Global Distribution System (GDS), Alternative Distribution System (ADS), Sales and Catering System (SCS), Property Management System (PMS), Central Reservation System (CRS), Tour Operator System (TOS), Internet and ALL). Refer to OpenTravel Code List Booking Channel Type (BCT). | [integer] | 1 | |
| CompanyName | BookingChannel | Identifies the company that is associated with the booking channel.Identifies a company by name. | [string] | 1 | |
| @RoomStayReservation | HotelReservation | Always “true” | True | 1 | |
| @CreateDateTime | HotelReservation | Time stamp of the creation. | [yyyy-MM-ddTHH:mm:ss] | 1 | |
| @CreatorID | HotelReservation | The ID of the booking site. | [integer] Refer to Code Creator ID | 0..1 | |
| @LastModifyDateTime | HotelReservation | Time stamp of last modification. | [yyyy-MM-ddTHH:mm:ss] | 1 | |
| @LastModifierID | HotelReservation | Identifies the last software system or person to modify a record. | [integer] | 0..1 | |
| @ResStatus | HotelReservation | Indicates the status of the reservation. | Book Cancel modify | 1 | |
| UniqueID | HotelReservation | An identifier used to uniquely reference an object in a system. | 1 | ||
| @ID | UniqueID | SmartHOTEL reservation ID. | [integer] | 1 | |
| @Type | UniqueID | A reference to the type of object defined by the UniqueID element. | Refer to OpenTravel Code List Unique ID Type (UIT). 14 = Reservation 15 = Cancellation | 1 | |
| RoomStays | HotelReservation | Collection of room stays. | 1 | ||
| RoomStay | RoomStays | Details on the Room Stay. One RoomStays element can contain multiple RoomStay elements. | 1..n | ||
| @IndexNumber | RoomStay | Number of the room stay within the RoomStays collection. | [integer] | 1 | |
| RoomTypes | RoomStay | A collection of Room Types associated with a particular Room Stay. | 0..1 | ||
| RoomType | RoomTypes | Provides details regarding rooms. | 1 | ||
| @IsRoom | RoomType | Indicates whether the room type is a room (True) or a bed type (False). | [boolean] | 1 | |
| @BedTypeCode | RoomType | The ID of the bed type. | [integer] | 1 | |
| @NumberOfUnits | RoomType | The number of rooms that have been combined to create this room type. | 1 | 1 | |
| @RoomTypeCode | RoomType | The ID of the room. | [integer] | 1 | |
| RoomDescription | RoomType | Textual information regarding the room. | 0..1 | ||
| @Name | RoomDescription | The name of the room. | [string] | 1 | |
| RoomRates | RoomStay | A collection of Room Rates associated with a particular Room Stay. | 0..1 | ||
| RoomRate | RoomRates | A room rate. | 1..n | ||
| @RoomTypeCode | RoomRate | The ID of the room. | [integer] | 1 | |
| @NumberOfUnits | RoomRate | The number of rooms. | 1 | 1 | |
| @RatePlanCode | RoomRate | The ID of the rate. | [integer] | 1 | |
| Rates | RoomRate | Individual rate amount. | 1 | ||
| Rate | Rates | Rate amount information. | 1 | ||
| @EffectiveDate | Rate | Indicates the starting date. (Date, yyyy-MM-dd) | 1 | ||
| Base | Rate | The base amount charged for the accommodation. | 0..1 | ||
| @AmountBeforeTax | Base | The total amount not including any associated tax. | [numeric] | 0..1 | |
| @AmountAfterTax | Base | The total amount including all associated taxes. | [numeric] | 1 | |
| @CurrencyCode | Base | An ISO 4217 (3) alpha character code that specifies a monetary unit. | [string] | 0..1 | |
| @DecimalPlaces | Base | The ISO 4217 standard "minor unit" for the number of decimal places for a particular currency. | [integer] | 1 | |
| Total | RoomRate | The total of all rates for this room rate type. | 0..1 | ||
| @AmountBeforeTax | Total | The total amount not including any associated tax. | [numeric] | 0..1 | |
| @AmountAfterTax | Total | The total amount including all associated taxes. | [numeric] | 1 | |
| @CurrencyCode | Total | An ISO 4217 (3) alpha character code that specifies a monetary unit. | [string] | 1 | |
| @DecimalPlaces | Total | The ISO 4217 standard "minor unit" for the number of decimal places for a particular currency. | [integer] | 0..1 | |
| GuestCounts | RoomStay | A collection of Guest Counts associated with Room Stay. | 0..1 | ||
| @IsPerRoom | GuestCounts | IsPerRoom means that the guests defined in the GuestCounts object apply to each room in the NumberOfRooms for the RoomStay. Value of "false" means that the guests defined in the GuestCounts object apply to all rooms combined in the NumberOfRooms for the RoomStay. | True | 1 | |
| GuestCount | GuestCounts | A recurring element that identifies the number of guests and ages of the guests. | 1..n | ||
| @AgeQualifyingCode | GuestCount | A code representing a business rule that determines the charges for a guest based upon age range. This attribute allows for an increase in rate by occupant class. | Refer to OpenTravel Code List Age Qualifying Code (AQC). | 1 | |
| @Count | GuestCount | The number of guests in one AgeQualifyingCode. | [integer] | 1 | |
| TimeSpan | RoomStay | The Time Span which covers the Room Stay. | 1 | ||
| @Start | TimeSpan | The starting value of the time span. | [yyyy-MM-dd] | 1 | |
| @End | TimeSpan | The ending value of the time span. | [yyyy-MM-dd] | 1 | |
| CancelPenalties | BookingRule | A collection of required payments that are part of the booking restriction. A collection of CancelPenalty. | 1 | ||
| @CancelPolicyIndicator | CancelPenalties | When true, indicates a cancel policy exists. When false, no cancel policy exists. Typically this indicator is used when details are not being sent. | True False | 1 | |
| CancelPenalty | CancelPenalties | Defines the cancellation penalty of the hotel facility. The CancelPenalty class defines the cancellation policy of the hotel facility. | 1 | ||
| @NonRefundable | CancelPenalty | Indicates that any prepayment for the reservation is non-refundable, therefore a 100% penalty on the prepayment is applied, irrespective of deadline. | True False | 1 | |
| @PolicyCode | CancelPenalty | The ID of the cancellation policy. | Refer to Code List Policy Codes | 1 | |
| Deadline | CancelPenalty | Cancellation deadline, absolute or relative. | 0..1 | ||
| @AbsoluteDeadline | Deadline | Defines the absolute deadline. Either this or the offset attributes may be used. | [hh:mm:ss] | 0..1 | |
| @OffsetDropTime | Deadline | An enumerated type indicating when the deadline drop time goes into effect. | BeforeArrival | 0..1 | |
| @OffsetTimeUnit | Deadline | The units of time, e.g.: days, hours, etc., that apply to the deadline. | Days Hours | 0..1 | |
| @OffsetUnitMultiplier | Deadline | The number of units of DeadlineTimeUnit. | [integer] | 0..1 | |
| PenaltyDescription | CancelPenalty | Text description of the Penalty in a given language. An indication of a new paragraph for a sub-section of a formatted text message. | 0..1 | ||
| Text | PenaltyDescription | Formatted text content. | [string] | 0..1 | |
| AmountPercent | CancelPenalty | Cancellation fee expressed as a fixed amount, or percentage of/or room nights. Defines the percentage basis for calculating the fee amount or the amount. | 0..1 | ||
| @ApplyAs | AmountPercent | Used to specify how the amount needs to be applied with respect to the stay. | FirstNightPayment | 0..1 | |
| @NmbrOfNights | AmountPercent | The number of nights of the hotel stay that are used to calculate the fee amount. | [integer] | 0..1 | |
| @Percent | AmountPercent | The percentage used to calculate the amount. | [double] | 0..1 | |
| @BasisType | AmountPercent | Provides the basis for how the amount of the guarantee is calculated. | FullStay Nights | 1 | |
| Total | RoomStay | The total amount charged for the Room Stay including additional occupant amounts and fees. | 1 | ||
| @AmountBeforeTax | Total | The total amount not including any associated tax. | [numeric] | 1 | |
| @AmountAfterTax | Total | The total amount including all associated taxes. | [numeric] | 1 | |
| @DecimalPlaces | Total | The ISO 4217 standard "minor unit" for the number of decimal places for a particular currency. | [string] | 0..1 | |
| ResGuestRPHs | RoomStay | A collection of unsigned integers serving as reference placeholders, and used as an index identifying which guests occupy this room | 1 | ||
| ResGuestRPH | ResGuestRPHs | This is a reference placeholder used as an index for a guest to be associated with this stay. | 1..n | ||
| @RPH | ResGuestRPH | Provides a unique reference to the guest. | [integer] | 1 | |
| ServiceRPHs | RoomStay | A collection of unsigned integers that reference the RPH (Reference Place holder) attribute in the Service object. The ServiceRPH attribute in the Service object is an indexing attribute that identifies the services attached to a specific guest or to the reservation. | 1 | ||
| ServiceRPH | ServiceRPHs | This is a reference placeholder used as an index for a service to be associated with this stay. | 1..n | ||
| @RPH | ServiceRPH | Provides a unique reference to the service. | [integer] | 1 | |
| Services | HotelReservation | Collection of services. A collection of Service objects. This is the collection of all services associated with any part of this reservation (the reservation in its entirety, one or more guests, or one or more room stays). Which services are attributable to which part is determined by each object's ServiceRPHs collection. | 1 | ||
| Service | Services | A Service object represents a non-room product provided to guests. Service products may have associated inventory and charges. | 0..n | ||
| @ServiceRPH | Service | A unique ID for a service that may be referenced elsewhere in the schema. | [integer] | 1 | |
| @ServiceInventoryCode | Service | The external code of the room the service applies to. | [integer] | 1 | |
| @ID | Service | A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. | [integer] | 1 | |
| Price | Service | The selling price of this Service. | 1 | ||
| @NumberOfUnits | Price | The number of services. | [integer] | 1 | |
| Base | Price | The base amount charged for the service per unit of time. | 1 | ||
| @AmountAfterTax | Price | The total amount including all associated taxes. | [numeric] | 1 | |
| @DecimalPlaces | Price | The ISO 4217 standard "minor unit" for the number of decimal places for a particular currency. | [integer] | 0..1 | |
| ServiceDetails | Service | Details on the Service including Guest Counts, Time Span of this Service, pointers to Res Guests, guest Memberships, Comments and Special Requests pertaining to this particular Service and finally financial information related to the Service, including Guarantee, Deposit and Payment and Cancellation Penalties. | 1 | ||
| GuestCounts | ServiceDetails | A collection of Guest Counts associated to the whole Reservation or a particular Room Stay or Service. A child Guest Count element is required for each distinct age group. A collection of GuestCount by age group. | 1 | ||
| GuestCount | GuestCounts | A recurring element that identifies the number of guests and ages of the guests. | 1 | ||
| @Count | GuestCount | The number of guests in one AgeQualifyingCode or Count. | [integer] | 1 | |
| TimeSpan | ServiceDetails | The Time Span which covers the Service. | 1 | ||
| @Start | TimeSpan | The starting value of the time span. | [yyyy-MM-dd] | 1 | |
| @End | TimeSpan | The ending value of the time span. | [yyyy-MM-dd] | 1 | |
| ServiceDescription | ServiceDetails | Description of the service. An indication of a new paragraph for a sub-section of a formatted text message. | 1 | ||
| Text | ServiceDescription | Formatted text content. | [CDATA string] | 1 | |
| TPA_Extensions | Service | A placeholder in the schema to allow for additional elements and attributes to be included per Trading Partner Agreement (TPA). Allows extensions to be added to the OpenTravel specification per trading partner agreement. | 1 | ||
| ServiceExtension | TPA_Extensions | An extension to the service. | 1 | ||
| @ServiceChargeType | ServiceExtension | The way the service is charged. | Refer to Code List Service Charge Type | 1 | |
| SelectedDates | ServiceExtension | A collection of dates on which the service is active. | 1 | ||
| Date | SelectedDates | A date on which the service is active. | 0..n | ||
| @Value | Date | The date. | [yyyy-MM-dd] | 1 | |
| ResGuests | HotelReservation | Collection of guests associated with the reservation. A collection of ResGuest objects, identifying the guests associated with this reservation. Which guests are in which room is determined by each RoomStays ResGuestRPHs collection. | 1 | ||
| ResGuest | ResGuests | The ResGuest object contains the information about a guest associated with a reservation.A collection of ResGuest objects, identifying the guests associated with this reservation. Which guests are in which room is determined by each RoomStays ResGuestRPHs collection. | 1 | ||
| @ResGuestRPH | ResGuest | This is a reference placeholder, used as an index for this guest in this reservation. In the ResGuest object it is used like all other RPH attributes to send the delta of a reservation. It is used by the RoomStay and Service objects to indicate which guests are associated with that room stay or service. | [integer] | 1 | |
| Profiles | ResGuest | A collection of Profile objects or Unique IDs of Profiles. | 1 | ||
| ProfileInfo | Profiles | A collection of Profiles or Unique IDs of Profiles. | 1 | ||
| Profile | ProfileInfo | Provides detailed information regarding either a company or a customer profile. Root element for profile content. | 1 | ||
| @ProfileType | Profile | Code to specify a profile such as Customer, Tour Operator, Corporation, etc. | Refer to OpenTravel Code List Profile Type (PRT). 1 = Customer | 1 | |
| Customer | Profile | Detailed customer information for this profile. Contains basic data on the customer's identity, location, relationships, finances, memberships, etc. | 1 | ||
| @Gender | Customer | Identifies the gender. | Unknown Female Male | 1 | |
| PersonName | Customer | Detailed name information for the customer. This provides name information for a person. | 1 | ||
| GivenName | PersonName | Given name, first name or names. | [string] | 1 | |
| Surname | PersonName | Family name, last name. May also be used for full name if the sending system does not have the ability to separate a full name into its parts, e.g. the surname element may be used to pass the full name. | [string] | 1 | |
| UniqueID | ProfileInfo | A unique ID for a profile. This element repeats to accommodate multiple unique IDs for a single profile across multiple systems. An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote). | 1 | ||
| @ID | UniqueID | A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. | [integer] | 1 | |
| @Type | UniqueID | A reference to the type of object defined by the UniqueID element. | Refer to OpenTravel Code List Unique ID Type (UIT). 21 = Profile | 1 | |
| ResGlobalInfo | HotelReservation | ResGlobalInfo is a container for various information that affects the Reservation as a whole. These include global comments, counts, reservation IDs, loyalty programs, and payment methods. | 1 | ||
| TimeSpan | ResGlobalInfo | The Time Span which covers the Reservation, Room Stay or Service. | 1 | ||
| @Start | TimeSpan | The starting value of the time span. | [yyyy-MM-dd] | 1 | |
| @End | TimeSpan | The ending value of the time span. | [yyyy-MM-dd] | 1 | |
| Comments | ResGlobalInfo | A collection of Comment objects. Comments which apply to the whole Reservation or a particular Room Stay or Service. A collection of comments. | 1 | ||
| Comment | Comments | Comment details. | 0..n | ||
| Text | Comment | Formatted text content. | [string] | 1 | |
| Guarantee | ResGlobalInfo | The guarantee information associated to the Reservation or a particular Room Stay or Service. The guarantee information to hold a reservation | 0..1 | ||
| @GuaranteeType | Guarantee | An enumerated type defining the guarantee to be applied to this reservation. | CC/DC/Voucher | 1 | |
| GuaranteesAccepted | GuaranteeType | Guarantee Details. | 1 | ||
| GuaranteeAccepted | GuaranteesAccepted | Guarantee Detail. | 1 | ||
| @GuaranteeTypeCode | GuaranteeAccepted | Used to specify the method of guarantee. | Refer to OpenTravel Code List Payment Type (PMT). 5 = Credit card | 1 | |
| PaymentCard | GuaranteeAccepted | Details of a debit or credit card. Specific payment card information. | 1 | ||
| @CardCode | PaymentCard | Issuer code. | [string] | 0..1 | |
| @ExpireDate | PaymentCard | Indicates the ending date. | [MMYY] | 0..1 | |
| CardHolderName | PaymentCard | Card holder name. | 0..1 | ||
| CardNumber | PaymentCard | Credit card number embossed on the card. Secure information that supports PCI tokens, data masking and other encryption methods. | 0..1 | ||
| PlainText | CardNumber | Non-secure (plain text) value. | [string] | 1 | |
| Total | ResGlobalInfo | The total amount charged for the accommodation including additional occupant amounts and fees. The total amount charged for the service including additional amounts and fees. | 1 | ||
| @AmountAfterTax | Total | The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax). | [numeric] | 1 | |
| @DecimalPlaces | Total | The ISO 4217 standard "minor unit" for the number of decimal places for a particular currency. | [integer] | 0..1 | |
| HotelReservationIDs | ResGlobalInfo | A Collection of HotelReservationID objects for a given reservation. The collection of all ReservationIDs can include Passenger Name Record (PNR), Guest Name Record (GNR) and Guest Folio numbers. Associated with each can be a Confirmation number which is usually given to the guest. | 1 | ||
| HotelReservationID | HotelReservationIDs | The HotelReservationID object contains various unique (ReservationID) and non unique (ConfirmationID, CancellationID) identifiers that the trading partners associate with a given reservation. | 0..n | ||
| @ResID_Type | HotelReservationID | Defines the type of Reservation ID (e.g. reservation number, cancellation number). | Refer to OpenTravel Code List Unique ID Type (UIT). 5 = Travel agent 14 = Reservation | 1 | |
| @ResID_Value | HotelReservationID | This is the actual value associated with ResID_Type as generated by the system that is the source of the ResID_Type. | [string] | 1 | |
| @ResID_Source | HotelReservationID | A unique identifier to indicate the source system which generated the ResID_Value. | [integer] | 0..1 | |
| @ResID_SourceContext | HotelReservationID | Additional information on Source. | [string] | 0..1 | |
| Profiles | ResGlobalInfo | A collection of Profile objects or Unique IDs of Profiles. | 1 | ||
| ProfileInfo | Profiles | A collection of Profiles or Unique IDs of Profiles. | 1 | ||
| Profile | ProfileInfo | Provides detailed information regarding either a company or a customer profile. Root element for profile content. | 1 | ||
| @ProfileType | Profile | Code to specify a profile such as Customer, Tour Operator, Corporation, etc. | Refer to OpenTravel Code List Profile Type (PRT). 18 = Billing contact | 1 | |
| Customer | Profile | Detailed customer information for this profile. Contains basic data on the customer's identity, location, relationships, finances, memberships, etc. | 1 | ||
| @Gender | Customer | Identifies the gender. | Unknown Male Female | 1 | |
| PersonName | Customer | Detailed name information for the customer. This provides name information for a person. | 1 | ||
| GivenName | PersonName | Given name, first name or names. | [string] | 1 | |
| Surname | PersonName | Family name, last name. May also be used for full name if the sending system does not have the ability to separate a full name into its parts, e.g. the surname element may be used to pass the full name. | [string] | 1 | |
| Telephone | Customer | Information on a telephone number for the customer. | 0..1 | ||
| @PhoneNumber | Telephone | Telephone number assigned to a single location. | [string] | 1 | |
| Customer | Information on an email address for the customer. | [string] | 0..1 | ||
| Address | Customer | Detailed information on an address for the customer. | 0..1 | ||
| FormattedInd | Address | Specifies if the associated data is formatted or not. When true, then it is formatted; when false, then not formatted. | True False | 1 | |
| AddressLine | Address | When the address is unformatted (FormattedInd="false") these lines will contain free form address details. When the address is formatted and street number and street name must be sent independently, the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence. | [string] | 0..1 | |
| StreetNmbr | Address | May contain the street number and optionally the street name. | [string] | 0..1 | |
| CityName | Address | City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address). | [string] | 0..1 | |
| PostalCode | Address | Post Office Code number. | [string] | 0..1 | |
| CountryName | Address | Country name, according to the ISO 3166-1 alpha-2 list (e.g., NL). The code of a country (e.g. as used in an address or to specify citizenship of a traveller). | [string] | 0..1 | |
| CompanyName | Address | Identifies a company. Identifies a company by name. | [string] | 0..1 | |
| @Department | CompanyName | The department name or ID with which the contact is associated. | [string] | 0..1 | |
| UniqueID | ProfileInfo | A unique ID for a profile. This element repeats to accommodate multiple unique IDs for a single profile across multiple systems. An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote). | 1 | ||
| @ID | UniqueID | A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. | [integer] | 1 | |
| @Type | UniqueID | A reference to the type of object defined by the UniqueID element. | Refer to OpenTravel Code List Unique ID Type (UIT). 21 = Customer | 1 | |
| TotalCommissions | ResGlobalInfo | The total commission for all rate segments in the reservation. Contains details pertaining to commissions. | 0..1 | ||
| CommissionPayableAmount | TotalCommissions | The amount of commission to be paid. | 1 | ||
| @Amount | CommissionPayableAmount | A monetary amount. | [numeric] | 1 | |
| @CurrencyCode | CommissionPayableAmount | An ISO 4217 (3) alpha character code that specifies a monetary unit. | [string] | 0..1 | |
| @DecimalPlaces | CommissionPayableAmount | The ISO 4217 standard "minor unit" for the number of decimal places for a particular currency. | [integer] | 0..1 | |
| BasicPropertyInfo | ResGlobalInfo | Property information for the reservation. An abbreviated short summary of hotel descriptive information. | 1 | ||
| @HotelCode | BasicPropertyInfo | The ID of the hotel. | [integer] | 1 | |
| TPA_Extensions | HotelReservation | A placeholder in the schema to allow for additional elements and attributes to be included per Trading Partner Agreement (TPA). | 0..1 | ||
| PCIInformationUrl | TPA_Extension | This will display a URL to the SmartHOTEL vault for creditcard information. More information upon request. | 1 |
<?xml version="1.0" encoding="UTF-16"?>
<OTA_ResRetrieveRS EchoToken="Example123" PrimaryLangID="eng" Target="Production" TimeStamp="2018-07-29T07:38:54.729Z" Version="1.0">
<Success />
<ReservationsList>
<HotelReservation RoomStayReservation="true" CreateDateTime="2018-07-18T18:53:12" CreatorID="2" LastModifyDateTime="2018-07-18T18:53:12" LastModifierID="2" ResStatus="Book">
<UniqueID ID="600123456" Type="14" />
<RoomStays>
<RoomStay IndexNumber="796">
<RoomTypes>
<RoomType NumberOfUnits="1" RoomTypeCode="4">
<RoomDescription Name="Superior Double" />
</RoomType>
</RoomTypes>
<RoomRates>
<RoomRate RoomTypeCode="DBL" NumberOfUnits="1" RatePlanCode="STD">
<Rates>
<Rate EffectiveDate="2018-09-07">
<Base AmountBeforeTax="15100" AmountAfterTax="15100" DecimalPlaces="2" />
</Rate>
</Rates>
<Total AmountBeforeTax="15100" AmountAfterTax="15100" DecimalPlaces="2" />
</RoomRate>
<RoomRate RoomTypeCode="DBL" NumberOfUnits="1" RatePlanCode="STD">
<Rates>
<Rate EffectiveDate="2018-09-08">
<Base AmountBeforeTax="15600" AmountAfterTax="15600" DecimalPlaces="2" />
</Rate>
</Rates>
<Total AmountBeforeTax="15600" AmountAfterTax="15600" DecimalPlaces="2" />
</RoomRate>
<RoomRate RoomTypeCode="DBL" NumberOfUnits="1" RatePlanCode="STD">
<Rates>
<Rate EffectiveDate="2018-09-09">
<Base AmountBeforeTax="17600" AmountAfterTax="17600" DecimalPlaces="2" />
</Rate>
</Rates>
<Total AmountBeforeTax="17600" AmountAfterTax="17600" DecimalPlaces="2" />
</RoomRate>
</RoomRates>
<GuestCounts IsPerRoom="true">
<GuestCount AgeQualifyingCode="10" Count="2" />
</GuestCounts>
<TimeSpan Start="2018-09-07" End="2018-09-10" />
<CancelPenalties>
<CancelPenalty PolicyCode="4" NonRefundable="false">
<Deadline OffsetTimeUnit="Day" OffsetUnitMultiplier="15" OffsetDropTime="BeforeArrival" />
<AmountPercent BasisType="FullStay" Percent="100" />
<PenaltyDescription>
<Text>
<![CDATA[Booking can be cancelled until 15 day(s) before arrival.]]>
</Text>
</PenaltyDescription>
</CancelPenalty>
</CancelPenalties>
<Total AmountBeforeTax="56700" AmountAfterTax="56700" DecimalPlaces="2" />
<ResGuestRPHs>
<ResGuestRPH RPH="1" />
</ResGuestRPHs>
<ServiceRPHs>
<ServiceRPH RPH="1" />
</ServiceRPHs>
</RoomStay>
</RoomStays>
<Services>
<Service ServiceRPH="1" ServiceInventoryCode="1" ID="1103">
<Price NumberOfUnits="1">
<Base AmountAfterTax="1400" DecimalPlaces="2" />
</Price>
<ServiceDetails>
<GuestCounts>
<GuestCount Count="2" />
</GuestCounts>
<TimeSpan Start="2018-09-07" End="2018-09-10" />
<ServiceDescription>
<Text>
<![CDATA[Breakfast]]>
</Text>
</ServiceDescription>
</ServiceDetails>
<TPA_Extensions>
<ServiceExtension ServiceChargeType="6">
<SelectedDates>
<Date Value="2018-09-07" />
<Date Value="2018-09-08" />
<Date Value="2018-09-09" />
</SelectedDates>
</ServiceExtension>
</TPA_Extensions>
</Service>
</Services>
<ResGuests>
<ResGuest ResGuestRPH="1">
<Profiles>
<ProfileInfo>
<Profile ProfileType="1">
<Customer Gender="Unknown">
<PersonName>
<GivenName>Customer</GivenName>
<Surname>Name</Surname>
</PersonName>
</Customer>
</Profile>
<UniqueID ID="1234" Type="21" />
</ProfileInfo>
</Profiles>
</ResGuest>
</ResGuests>
<ResGlobalInfo>
<TimeSpan Start="2018-09-07" End="2018-09-10" />
<Comments>
<Comment>
<Text>
<![CDATA[You have a booker that prefers communication by email All guests provided by the booking site: Customer Name Total number of guests: 2 Total number of rooms: 1 ]]>
</Text>
</Comment>
</Comments>
<Guarantee GuaranteeType="CC/DC/Voucher">
<GuaranteesAccepted>
<GuaranteeAccepted GuaranteeTypeCode="5">
<PaymentCard CardCode="VI" ExpireDate="0918">
<CardHolderName>Card Holder Name</CardHolderName>
<CardNumber>
<PlainText>XXXX</PlainText>
</CardNumber>
</PaymentCard>
</GuaranteeAccepted>
</GuaranteesAccepted>
</Guarantee>
<Total AmountAfterTax="56700" DecimalPlaces="2" />
<HotelReservationIDs>
<HotelReservationID ResID_Type="5" ResID_Value="123456789" ResID_Source="2" ResID_SourceContext="Booking.com" />
<HotelReservationID ResID_Type="14" ResID_Value="600123456" />
</HotelReservationIDs>
<Profiles>
<ProfileInfo>
<Profile ProfileType="18">
<Customer Gender="Unknown">
<PersonName>
<GivenName>Booker</GivenName>
<Surname>Name</Surname>
</PersonName>
<Telephone PhoneNumber="+31182751118" />
<Email>support@smarthotel.nl</Email>
<Address FormattedInd="false">
<AddressLine>Einsteinstraat 5-7</AddressLine>
<CityName>Reeuwijk</CityName>
<PostalCode>2811EP</PostalCode>
<CountryName>NL</CountryName>
</Address>
</Customer>
</Profile>
<UniqueID ID="5678" Type="1" />
</ProfileInfo>
</Profiles>
<TotalCommissions>
<CommissionPayableAmount DecimalPlaces="2" Amount="10206" />
</TotalCommissions>
<BasicPropertyInfo HotelCode="12345" />
</ResGlobalInfo>
</HotelReservation>
</ReservationsList>
</OTA_ResRetrieveRS>
OTA_HotelResModifyRQ/RS.
The OTA_HotelresModifyRQ is the answer from the PMS to The OTA_ResRetrieveRS. With this response the status in the channel manager will be set to ‘retrieved’ and it will not be returned to the PMS usless a specific request is sent from the PMS to the channel manager.
OTA_HotelResModifyRQ
| Element / @Attribute | Parent | Info | Values | Occurrence |
|---|---|---|---|---|
| HotelResModifies | OTA_HotelResModifyRQ | A collection of reservations to be modified. Full structure of a hotel reservation modification. | 1 | |
| HotelResModify | HotelResModifies | The reservation to commit. | 1..n | |
| @ResStatus | HotelResModify | Indicates the status of the reservation. | Commit / Request Denied | 1 |
| RoomStays | HotelResModify | The optional collection of room stays for which the modification should be made. If omitted, modifications will be made on the entire reservation. | 0..1 | |
| RoomStay | RoomStays | Details on the Room Stay. One RoomStays element can contain multiple RoomStay elements. | 1..n | |
| @IndexNumber | RoomStay | Number of the room stay within the RoomStays collection. | 1 | |
| ResGlobalInfo | HotelResModify | ResGlobalInfo is a container for various information that affects the Reservation as a whole. These include global comments, counts, reservation IDs, loyalty programs, and payment methods. | 1 | |
| BasicPropertyInfo | ResGlobalInfo | Property information for the reservation. An abbreviated short summary of hotel descriptive information. | 1 | |
| @HotelCode | BasicPropertyInfo | The ID of the hotel. | [integer] | 1 |
| HotelReservationIDs | ResGlobalInfo | A Collection of HotelReservationID objects for a given reservation. | 1 | |
| HotelReservationID | HotelReservationIDs | The HotelReservationID object contains various unique (ReservationID) identifiers that the trading partners associate with a given reservation. | 1 | |
| @ResID_Value | HotelReservationID | The ID of the reservation. | [integer] | 1 |
| @ResID_Type | HotelReservationID | Defines the type of Reservation ID. | 14 = Reservation | 1 |
Example 1: “Reservation level”
<?xml version="1.0" encoding="UTF-16"?>
<OTA_HotelResModifyRQ 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>
<HotelResModifies>
<HotelResModify ResStatus="Commit">
<ResGlobalInfo>
<BasicPropertyInfo HotelCode="21052" />
<HotelReservationIDs>
<HotelReservationID ResID_Value="123456" ResID_Type="14" />
</HotelReservationIDs>
</ResGlobalInfo>
</HotelResModify>
</HotelResModifies>
</OTA_HotelResModifyRQ>
Example 2: “Room stay level”
<?xml version="1.0" encoding="UTF-16"?>
<OTA_HotelResModifyRQ 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>
<HotelResModifies>
<HotelResModify ResStatus="Commit">
<RoomStays>
<RoomStay IndexNumber="123" />
</RoomStays>
<ResGlobalInfo>
<BasicPropertyInfo HotelCode="21052" />
<HotelReservationIDs>
<HotelReservationID ResID_Value="123456" ResID_Type="14" />
</HotelReservationIDs>
</ResGlobalInfo>
</HotelResModify>
</HotelResModifies>
</OTA_HotelResModifyRQ>
OTA_HotelResModifyRS
This is the response message for the reservation commit.
| Element / @Attribute | Parent | Info | Values | Occurrence |
|---|---|---|---|---|
| HotelResModifies | OTA_HotelResModifyRS | A collection of reservations which have been modified. Full structure of a hotel reservation modification. | 1 | |
| HotelResModify | HotelResModifies | The reservation that was committed. | 1..n | |
| @ResStatus | HotelResModify | Indicates the status of the reservation. | Commit / Request Denied | 1 |
| ResGlobalInfo | HotelResModify | ResGlobalInfo is a container for various information that affects the Reservation as a whole. These include global comments, counts, reservation IDs, loyalty programs, and payment methods. | 1 | |
| BasicPropertyInfo | ResGlobalInfo | Property information for the reservation. An abbreviated short summary of hotel descriptive information. | 1 | |
| @HotelCode | BasicPropertyInfo | The ID of the hotel. | [integer] | 1 |
| HotelReservationIDs | ResGlobalInfo | A Collection of HotelReservationID objects for a given reservation. | 1 | |
| HotelReservationID | HotelReservationIDs | The HotelReservationID object contains various unique (ReservationID) identifiers that the trading partners associate with a given reservation. | 1 | |
| @ResID_Value | HotelReservationID | The ID of the reservation. | [integer] | 1 |
| @ResID_Type | HotelReservationID | Defines the type of Reservation ID. | 14 = Reservation | 1 |
<?xml version="1.0" encoding="UTF-16"?>
<OTA_HotelResModifyRS EchoToken="Example123" PrimaryLangID="eng" Target="Production" TimeStamp="2018-07-29T07:38:54.729Z" Version="1.0">
<Success />
<HotelResModifies>
<HotelResModify ResStatus="Commit">
<ResGlobalInfo>
<BasicPropertyInfo HotelCode="21052" />
<HotelReservationIDs>
<HotelReservationID ResID_Value="123456" ResID_Type="14" />
</HotelReservationIDs>
</ResGlobalInfo>
</HotelResModify>
</HotelResModifies>
</OTA_HotelResModifyRS>
Deposits.
The message that Smarthotel will send to partners to notify them about a deposit that has been made on a reservation.
OTA_HotelResModifyRQ (deposits)
This is the message for the reservation deposit.
| Element / @Attribute | Parent | Info | Values | Occurrence |
|---|---|---|---|---|
| HotelResModifies | OTA_HotelResModifyRQ | A collection of reservations to be modified. Full structure of a hotel reservation modification. | 1 | |
| HotelResModify | HotelResModifies | The reservation to commit. | 1 | |
| UniqueID | HotelResModify | An identifier used to uniquely reference an object in a system. | 1 | |
| @ID | UniqueID | The ID of the confirmation. | 1 | |
| @Type | UniqueID | Defines the type of UniqueID. | 14 = Reservation | 1 |
| ResGlobalInfo | HotelResModify | ResGlobalInfo is a container for various information that affects the Reservation as a whole. These include global comments, counts, reservation IDs, loyalty programs, and payment methods. | 1 | |
| HotelReservationIDs | ResGlobalInfo | A Collection of HotelReservationID objects for a given reservation. | 1 | |
| HotelReservationID | HotelReservationIDs | The HotelReservationID object contains various unique (ReservationID) identifiers that the trading partners associate with a given reservation. | 2 | |
| @ResID_Value | HotelReservationID | The ID of the confirmation. | 1 | |
| @ResID_Type | HotelReservationID | Defines the type of Reservation ID. | 5 = Travel agent 14 = Reservation | 1 |
| DepositPayments | ResGlobalInfo | A collection of deposit and/or payments.A collection of required payments. | 1 | |
| GuaranteePayment | DepositPayments | Used to define the deposit policy, guarantees policy, and/or accepted forms of payment. | 1 | |
| @GuaranteeCode | GuaranteePayment | The code of the guarantee. | 1 | |
| @PaymentCode | GuaranteePayment | The code of the payment. | Deposit | 1 |
| AmountPercent | GuaranteePayment | The deposit expressed as a fixed amount. | 1 | |
| @Amount | AmountPercent | The deposit amount. | 1 | |
| @CurrencyCode | AmountPercent | An ISO 4217 (3) alpha character code that specifies a monetary unit. | 1 | |
| @DecimalPlaces | AmountPercent | The ISO 4217 standard "minor unit" for the number of decimal places for a particular currency. | 2 | 1 |
| Description | GuaranteePayment | Text description of the payment. | 1 | |
| Text | Description | The text content. | 1 | |
| BasicPropertyInfo | ResGlobalInfo | Property information for the reservation. An abbreviated short summary of hotel descriptive information. | 1 | |
| @HotelCode | BasicPropertyInfo | The ID of the hotel. | 1 |
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelResModifyRQ EchoToken="Example123" TimeStamp="2018-07-29T07:38:54.729Z" Version="1.0" ResStatus="Modify">
<POS>
<Source>
<RequestorID ID="APIKEY" MessagePassword="APIPASSWORD"/>
</Source>
</POS>
<HotelResModifies>
<HotelResModify>
<ResGlobalInfo>
<HotelReservationIDs>
<HotelReservationID ResID_Type="14" ResID_Value="123456" />
<HotelReservationID ResID_Type="5" ResID_Value="7890" />
</HotelReservationIDs>
<DepositPayments>
<GuaranteePayment GuaranteeCode="1111" PaymentCode="Deposit" >
<AmountPercent Amount="15000" CurrencyCode="EUR" DecimalPlaces="2" />
<Description>
<Text>Payment method</Text>
</Description>
</GuaranteePayment>
</DepositPayments>
<BasicPropertyInfo HotelCode="21052" />
</ResGlobalInfo>
</HotelResModify>
</HotelResModifies>
</OTA_HotelResModifyRQ>