10.1. RESERVATION INITIATE REQUEST

PrimaryLangID*

For more information see Common Data Description section in Glossary.

1...1

RequestedCurrency

0...1

TransactionStatusCode*

string ("Initiate")

Indicates the type of request. Must be “Initiate“ for that step.

1...1

AirReservations

Contains information about all reservations to be booked.

0...1

AirReservations/AirReservation

Contains information about one of the reservation to be booked.

0...*

AirReservations/BookingReferenceID

Is used only for multibooking to identify all bookings as a single unit. For multi-booking this attribute is required.

0...1

ID*

string

A unique value of booking reference.

1...1

Instance*

string ("basket")

Indicates type of BookingReference ID. Must always be “basket“.

1...1

ID_Context

string

Contains the supplier's name.

0...1

RPH*

integer

Special identifier of requested offer.

1...1

AirItinerary

Contains flight information.

0...1

BookingCode*

string

Identifies the offer returned in Flight Low Fare Search Response.

1...1

PriceInfo

Contains special formulas for applying different discounts for the offer.

0...1

PriceInfo/FareInfos/FareInfo

Contains requirement for offer price recalculation.

HUB can process different discounts for offer. Element PriceInfo was added to AirBook(Initiate)-request API for using these formulas:

1. Type of formula FXP/ET/RDGXX , where XX-value of discount:

2. Type of formula FXP/ZO- : e.g. S7 FXP/ET/R,VC-S7/ZO-5P*AD05

3. All formulas FXP/RADD,U*ADD0XX have the equivalents in Amadeus system as a corporate code. E.g. ADD005 is 376257. and should be set to HUB API as corporate codes:

0...1

TravelerInfo

Contains information about the travelers for booking.

0...1

TravelerInfo/AirTraveler

Represents each traveler.

0...*

TravelerInfo/SpecialReqDetails

Provides detailed information regarding any special needs, requests, or remarks associated with the traveler. Please note that special requests are never guaranteed.

0...1

Fulfillment/PaymentDetails/PaymentDetail*

Defines form of payment details for the requested booking.

1...1

Fulfillment/PaymentDetails/PaymentDetail/Cash

Indicates payment in cash.

0...1

Fulfillment/PaymentDetails/PaymentDetail/DirectBill

Indicates a direct billing arrangement (form of payment - invoice).

0...1

DirectBillID

string (1 - 32)

Indicates client's invoice code.

0…1

Queues/Queue

Contains all necessary information about one of the queue.

0...10

QueueNumber

string

The identifier specifying the queue on which the booking file resides in the system.

0...1

QueueCategory

string

The category of the queue.

0...1

PseudoCityCode

string

Contains an office ID for the queue. If not specified, then the default office ID from credentials is used.

0...1

BookingReferenceID*

Contains information about reservation identifiers.

1...5

Offer

Contains information about extra service, that are available for booking.

0…1

Offer/Priced

Defines the specific extra service.

0…*

CarrierCode

string

Contains the code of service's owner.

0…1

TravelerRPH

string

The traveler ID to whom the request applies. If attribute is missed then it means that the service is applies to all passengers.

0…1

FlightSegmentRPHList*

string

Contains a list of segments for which the service is applicable (there can be several segments).

1…1

MandatoryInd

boolean

Defines whether the service is mandatory for booking or not.

0…1

Name*

string (“Baggage“, “Seat assignment“, “Meal/Beverage”, “Extra“)

OTA name of service.

1…1

ID*

string

The unique ID of this extra service.

1…1

IsPerBooking

boolean (default - false)

Defines whether the service applies to the entire offer or to a specific passenger.

0..1

Offer/Priced/ServiceFamily*

Description of service.

1…1

Name*

string

Describes the name of particular service.

1…1

Offer/Priced/ServiceFamily/ProductGroup

Contains Code and CodeSource of the service.

0…1

Code

string

0…1

CodeSource

string (“AirlineInternal”, “ATPCO”)

0…1

Offer/Priced/ServiceFamily/ProductGroup/SubGroup

Contains Code and CodeSource of the service.

0…1

Code*

string

1…1

CodeSource*

string (“AirlineInternal”, “ATPCO”)

1…1

Offer/Priced/Pricing*

Provides information about cost of service.

1…1

Amount*

decimal

Cost of service.

1…1

PreTaxAmount

decimal

Cost of service without taxes.

0…1

PricingCurrency*

3 character ISO currency code

Currency in which price is nominated.

