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

VehResRQCore*

Identifies the common, or core, information associated with the request for the reservation of a rental car.

1...1

VehResRQCore/VehRentalCore*

Contains information that is common to all requests and responses associated with the reservation of a car.

1...1

BookingCode*

string (1 - 16)

Unique car rate identifier returned in Car Availability Search Response.

1...1

PickUpDateTime*

yyyy-mm-dd or yyyy-mm-ddThh-mm-ss

Identify The Date & Time to pickup/return a car.

1...1

ReturnDateTime*

yyyy-mm-dd or yyyy-mm-ddThh-mm-ss

1...1

VehResRQCore/ResGuests/ResGuest*

Contains information on the one primary driver and, optionally, several additional drivers.

1...*

VehResRQCore/SpecialEquipPrefs/SpecialEquipPref

Indicates the preferences for one or more specific items of additional equipment, such as ski racks, child seats, etc.

0...15

EquipType*

integer (1 - 4000)

Identifies the specific type of equipment. Refers to OTA Code List Equipment Type (EQP).

1...1

Quantity

integer

Number of equipment items. If not specified, then the default value is “1”.

0...1

VehResRQCore/CoveragePrefs/CoveragePref

Defines a preference for a particular type of insurance coverage for a car.

0...99

Code*

string

Supplier's code for a particular type of coverage. This information is returned in Car Rental Conditions Response.

1...1

Type*

integer (1 - 80)

Identifies coverage type. Possible types you can see at Vehicle Coverage types section.

1...1

VehResRQInfo*

Identifies the supplemental information associated with the request for the reservation of a car.

1...1

ResGuestRPH*

integer (default - 1)

Must be always set to “1“.

1...1

AgeQualifyingCode*

Integer (7, 8, 10)

For more information see Common Data Description section in Glossary.

1...1

Profiles/ProfileInfo/UniqueID*

A driver identifier.

1...1

ID*

integer

Must start with 1 and must be unique within booking. Driver with ID="1" is considered as a lead driver.

1...1

Type*

Integer

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

1...1

Profiles/ProfileInfo/Profile/Customer*

Includes the information about driver.

1...1

BirthDate

yyyy-mm-dd

Attribute is mandatory for all drivers.

0...1

Language

2-character ISO language code

Language of the guest

0...1

Gender

string ("Male", "Female", "Unknown")

Gender of the guest

0...1

PersonName*

Contains drivers name.

1...1

PersonName/NamePrefix

string ("Mr", "Ms", "Mrs")

Name prefix of the driver, mandatory for all drivers.

0...1

PersonName/GivenName*

string

Name of the driver, mandatory for all drivers.

1...1

PersonName/MiddleName

string

Middle name of the driver, mandatory for all drivers.

0...1

PersonName/Surname*

string

Surname of the driver, mandatory for all drivers.

1...1

Telephone

Contains information about driver's phone. It is enough to submit Telephone only for the primary driver.

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)

Driver's phone number.

1...1

PhoneLocationType

integer (6, 7, 8)

Indicates location type for driver'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 driver urgently. However, email is required by some suppliers. Required for the primary driver.

0...5

Address

Contains information about driver's address in the elements inside. It is enough to submit Address only for the primary driver.

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

Address/StateProv

Describes the state.

0...1

StateCode

string

State code.

0...1

CitizenCountryName

Mandatory element for specific supplier.

0...2

Code

string (2 – 3)

ISO-2 or ISO-3 country code.

0...1

ArrivalDetails

Contains details of the arrival, if applicable (in case meeting at airport is required).

0...1

Number*

string

Contains flight number.

1...1

TransportationCode*

string ("14")

Only value "14" (Airplane) is supported.

1...1

ArrivalDateTime*

yyyy-mm-dd or yyyy-mm-ddThh-mm-ss

Indicates arrival date and time.

1...1

ArrivalDetails/ArrivalLocation*

Indicates the arrival location.

1...1

Code*

string (1 - 16)

Contains IATA airport code.

1...1

CodeContext*

string ("IATA")

Must be “IATA” only.

1...1

ArrivalDetails/OperatingCompany

string (2 letter Airline code)

1...1

Comments/Comment

Indicates the preference associated with special needs or requirements of the customer, described using free text.

0...1

Comments/Comment/Text*

string

1...1

CarReservationIDs/CarReservationID*

Unique rental reference. For more information see Unique Identifiers in GP Travel HUB Workflow section in Glossary.

1...*

ResID_Value*

string (1 - 64)

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

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