Versions Compared

Version Old Version 8 New Version Current
Changes made by

Yana Brilevskaya

Yana Brilevskaya

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Reservation Initiate Response returns final price and availability of the requested offer.

GP_ExcursionResRS*:

*mandatory

Element

Attribute

Type

Description

Min…Max occurs

TransactionIdentifier

Unique transaction ID generated by GP HUB. This attribute must be further passed on Step 2 to identify the booking request.

0...1

Success

For more information see Common Data Description section in Glossary.

0...1

Warnings/Warning

For more information see Common Data Description section in Glossary.

0...99

ExcursionReservations/ExcursionReservation*

Include booking information.

1...1

ResStatus*

string (“Reserved”, “Request denied”, “Requested”)

The reservation status. Can be:

"Reserved" - means that excursion is available and can be booked.

"Request denied" - means that supplier denied this request and excursion can not be booked.

"Requested" - means that GP Hub has done best effort to ensure that excursion can be booked, however, this status doesn't guarantee, that excursion will be booked. This status usually denotes that supplier doesn't support two-pass booking.

1...1

ExcursionReservations/ExcursionReservation/Excursions/Excursion*

Contains information about the excursion.

1...*

ExcursionReservations/ExcursionReservation/ResGuests/ResGuest*

For more information see Reservation Initiate Request section.

1...*

ExcursionReservations/ExcursionReservation/ResGlobalInfo*

For more information see Reservation Initiate Request section.

1...1

GP_ExcursionResRS/ExcursionReservations/ExcursionReservation/Excursions/Excursion*:

Element

Attribute

Type

Description

Min…Max occurs

ExcursionRates/ExcursionRate*

Describes excursion offer.

Elements are the same as in Excursion Availability Response, but there are no ExcursionDate, AvailableTicketQuantities, CitizenCountryName and PersonName elements and ExcursionRates/ExcursionRate/NonRefundable attribute. Also some elements are added:

1...*

RPH*

integer (1)

Must always be 1.

1...1

FreeCancellationDeadline

yyyy-MM-dd,
yyyy-MM-dd'T'hh-MM-ss or yyyy-MM-dd'T'hh:MM:ssXXX

Shows the last date and time of cancellation without penalty for refundable offers.

0...1

ExcursionRates/ExcursionRate/AdditionalQuestions/AdditionalQuestion

Remarks from supplier.

Info

Note: This functionality supported for limited suppliers. Please check with GP Travel HUB development if you are interested in specific supplier.

0...*

ExcursionRates/ExcursionRate/CancelPenalties/CancelPenalty*

For more information see Excursion Charges Response section.

1...*

ExcursionDate*

For more information see Common Data Description section in Glossary.

1...1

Services/Service

For more information see Excursion Availability Response section.

Info

Note: Reservation Initiate Response will return ONLY services that were requested at Reservation Initiate Request, not all the services available.

0...999

Departure

For more information see Excursion Availability Response section.

0...1

Total*

Total offer price for all requested travelers.

1...1

AmountAfterTax*

For more information see Common Data Description section in Glossary.

1...1

CurrencyCode*

1...1

Total/Taxes/Tax

For more information see Excursion Availability Response section.

0...100

BasicExcursionInfo*

For more information see Excursion Availability Response section.

Info

Please. note, that MultimediaDescription and Departure elements are not included in BasicExcursionInfo.

1…1

...

Element

Attribute

Type

Description

Min…Max occurs

ID*

string (1 – 32)

Contains unique remark identifier.

1...1

TypeDescription

string (“Boolean”, “Numeric”, “NumericRange”, “Text”, “RegExpText”, “List”)

Contains short description of remark type. For more information see "Remark Types" in Glossary.

0...1

TypeID*

integer (1 – 6

Contains unique remark type identifier. The attribute can be set to 1, 2, 3, 4, 5, 6. For more information see "Remark Types" in Glossary.

1...1

QuestionText*

string

Contains remark text.

1...1

DepartureRPHList

string

In case the value of the “IsMandatory” attribute is set to false, the DepartureRPHList attribute can contain a list of Departure RPHs for which the remark is mandatory. Presented only in the Excursion Descriptive Info response.

0…1

IsConditional

boolean (default - false)

Specifies if the remark is conditional. If it is set to "true", the remark is conditional and whether you need to answer it depends on the answer to questions with TypeDescription=”ConditionalList”.

0…1

IsPerPerson

boolean

Specifies if the remark is related to the whole offer or it is related to each guest individually. If it is set to "true", the remark is related to each guest individually. If it is set to "false", the remark is related to the whole offer.

0...1

IsMandatory*

boolean

Specifies if the remark is mandatory. If it is set to "true", the remark is mandatory. If it is set to "false", the remark isn't mandatory.

1...1

MinValue

integer

Specifies min values for remarks with TypeDescription=”NumericRange”.

0...1

MaxValue

integer

0...1

RegExpValue

string

Specifies regex for remarks with TypeDescription=” RegExpText”. RegExpValue can take on values ([A-Z]{2}).

0...1

MultiSelection

boolean

Attribute for remarks with TypeDescription=” List”. The attribute specifies whether it is allowed to choose multiple between the options from the list of ValidValues. If it is set to "true", multiple choice is allowed. If it is set to "false", multiple choice isn't allowed.

0...1

GuestUniqueID

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

0...*

ID*

integer

Unique remark identifier.

1...1

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

ConditionalValues/ConditionalValue

 

 

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

0...*

ConditionalValues/ConditionalValue/Value

 

string

Specifies possible answer value for remarks with TypeDescription=”ConditionalList”.

0...1

 

Code

string

0...1

ConditionalValues/ConditionalValue/MandatoryQuestions*

 

 

Сontains a list of remarks that need to be additionally answered depending on the answer for the remark with TypeDescription=”ConditionalList”.

1…1

ConditionalValues/ConditionalValue/MandatoryQuestions/MandatoryQuestion*

 

 

Сontains a remark that needs to be additionally answered depending on the answer for the remark with TypeDescription=”ConditionalList”.

1...*

 

ID*

integer

Unique remark identifier.

1...1

GuestUniqueID/AnswerValues/Value*

string

Contains the response text for the question.

1...*

Code

string

Corresponding to the code from ValidValues/Value element.

0...1

ValidValues/Value

string

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

0...*

Code

string

0...1

ValidValues/Value

string

Specifies possible answer for remarks with TypeDescription=” List”

0...*

Code

string

0...1

...