1…1

OfferQty*

decimal

Number of similar extras requested.

1…1

Offer/Priced/BookingInstruction

Contains booking and upgrade instructions.

0…1

Offer/Priced/BookingInstruction/SSR_Info

string

Contains code which should be provided for booking.

0…1

SSRCode*

1…1

FareReference

string (0 - 64)

Is used for publish corporate discount.

0...1

AccountCode

string (1 - 32)

Contains corporate code.

0...1

FlightSegmentRPHList

For more information see Common Data Description section in Glossary.

0...1

DiscountPricing

Contains especially interpreted discount formulas.

0...5

Type

string ("Percent")

Type of discount.

0...1

Usage

string ("Plus", "Minus")

If this attribute is passed default value is "Plus".

0...1

Discount

string

The value of requested discount.

0...1

TicketDesignatorCode

string (1 - 16)

Indicates type of discount.

0...1

Text

string (1 - 128)

Contains additional code for special type of formulas.

0...1

FlightSegmentRPHList

For more information see Common Data Description section in Glossary.

0...1

BirthDate

yyyy-mm-dd

Specifies traveler’s birth date. Attribute is mandatory for PassengerTypeCode="CHD", "INF", "INS".

0...1

PassengerTypeCode*

string ("ADT", "CHD", "INF", "INS")

Indicates the Passenger Type Code. Possible values: ADT (adult), CHD (child), INF (infant).

1...1

ProfileRef/UniqueID*

Contains information about passenger's IDs.

1...2

ID*

string 1 - 64

Passenger's ID. In case of the additional UniqueID element contains passenger's ID in client's context.

1...1

Type*

integer

Must always be '1'. In case of the additional UniqueID element must be '18'.

1...1

PersonName*

Contains information about passenger's name. This is used for PNR creation.

1...1

PersonName/NamePrefix

string (“Mr”, “Ms”, “Mrs”)

Identifies passenger's name prefix.

0...1

PersonName/GivenName*

string

Identifies passenger's given name.

1...1

PersonName/MiddleName

0...3

PersonName/Surname*

string

Identifies passenger's surname.

1...1

Telephone

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

0...5

LocationCode

string 3

Indicates location for passenger's phone number.

0...1

PhoneNumber*

string

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

CountryAccessCode

string

Code assigned by telecommunications authorities for international country access identifier.

0...1

AreaCityCode

string

Code assigned for telephones in a specific region, city, or area.

0...1

Email

string

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

0...1

Address

Contains information about passenger's address in the elements inside.

0...1

Address/AddressLine

string

0...1

Address/CityName

string

0...1

Address/PostalCode

string

0...1

Address/StateProv

Describes the state.

0...1

StateCode

string

State code.

0...1

Address/CountryName

Contains country name.

0...1

Code

2-3 character country code

ISO-2 or ISO-3 country code.

0...1

CustLoyalty

Is used for submit the loyalty program that the customer belongs to.

0...5

ProgramID

string

Identifier to indicate the company owner of the loyalty program.

0...1

MembershipID

string

Unique identifier of the member in the program (membership number, account number, etc.).

0...1

VendorCode

string

Airline code that owns custloyalty card.

0...1

Document

Contains information about passenger's document. Three types of document currently supported: passport, visa and Birth Certificate. The Document element is optional, however this must be submitted once at booking creation (Reservation Initiate) or ticketing (Issue Ticket) request.

0...10

DocType

string ("P", "V", "B", "K")

Specifies type of passenger's document. It must be "P" (Passport), "B" (BirthCertificate), “V” (Visa) or "K" (Known Traveler Number).

0...1

DocID

string

The unique number assigned to document (passport or visa).

0...1

DocIssueLocation

string

Indicates the location where the document was issued. This is optional for Passport, and required for Visa.

0...1

DocHolderNationality

string (2 - 3)

The ISO country code of the traveller’s nationality.

0...1

DocIssueCountry

string (2 - 3)

Indicates the ISO country code where the document was issued. This is required for Passport, and optional for Visa.

0...1

BirthCountry

string (2 - 3)

Indicates the ISO country code of traveller’s birth. This attribute is recommended for Visa.

0...1

BirthPlace

string

Specifies the birth place of the document holder. This attribute is required for Visa.

0...1

EffectiveDate

yyyy-mm-dd

Indicates the date the document was issued. This attribute is required for Visa.

0...1

ExpireDate

yyyy-mm-dd

