5.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

TransferReservations/TransferReservation*

Includes booking information.

1...1

TransferReservations/TransferReservation/Transfers/Transfer*

Includes transfer information.

1...1

TransferReservations/TransferReservation/ResGuests/ResGuest*

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

1...*

TransferReservations/TransferReservation/ResGlobalInfo*

Contains global details regarding the reservation.

1...1

TransferRates/TransferRate*

Describes the offer to book.

1...1

RPH*

integer

A transfer identifier. Must start from 1 and must be unique within booking. Together with ResGuestRPH this element allows to allocate passengers in transfers.

1...1

BookingCode*

string

Specifies booking code of selected offer (from availability response). It will specify exact transfer with its specific details.

1...1

TransferRate/AdditionalQuestions/AdditionalQuestion

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

0...*

TransferDate*

For more information see Common Data Description section in Glossary.

1..1

TransferSegments/TransferSegment

Describes Pick-Up and Drop-Off point of the transfer.

0..1

TransferSegments/TransferSegment/TransferPickUpDetails*

There must be only one TransferPickUpDetails element, and only one TransferDropOffDetails element. These elements describe Flight, City Address and Hotel details since only flights, city address and hotel can be used as pickup/destination points in current version.

In case a PickUp (DroppOff) point is Airport, the TransferPickUpDetails (TransferDropOffDetails) element must contain the FlightDetails element that describes the flight.

In case a PickUp (DroppOff) point is a Hotel, the TransferPickUpDetails (TransferDropOffDetails) element must contain the Hotel element.

0..1

TransferSegments/TransferSegment/TransferDropOffDetails*

0..1

FlightDetails

Describes details of a flight.

0..1

FlightNumber*

string with pattern "[0-9A-Z]{1,4}[0-9]{1,6}"

Contains the flight number.

1..1

FlightDateTime*

datetime

Contains flight date and time.

1..1

DepartureCode*

string 3-letter code

Contains IATA airport code.

1..1

ArrivalCode*

string 3-letter code

Contains IATA airport code.

1..1

CodeContext*

string

Always should be IATA.

1..1

Hotel

Describes a Hotel in case a it is a PickUp (DroppOff) point.

0...1

HotelCityCode

string

Contains Hotel city code.

0...1

HotelCode*

string

Hotel code, if you already know it.

1...1

HotelCodeContext*

string

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

1...1

Address

Contains PickUp/DropOff Point Address.

0...1

Address/AddressLine*

string

1...1

Address/CityName

string

0...1

Address/PostalCode

string (1 – 16)

0...1

Address/CountryName

string

0...1

ResGuestRPH*

integer

Shows which transfer this tourist should be assigned.

1...1

AgeQualifyingCode*

Integer (7, 8, 10)

For more information see Common Data Description section in Glossary.

1...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 ("Mr", "Ms", "Mrs")

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

1...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

TransferReservationIDs/TransferReservationID*

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