7.2. CRUISE RESERVATION INITIATE RESPONSE

TransactionStatusCode

string ("Initiate")

Status of the current reservation. Must be always “Initiate” for that step.

0...1

TransactionIdentifier

string (1 - 32)

Unique transaction ID generated by GP Travel HUB. This attribute must be further passed on reservation confirmation or ignore step to identify the booking request.

0...1

PrimaryLangID

For more information see Common Data Description section in Glossary.

0...1

Success

Warning

ReservationInfo*

Contains information about current reservation.

1...1

ResStatus

string ("Requested", "Reserved", "Request denied")

Reservation status that can be one of:

"Reserved" - the cruise was successfully reserved. Anyway ,reservation confirmation request is still required.

"Request denied" - supplier denied this request and cruise can not be booked.

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

0...1

SailingInfo*

Specifies the option to book a cruise offer.

1...1

SailingCode*

string (1 - 64)

Presale code. This code is stored in the database, to obtain information on the next step.

1...1

CodeContext*

string (1 - 128)

Vendor context of the code.

1...1

SailingInfo/SelectedSailing*

For more information see Cruise Availability Search Response section.

1...1

SailingInfo/Information

For more information see Cruise Availability Search Response section.

0...1

SailingInfo/SelectedCategory*

Offer for the specified cabin category.

1...1

PolicyInfo*

Specifies cancellation policy for the offer.

1...1

RPH*

integer (1 - 4)

1...1

PolicyType*

string ("Cancellation", "Modification")

Indicates type of the policy.

1...1

PolicyInfo/Text*

string

Contains policy text information.

1...99

GuestDetails/GuestDetail*

For more information see Cruise Reservation Initiate Request section.

1...99

BookingPayment

0...1

ReservationID*

The same client/agent reservation ID that has been sent in Reservation Initiate Request.

1...2

ID*

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

Instance*

string ("agent", "client")

Allows to pass client (agent) booking reference that is generated by application connecting to GP Travel HUB for identification of each booking.

1...1

GroupCode*

string ("IN", "OV", "BL", "ST")

Contains cabin category group code.

1...1

SupplierGroupCode*

string (1 - 64)

Contains cabin category group code from supplier.

1...1

GroupName*

string (1 - 128)

Contains cabin category group name from supplier.

1...1

PricedCategoryCode*

string (1 - 64)

Contains cabin category code from supplier.

1...1

Name*

string (1 - 128)

Contains cabin category name from supplier.

1...1

DeckRefIDList

list of positive integer

Contains list of deck ids. If more than one, list is : "2”, “3”, 4".

0...1

CategoryDescription

Contains description of cabin category.

0...1

CategoryDescription/Text*

string

Contains text description of cabin category.

1...99

CategoryDescription/Image

any Uri

Contains image description of cabin category.

0...99

PriceInfos/PriceInfo*

Сontains cabin offer description including availability, cabin type, discount and price - the total price of the offer (after discount, if any has been applied).

1...9

SelectedCabin

Contains selected cabin information.

0...1

CabinNumber*

string (1 - 8)

Contains cabin number.

1...1

DeckRefID

positive integer

Contains deck id of the cabin.

0...1

SelectedDining

Contains selected dining information.

0...1

Code*

string (1 - 64)

Contains dining code.

1...1

CodeContext*

string (1 - 32)

Contains context of the dining name.

1...1

Name*

string (1 - 128)

Contains dining name.

1...1

RateName

string (1 - 128)

Defines offer's cabin name.

0...1

RateCode*

string (1 - 255)

Defines offer's cabin type code.

1...1

BookingCode*

string (1 - 16)

Сontains unique ID of the offer. It is required for further reservation of this offer.

1...1

Status*

string ("Requested", "Reserved", "Request denied")

Status of the offer.

1...1

NonRefundable

boolean (default - false)

"True" in case the offer is non-refundable, and supplier notifies about this explicitly.

“False“ in case the offer is refundable , and supplier notifies about this explicitly.

Missing attribute means that there is no clear meaning whether the offer is refundable or not.

0...1

RPH

integer (1-4)

Reference number for the offer (always"1" for the current implementation).

0...1

Rates*

Contains information about rates.

1...1

Rates/Rate*

Contains information about particular rate.

1...99

AgeQualifyingCode

For more information see Common Data Description section in Glossary.

0...1

GuestRefNumber

positive integer

0...1

RateSource*

string ("Calculated", "Provided")

1...1

Rates/Rate/Total*

Contains total price for the age group.

1...1

AmountAfterTax

For more information see Common Data Description section in Glossary.

0...1

AmountBeforeTax

0...1

CurrencyCode*

1...1

DiningPriceInfo

Contains price for selected dining.

0...1

Amount*

For more information see Common Data Description section in Glossary.

1...1

CurrencyCode*

1...1

InclusiveInd

0...1

Total*

Contains total price of the offer.

1...1

AmountAfterTax

For more information see Common Data Description section in Glossary.

0...1

AmountBeforeTax

0...1

CurrencyCode*

1...1

ChargeTypeCode*

1...1

Total/Taxes

Provides information about taxes applied.

0...1

Total/Taxes/Tax*

Defines taxes applied.

1...99

Code

For more information see Common Data Description section in Glossary.

0...1

Amount

0...1

CurrencyCode

0...1

TaxInclusiveInd

0...1

Total/Fees/Fee*

Defines fees applied, attributes are the same as Tax element above.

1...99

TotalRetail*

The total retail price of the offer recommended by supplier (if applicable). The attributes are the same as described in Total element above.

1...1

TotalRetail/Taxes

Provides information about taxes applied.

0...1

TotalRetail/Taxes/Tax*

Defines taxes applied. The attributes are the same as described in Total/Taxes/Tax element above.

1...99

TotalRetail/Fees/Fee*

Defines fees applied, attributes are the same as Tax element above.

1...99

BookingPrices

0...1

BookingPrices/BookingPrice*

1...1

Amount*

For more information see Common Data Description section in Glossary.

1...1

RetailAmount

0...1

CurrencyCode*

1...1

PaymentSchedule

0...1

PaymentSchedule/Payment*

1...1

Amount*

For more information see Common Data Description section in Glossary.

1...1

CurrencyCode*

1...1

DueDate*

date/datetime

1...1

RPH

integer (1 - 4)

0...1

PaymentSchedule/Payment/Remark

string

0...9