7.1. RESERVATION INITIATE REQUEST

PrimaryLangID

For more information see Common Data Description section in Glossary.

0...1

ResStatus*

string (“Initiate”)

Must be “Initiate“ for that step.

1...1

ExcursionReservations/ExcursionReservation*

Includes booking information.

1...1

Excursions/Excursion*

Contains information about the excursion.

1...*

Excursions/Excursion/ExcursionRates/ExcursionRate*

Describes the offer to book.

1...1

Excursions/Excursion/Departure

If Departure elements were returned in Availability response, then they must be specified the departure point in Reservation Initiate request. It can not be changed in confirmation step. Information about possible Departure points should be taken from Excursion Availability response.

If there was no Departure element in Availability response, then the Departure also must be skipped in Reservation requests.

0...1

ResGuests/ResGuest*

Describes passengers’ profiles. There must be a <ResGuest> element for each passenger.

1...*

ResGlobalInfo*

Contains global details regarding the reservation (of a single reservation in reservation basket).

1...1

RPH*

integer

Must be always 1.

1...1

BookingCode*

string

Specifies booking code of selected offer (from availability response). It will specify exact excursion, date and language.

1...1

Services/Service

Could be specified if booking of additional services required.

0...999

SpecialServiceType*

string ("DeliveryToHotel", "DeliveryToAddress", "SelfPickUp", "E-Delivery")

Could have the following values:

“DeliveryToHotel” - requires Guest Full Name, Hotel name, Check-in date, Hotel Address (Incl. zip code);

“DeliveryToAddress” - requires Guest Full Name, Guest home Address (Incl. zip code, City, Province, Country);

“SelfPickUp” - requires Mandatory data only (LeadName, Email, Phone, Country);

“E-Delivery” - requires Mandatory data only (LeadName, Email, Phone, Country).

1…1

ServiceRPH*

string (1 - 32)

Refers to service which is situated in full list.

1...1

Services/Service/Address

Contains information about guest address if SpecialServiceType="DeliveryToAddress".

0...1

Services/Service/Address/AddressLine*

string

1...1

Services/Service/Address/CityName

string

0...1

Services/Service/Address/PostalCode

string (1 – 16)

0...1

Services/Service/Address/CountryName

string

0...1

AdditionalQuestions/AdditionalQuestion

For more information see Reservation Initiate Response section. Additional Question element presents only if questions from supplier were already provided at Excursion Descriptive Info Response. Then at Reservation Initiate Request all answers should be provided in AnswerValues element. Otherwise, the element is missed.

0...*

AdditionalQuestions/AdditionalQuestion/GuestUniqueID

Сontains possible response for remarks with all TypeDescription for specific travelers.

0...*

ID*

integer

Unique remark identifier.

1...1

AdditionalQuestions/AdditionalQuestion/GuestUniqueID/ValidValues/Value

string

Contains the response text for question for specific traveler.

0...*

Code

string

Corresponding to the code from ValidValues/Value element.

0...1

AdditionalQuestions/AdditionalQuestion/GuestUniqueID/AnswerValues/Value*

string

Contains the response text for the question.

1...*

Code

string

Corresponding to the code from ValidValues/Value element.

0...1

AdditionalQuestions/AdditionalQuestion/ValidValues/Value

string

Specifies possible answer for remarks with TypeDescription=” List”.

0...*

Code

string

0...1

AdditionalQuestions/AdditionalQuestion/AnswerValues/Value*

string

Specifies possible answer for remarks with TypeDescription=” List”

1…*

Code

string

0...1

RPH*

integer

Corresponds to Departure/@RPH attribute from Excursion Availability Response.

If the DeparturePoint/@Type in Excursion Availability Response is "MeetingPoint", then it is enough to submit Departure/@RPH in Reservation request, and a StartTime element if it was displayed in Availability response.

If the DeparturePoint/@Type is "PickUp", then the Departure/@RPH is required along with pick up details:

• PickUpAddress element must be specified in case there was a "PickUp" departure point with @AddressSupported="true" in Availability response.

• Hotel element must be specified in case there was a "PickUp" departure point with @HotelCodeSupported="true" in Availability response. If there was a list of hotels supported as pick-up points in Availability response, then one of the hotels must be specified in the reservation request. If the DeparturePoint/@HotelCodeSupported="true", but none Hotel listed in Availability response, then user must specify any hotel code supported by this supplier.

1...1

Departure/StartTime

time hh:mm:ss

Represents excursion start time.

0...1

Departure/Hotel

Contains hotel information.

0...1

HotelName

string

Specifies hotel name.

0...1

HotelCityCode

string

Supplier city code.

0...1

HotelCode*

string

Supplier hotel code.

1...1

HotelCodeContext*

string

Specifies the context the HotelCityCode and HotelCode should be taken from.

1...1

Departure/PickUpAddress

Must be specified in case there was a "PickUp" departure point with @AddressSupported="true" in Availability response.

0...1

Departure/PickUpAddress/AddressLine*

string

Contains information about pick up address.

1...1

Departure/PickUpAddress/CityName

string

0...1

Departure/PickUpAddress/PostalCode

string (1 – 16)

0...1

Departure/PickUpAddress/CountryName

string

0...1

ResGuestRPH*

integer

Shows which excursion this tourist should be assigned. This parameter should correspond to RPH attribute in <ExcursionRate>.

1...1

AgeQualifyingCode

Integer (7, 8, 10)

For more information see Common Data Description section in Glossary.

0...1

PaxTypeCode

string

Contains information about guest type.

0...1

Profiles/ProfileInfo*

1...1

Profiles/ProfileInfo/UniqueID*

A guest identifier.

1...1

ID*

integer

Must start with 1 and must be unique within booking. Guest with ID="1" is marked as tour lead.

1...1

Type*

Integer (1)

A guest type. Refers to OTA Code List Unique ID Type (UIT).

1...1

Profiles/ProfileInfo/Profile/Customer*

Contains basic information about the customer.

1...1

BirthDate

yyyy-mm-dd

Mandatory for children and infants.

0...1

PersonName*

Contains person name.

1...1

PersonName/NamePrefix

string

Name prefix of the guest.

0...1

PersonName/GivenName*

string

Name of the guest, mandatory for TourLead, but could be optional for other guests if supplier allow that.

1...1

PersonName/MiddleName

string

Middle name of the guest, mandatory for TourLead, but could be optional for other guests if supplier allow that.

0...1

PersonName/Surname*

string

Surname of the guest, mandatory for TourLead, but could be optional for other guests if supplier allow that.

1...1

Telephone

Contains information about passenger's phone. It is enough to submit Telephone only for the tour lead.

0...1

CountryCode

string (2 – 3)

Specifies country code.

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

Email

string

Is used if supplier needs to contact a passenger urgently. However, email is required by some suppliers. So, there are two options you can use Email element:

1. Enter an email address of each tourist for supplier can contact them directly.

2. Enter an email address of tour lead only.

3. Skip an email address for all tourists. In that case GP HUB will use fake email in messages to supplier.

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 (1 – 64)

1...1

Code

string (2 – 3)

ISO-2 or ISO-3 country code.

0...1

CitizenCountryName

Mandatory element for specific supplier.

0...2

Code

string (2 – 3)

ISO-2 or ISO-3 country code.

0...1

Comments/Comment/Text*

string

Any free-text comments to be sent to supplier in your booking. Comments will be passed to supplier, but it is not guaranteed that they will be satisfied.

1...1

ExcursionReservationIDs/ExcursionReservationID*

Contains unique identifier of a booking.

1...2

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.

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 or booking retrieval.

1...1