Reservation Initiate Request is used to make preliminary reservation of selected offer(s) and get final price(s). This is not real booking yet, but just a quote that will be kept alive in supplier inventory for a limited time (up to 10 minutes).
OTA_HotelResRQ*:
*mandatory
Element | Attribute | Type | Description | Min…Max occurs |
|---|---|---|---|---|
For more information see Common Data Description section in Glossary. | 1...1 | |||
ResStatus* | string ("Initiate") | Status of the current reservation. Must be always “Initiate” for that step. | 1...1 | |
Basket of separate room reservations, each of it defines a specific reservation with a unique client's ResID_Value. After first HotelReservation block comes another (second, third etc). Important note: If in HotelAvail search a client sends a request to search for several rooms within the same guest set (for example for 2 same guest sets Quantity=2), then for every guest set a separate HotelReservation block should be configured, with unique ResGuestRPH and client ResID_Value. | 1...* | |||
HotelReservations/HotelReservationIDs/ HotelReservationID | A mandatory tag for multi-room reservation, that defines a unique basket identifier within all separate room reservations. This element can not be used for a single booking. | 0...1 | ||
ResID_Source* | string ("basket") | Allows to pass client (agent) booking reference that is generated by application connecting to GP Travel HUB for identification of each booking. Has value "basket" for the whole list of room reservations. | 1...1 | |
ResID_Value* | string | A unique identifier of a separate multi-room reservation (basket). | 1...1 |
OTA_HotelResRQ/HotelReservations/HotelReservation*:
Element | Attribute | Type | Description | Min…Max occurs |
|---|---|---|---|---|
Represents room offer in a certain hotel. | 1...1 | |||
Represents guest details. Guest data should be specified for each room reservation. | 1...* | |||
Contains global details regarding the reservation (of a single reservation in reservation basket). | 1...1 |
OTA_HotelResRQ/HotelReservations/HotelReservation/RoomStays/RoomStay*:
Element | Attribute | Type | Description | Min…Max occurs |
|---|---|---|---|---|
RoomRates/RoomRate* | Describes the offer to book. | 1...* | ||
InvBlockCode* | string (default - 1) | A room identifier. Must start from 1 and must be unique within booking. Together with ResGuestRPH this element allows to allocate passengers in rooms. It must be "1" in current implementation. For multi-room reservation InvBlockCode increments within next room reservation. | 1...1 | |
BookingCode* | string | Selected offer identifier which is the same as in Hotel Availabily Response. Specifies which offer you want to book. Important note: One same BookingCode could be set in separate HotelReservation blocks (if they belong to one RPH in HotelAvail RQ). | 1...1 | |
NumberOfUnits* | integer (1) | Always has fixed value =1. | 1...1 | |
Contains additional Services which can be booked with this room. There should be only the Service elements previously received in OTA_HotelAvailRS. | 0...* | |||
For more information see Common Data Description section in Glossary. |
OTA_HotelResRQ/HotelReservations/HotelReservation/RoomStays/RoomStay/RoomRates/RoomRate/Services/Service:
Element | Attribute | Type | Description | Min…Max occurs |
|---|---|---|---|---|
ServiceRPH* | string (1 - 32) | Unique service ID from OTA_HotelAvailRS. | 1...1 | |
For more information see Common Data Description section in Glossary. | ||||
RequiredInd | boolean | Specifies whether the service is mandatory for the client or not. | 0...1 | |
GuestUniqueId | Refers to ResGuest/ProfileInfo/UniqueID/@ID and specified the traveler which the service should be assigned to. The GuestUniqueId is only necessary when the Service/@IsPerRoom="false" in OTA_HotelAvailRS. | 0...99 | ||
Id* | integer 1 - 999 | 1...1 | ||
ServiceDetails/TimeSpan | If specified then it means that user would like to check in or/and check out at time that differs from established by hotel. | 0...1 | ||
Start | hh-mm-ss | Specifies the time of EarlyCheckIn. | 0...1 | |
End | hh-mm-ss | Specifies the time of LateCheckOut. | 0...1 |
OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest*:
Element | Attribute | Type | Description | Min…Max occurs |
|---|---|---|---|---|
For more information see Common Data Description section in Glossary. | 1...1 | |||
ResGuestRPH* | integer (default - 1) | Shows in which room this guest should be allocated. This parameter should correspond to InvBlockCode in RoomRate. | 1...1 | |
Profiles/ProfileInfo/UniqueID* | A guest identifier. | 1...1 | ||
ID | integer (default - 1) | Must start with 1 and must be unique within booking. Guest with ID="1" is marked as tour lead. | 0...1 | |
Type | integer (1) | The required attribute with fixed value "1". | 0...1 | |
Contains basic information about the customer. | 1...1 | |||
ArrivalTransport/TransportInfo | Indicate transportation information for a guest. If the element specified only for the tour lead, then system considers it is applicable for all guest. | 0...1 | ||
Type | string (1 - 16) | Transportation method; GP Travel HUB uses Standard OTA codes "Transportation Code Type (TRP)". | 0...1 | |
ID | string (1 - 32) | Identifier of this transportation method (e.g., flight number). | 0...1 | |
LocationCode | string (1 - 16) | Identifier of the arrival or departure point (e.g., IATA airport code). | 0...1 | |
Time | yy-mm-dd T hh-MM-ss | Time of transportation. Local time of the location indicated by the LocationCode. Here should be time of arrival. | 0...1 | |
DepartureTransport/TransportInfo | Indicate transportation information for a guest. If the element specified only for the tour lead, then system considers it is applicable for all guest. | 0...1 | ||
Type | string (1 - 16) | Transportation method; GP Travel HUB uses Standard OTA codes "Transportation Code Type (TRP)". | 0...1 | |
ID | string (1 - 32) | Identifier of this transportation method (e.g., flight number). | 0...1 | |
LocationCode | string (1 - 16) | Identifier of the arrival or departure point (e.g., IATA airport code). | 0...1 | |
Time | yy-mm-dd T hh-MM-ss | Time of transportation. Local time of the location indicated by the LocationCode. Here should be time of departure. | 0...1 |
OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/Customer*:
Element | Attribute | Type | Description | Min…Max occurs |
|---|---|---|---|---|
BirthDate | yyyy-mm-dd | Mandatory for children and infants. | 0...1 | |
PersonName/NamePrefix* | string ("Mr", "Ms", "Mrs") | Name prefix of the guest. | 1...1 | |
PersonName/GivenName | string (1-64) | Name of the guest, mandatory for TourLead, but could be optional for other guests if supplier allow that. | 0...1 | |
PersonName/Surname | string (1-64) | Surname of the guest, mandatory for TourLead, but could be optional for other guests if supplier allow that. | 0...1 | |
Telephone | Contains information about passenger's phone. It is enough to submit Telephone only for the tour lead. | 0...1 | ||
CountryAccessCode | string (1 - 3) | Code assigned by telecommunications authorities for international country access identifier. | 0...1 | |
AreaCityCode | string (1 - 8) | Code assigned for telephones in a specific region, city, or area. | 0...1 | |
PhoneNumber* | string (1 - 32) | Passenger's phone number. | 1...1 | |
PhoneLocationType | integer (6, 7, 8) | Indicates location type for passenger's phone number. Possible values: 6 (Home), 7 (Office), 8 (Other). | 0...1 | |
PhoneTechType | integer (3, 5) | Indicates type of technology associated with this telephone number. Possible values: 5 (Mobile), 3 (Fax). | 0...1 | |
string (1-128) | Contains information about passenger's email. It is enough to submit Email only for the tour lead. | 0...5 | ||
Address | Contains information about passenger's address in the elements inside. It is enough to submit Address only for the tour lead. | 0...1 | ||
Address/AddressLine* | string (1 - 255) | Mandatory elements if the Address element is requested. | 1...5 | |
Address/CityName* | string (1 - 64) | 1...1 | ||
Address/PostalCode* | string (1 - 16) | 1...1 | ||
Address/CountryName* | string (0 - 64) | 1...1 | ||
Code | 2-3 character country code | ISO-2 or ISO-3 country code. | 0...1 | |
CitizenCountryName | (Self-professed) country that is claimed for citizenship. | 0...2 | ||
Code | 2-3 character country code | ISO-2 or ISO-3 country code. | 0...1 |
OTA_HotelResRQ/HotelReservations/HotelReservation/ResGlobalInfo*:
Element | Attribute | Type | Description | Min…Max occurs |
|---|---|---|---|---|
Comments/Comment/Text | string | Any free-text comments to be sent to supplier in your booking (e.g. you can request to hold an option for the room, or ask rooms with sea-view, etc.). Comments will be passed to supplier, but it is not guaranteed that they will be satisfied. Note: Scheme affords to use multiple Comment element. We advise client to use only one Comment per booking (using this element more than once per booking could produce unexpected results). | 0...1 | |
HotelReservationIDs/ HotelReservationID* | Contains unique identifier of a booking. | 1...10 | ||
ResID_Source* | string ("client", "agent") | Allows to pass client (agent) booking reference that is generated by application connecting to GP Travel HUB for identification of each booking. Important note: agent's id (ResID_Value where ResID_Source=agent) has to have one same value for all the room reservations in the basket. | 1...1 | |
ResID_Value* | string | A value of booking reference that is generated by client application. It is supposed that this ID will be unique in your system. Can be used for further operations like cancellation, modification or booking retrieval. | 1...1 |