Indicates the date the document is valid to. This attribute is required for Passport.

0...1

Gender

string ("Male", "Female")

Indicates gender of the document holder.

0...1

HolderType

string

Provides the type of document holder. Possible values are “H” (Holder) and “E” (not a Holder, for instance an infant assigned to a parent’s passport). If not specified, then the default value “H” is used.

0...1

PostalCode

string

Indicates the destination location postal code. This attribute is required for Visa.

0...1

DocDestinationCountry

string (2 - 3)

Indicates the ISO country code the document is issued for. This attribute is required for Visa (destination country code).

0...1

DocDestinationLocation

string

Indicates the location the document is issued for. This attribute is required for Visa (destination location address) and must be specified as ADDRESS-CITY-STATE (all caps, separated by hyphens).

0...1

SeatRequests/SeatRequest

Seating requests for each passenger for each air leg of this trip.

0...*

Status

string (“Have Sold”, “Pending confirmation”, “Declined”, “Deferred from wait list”, “Unable to Sale – Have Waitlisted”, “Placing on waitlist - new schedule”, “Cancelled”,
”Waitlisted”)

The status of the request.

SeatNumber

string

Indicates specific seat number in the row. Can be used only with RowNumber.

0...1

RowNumber

string

Indicates specific row number for the seat. Can be used only with SeatNumber.

0...1

SeatCharacteristic

string

Indicates seat characteristic; this must be specified in the same way as the Seat Map response returns.

This attribute can not be used together with SeatNumber and/or RowNumber.

0...1

FlightSegmentRPHList

string

The flight segment RPH to which this request applies. Here must be only one flight segment specified.

0...1

TravelerRefNumberRPHList

string

The traveler ID to whom this request applies. Here must be only one traveler ID specified.

0...1

SeatRequests/SeatRequest/ServiceFare

The total price that the passenger would pay for the service.

0...1

Code*

string ("ADT", "CHD", "INF", "INS")

Indicates the Passenger Type Code. Possible values: ADT (adult), CHD (child), INF (infant).

1...1

Amount

For more information see Common Data Description section in Glossary.

0...1

CurrencyCode

0...1

SpecialServiceRequests/SpecialServiceRequest

Special Service Requests (SSR) for this booking.

0...*

SpecialRemarks/SpecialRemark

Is used for recording the information about the agent, that performs the booking.

0...*

RemarkType

string

For more information see Common Data Description section in Glossary.

0...1

SpecialRemarks/SpecialRemark/Text*

string

Text, assosiated with remark.

1...1

RemarkType

string

Must be set as '33'.

0...1

SpecialRemarks/SpecialRemark/Text*

string

Defines the type of access: "READ ONLY" access, "READ AND WRITE" or "NO ACCESS".

1...1

SpecialRemarks/SpecialRemark/AuthorizedViewers/AuthorizedViewer

Contains information about office.

0...10

ViewerCode*

string

Code of particular office, to which the particular access rights are applied.

1...1

SSRCode*

string

The four alpha position industry code identifying a particular type of special service request.

1...1

FlightSegmentRPHList

string

Specifies the flight segment RPH to which this request applies. To specify several segments, put list of flight segment RPHs separated by spaces (i.e. “12 22”). If empty then the request applies for all segments.

0...1

TravelerRefNumberRPHList

string

Specifies the traveler ID to whom this request applies. To specify several travelers, put list of traveler IDs separated by spaces (i.e. “1 2”). If not specified, then the request will be splitted for each traveler.

0...1

Airline

string

Contains the airline code to which this request applies. If not specified, then the SSR will be passed to supplier without specific airline, and supplier decides how to apply the request.

0...1

Text*

string

Text associated with remark.

1...1

ServiceFare

The total price that the passenger would pay for the service.

0...1

Amount

For more information see Common Data Description section in Glossary.

0...1

CurrencyCode

For more information see Common Data Description section in Glossary.

0...1

ID*

string

A value of booking reference.

1...1

Instance*

string ("client", "agent")

Indicates type of BookingReference ID. The “client” context means that the ID value is the unique reservation identifier in the client system. The “agent” context means that the ID value is the reservation identifier which client wants to use in communication with supplier.

At the reservation creation, it is necessary to specify at least “client” BookingReferenceID, but it is better to specify both. If the “agent” BookingReferenceID not specified explicitly, then GP Travel HUB uses the ”client” ID value.

The “client” ID further works as unique booking reference in all GP Travel HUB messages.

1...1