3.2. CRUISE CATEGORY AVAILABILITY SEARCH RESPONSE
Cruise Category Availabilty Search Response shows the final list of cruise offers that could be booked straight away from Cruise Availability Search blocks.
OTA_CruiseCategoryAvailRS*:
*mandatory
Element | Attribute | Type | Description | Min…Max occurs |
---|---|---|---|---|
|
| For more information see Common Data Description section in Glossary. |
| |
|
|
| ||
SailingInfo* |
|
| Specifies the option to book a cruise offer. | 1...1 |
SailingCode | string (1 - 64) | Contains presale code to proceed on further steps. | 1...1 | |
CodeContext | string (1 - 128) | Context of the sailing code (supplier). | 1...1 | |
MaxCabinOccupancy | integer |
| 0...1 | |
|
| For more information see Cruise Availability Search Response section. | 1...1 | |
FareOptions |
|
| Contains options to book. | 0...1 |
FareOptions/FareOption* |
|
| Contains an option to book. | 1...4 |
GroupCode* | string ("IN", "OV", "BL", "ST") | Identified codes of cabin class group. | 1...1 | |
SupplierGroupCode* | string (1 - 64) | Contains codes of cabin class group from supplier. | 1...1 | |
GroupName* | string (1 - 128) | Contains class group name. | 1...1 | |
|
| Contains offer for the specified cabin category. | 1...40 | |
DiningOptions |
|
| The status per dining seating. | 0...1 |
DiningOptions/Dining* |
|
| The dining seating. | 1...99 |
Code* | string (1 - 64) | The dining seating code. | 1...1 | |
CodeContext* | string (1 - 32) | Context of the dining code (supplier). | 1...1 | |
Name* | string (1 - 128) | The dining seating name. | 1...1 | |
Status | string ("AvailableForSale", "OnRequest", "NoAvailability", "ClosedOut) | Status of the dining. Currently only 'AvailableForSale' is used. | 0...1 | |
DiningOptions/Dining/PriceInfo |
|
| Contains the pricing monetary information. | 0...1 |
| For more information see Common Data Description section in Glossary. | 1...1 | ||
| 1...1 | |||
| 1...1 | |||
|
| For more information see Cruise Availability Search Response section. | 0...1 |
OTA_CruiseCategoryAvailRS/FareOptions/FareOption/CategoryOptions/CategoryOption*:
Element | Attribute | Type | Description | Min…Max occurs |
---|---|---|---|---|
| PricedCategoryCode* | string (1 - 64) | Cabin category code from supplier. | 1...1 |
Name* | string (1 - 128) | Cabin category name from supplier. | 1...1 | |
DeckRefIDList | list of positive integer | 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* |
|
| Contains prices information. | 1...1 |
|
| С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 |
OTA_CruiseCategoryAvailRS/FareOptions/FareOption/CategoryOptions/CategoryOption/PriceInfos/PriceInfo*:
Element | Attribute | Type | Description | Min…Max occurs |
---|---|---|---|---|
| SelectCabinInd | boolean | If "true", then the next OTA_CruiseCabinAvailRQ should be done to choose a cabin number. If "false", the cabin is guaranteed. | 0...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 ("AvailableForSale", "OnRequest", "NoAvailability", "ClosedOut) | Status of the offer. Currently only 'AvailableForSale' is used. | 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) | Reference number for the offer (always"1" for the current implementation). | 0...1 | |
PriceDescription |
|
| Contains price description if any. | 0...1 |
PriceDescription/Text* |
|
| Contains text description. | 1...9 |
Title | string (1 - 255) | Desctiption text title. | 0...1 | |
| For more information see Common Data Description section in Glossary. | 0...1 | ||
Rates* |
|
| Contains information about rates. | 1...1 |
Rates/Rate* |
|
| Contains information about particular rate. | 1...99 |
| For more information see Common Data Description section in Glossary. | 0...1 | ||
RateSource* | string ("Calculated", "Provided") |
| 1...1 | |
Rates/Rate/Total* |
|
| Contains total price for the age group. | 1...1 |
| For more information see Common Data Description section in Glossary. | 0...1 | ||
| 0...1 | |||
| 1...1 | |||
Total* |
|
| Contains total price of the offer. | 1...1 |
| For more information see Common Data Description section in Glossary. | 0...1 | ||
| 0...1 | |||
| 1...1 | |||
| 1...1 | |||
Total/Taxes |
|
| Provides information about taxes applied. | 0...1 |
Total/Taxes/Tax* |
|
| Defines taxes applied. | 1...99 |
| For more information see Common Data Description section in Glossary. | 0...1 | ||
| 0...1 | |||
| 0...1 | |||
| 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 |