2.3. CRUISE AVAILABILITY SEARCH RESPONSE
Cruise Availability Search Response contains the full list of cruises available at the particular timespan and destination.
OTA_CruiseSailAvailRS:
*mandatory
Element | Attribute | Type | Description | Min…Max occurs |
---|---|---|---|---|
|
| For more information see Common Data Description section in Glossary. |
| |
|
|
| ||
|
| Specifies the option to book a cruise offer. | 1...999 |
OTA_CruiseSailAvailRS/SailingOptions/SailingOption*:
Element | Attribute | Type | Description | Min…Max occurs |
---|---|---|---|---|
| SailingCode* | string (1 - 64) | Contains presale code to proceed on further steps. | 1...1 |
MaxCabinOccupancy | positive integer |
| 0...1 | |
|
| Describes cruise information - dates, cruise line, ship, region, departure and destination port. | 1...1 | |
CruiseItinInfos* |
|
| Describes cruise itinerary. | 1...1 |
Name* | string (1 - 256) | Contains cruise name. | 1...1 | |
ItineraryCode* | string (1 - 64) | Itinerary code received from supplier. | 1...1 | |
CodeContext* | string (1 - 32) | Context of itinerary code (supplier). | 1...1 | |
CruiseItinInfos/CruiseItinInfo |
|
| Describes all ports for the cruise. | 0...99 |
PortCode* | string (1 - 64) | Identifies port code. | 1...1 | |
PortName* | string (1 - 128) | Identifies port name. | 1...1 | |
PortCodeContext* | string (1 - 32) | Context of port code (supplier) | 1...1 | |
CruiseItinInfos/CruiseItinInfo/DateTimeDescription |
|
| Describes timetable, date and time of departure or arrival. | 0...9 |
DateTimeQualifier* | string ("arrival", "departure", "stay") | Identifies departure or arrival. | 1...1 | |
DateTimeDetails* | datetime | Identifies date time. | 1...1 | |
|
| Contains cruise descriptions, images. | 1...1 | |
FareOptions* |
|
| Contains options to book. | 1...1 |
FareOptions/FareOption* |
|
| Contains 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 information about prices. | 0...1 |
OTA_CruiseSailAvailRS/SailingOptions/SailingOption/SelectedSailing*:
Element | Attribute | Type | Description | Min…Max occurs |
---|---|---|---|---|
| Start* | date | Identifies a start date for a cruise. | 1...1 |
End* | date | Identifies an end date for a cruise. | 1...1 | |
Status | string ("AvailableForSale", "OnRequest", "NoAvailability", "ClosedOut) | Indicates cruise availability. Currently only “AvailableForSale” status is used. | 0...1 | |
CruiseLine* |
|
| Describes cruise line information. | 1...1 |
VendorCode* | string (1 - 64) | Contains cruise line code. | 1...1 | |
VendorName* | string (1 - 64) | Contains cruise line code name. | 1...1 | |
ShipCode* | string (1 - 64) | Identifies ship code. | 1...1 | |
ShipName* | string (1 - 64) | Identifies ship name. | 1...1 | |
VendorCodeContext* | string (1 - 32) | Contains cruise line code name context (supplier). | 1...1 | |
Region* |
|
| Describes cruise region information. | 1...1 |
RegionCode* | string (1 - 64) | Identifies region code. | 1...1 | |
RegionCodeContext* | string (1 - 32) | Context of region code (supplier). | 1...1 | |
RegionName* | string (1 - 64) | Identifies region name. | 1...1 | |
DeparturePort* |
|
| Describes departure information. | 1...1 |
LocationCode* | string (1 - 64) | Identifies start location code. | 1...1 | |
CodeContext* | string (1 - 32) | Context of location code (supplier). | 1...1 | |
EmbarkationDateTime* | datetime | Identifies start date time. | 1...1 | |
ArrivalPort* |
|
| Describes arrival information. | 1...1 |
LocationCode* | string (1 - 64) | Identifies end location code. | 1...1 | |
CodeContext* | string (1 - 32) | Context of location code (supplier). | 1...1 | |
DebarkationDateTime* | datetime | Identifies end date time. | 1...1 |
OTA_CruiseSailAvailRS/SailingOptions/SailingOption/Information*:
Element | Attribute | Type | Description | Min…Max occurs |
---|---|---|---|---|
ImageItems |
|
| Contains images for the cruise. | 0...1 |
|
| Contains image for the cruise. | 1...99 | |
TextItems |
|
| Contains text descriptions for the cruise. | 0...1 |
|
| Contains text description for the cruise. | 1...99 | |
Amenities |
|
|
| 0...1 |
Amenities/Amenity* |
|
|
| 1...200 |
Code | integer (1 - 30) |
| 0...1 | |
SupplierCode* | string (1 - 64) |
| 1...1 | |
Amenities/Amenity/DescriptiveText* |
| string |
| 1...1 |
PublicAreas |
|
|
| 0...1 |
PublicAreas/PublicArea* |
|
|
| 1...200 |
Name* | string (1 - 128) |
| 1...1 | |
DeckRefID | integer |
| 0...1 | |
|
|
| 1...99 | |
|
|
| 1...99 | |
CabinCategories |
|
|
| 0...1 |
CabinCategories/CabinCategory* |
|
|
| 1...99 |
SupplierCategoryCode* | string (1 - 64) |
| 1...1 | |
Name | string (1 - 128) |
| 0...1 | |
DeckRefIDList | integer |
| 0...1 | |
|
|
| 1...99 | |
|
|
| 1...99 | |
Decks |
|
| Contains ship decks information. | 0...1 |
Decks/Deck* |
|
| Contains information about ship deck. | 1...19 |
DeckID* | integer | Contains deck ID from the supplier. | 1...1 | |
DeckNumber | string (1 - 16) | Contains deck number from the supplier. | 0...1 | |
DeckName | string (1 - 64) | Contains deck name from the supplier. | 0...1 | |
|
| Contains deck images. | 0...1 | |
|
| Contains deck text description. | 1...99 | |
Reviews |
|
| Shows the review data. | 0...1 |
Reviews/Review* |
|
| 1...9 | |
ReviewRating* | string (1 - 32) | Rating of cruise, which is tendered by provider of reviews. | 1...1 | |
ReviewsCount | integer | Number of reviews. | 0...1 | |
CodeContext* | string (1 - 32) | Provider of review. | 1...1 |
OTA_CruiseSailAvailRS/SailingOptions/SailingOption/Information/ImageItems/ImageItem*:
OTA_CruiseSailAvailRS/SailingOptions/SailingOption/Information/PublicAreas/PublicArea/ImageItems/ImageItem*:
OTA_CruiseSailAvailRS/SailingOptions/SailingOption/Information/CabinCategories/CabinCategory/ImageItems/ImageItem*:
OTA_CruiseSailAvailRS/SailingOptions/SailingOption/Information/Decks/Deck/ImageItems/ImageItem*:
Element | Attribute | Type | Description | Min…Max occurs |
---|---|---|---|---|
| Title | string (1 - 128) | Image title. | 0...1 |
Category | integer (1 - 23) | Image category.codes: 1- cruise line logo; 2-map; 3- ship. | 0...1 | |
ImageFormat/URL |
| string | Image url. | 1...1 |
OTA_CruiseSailAvailRS/SailingOptions/SailingOption/Information/TextItems/TextItem*:
OTA_CruiseSailAvailRS/SailingOptions/SailingOption/Information/PublicAreas/PublicArea/TextItems/TextItem*:
OTA_CruiseSailAvailRS/SailingOptions/SailingOption/Information/CabinCategories/CabinCategory/TextItems/TextItem*:
OTA_CruiseSailAvailRS/SailingOptions/SailingOption/Information/Decks/Deck/TextItems/TextItem*:
Element | Attribute | Type | Description | Min…Max occurs |
---|---|---|---|---|
| Title | string (1 - 128) | Description title. | 0...1 |
Category | integer (3) | Description category codes. Possible value is 3 only. | 0...1 | |
Description |
| string | Contains description. | 1...1 |
OTA_CruiseSailAvailRS/SailingOptions/SailingOption/FareOptions/FareOption/PriceInfo*:
Element | Attribute | Type | Description | Min…Max occurs |
---|---|---|---|---|
Price* |
|
| The total price of the offer (after discount, if any has been applied). | 1...1 |
| For more information see Common Data Description section in Glossary. | 0...1 | ||
| 0...1 | |||
| 1...1 | |||
| 1...1 | |||
Price/Taxes |
|
| Provides information about taxes applied. | 0...1 |
Price/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 | |||
Price/Fees |
|
| Provides information about fees applied, | 0...1 |
Price/Fees/Fee* |
|
| Defines fees applied, attributes are the same as Tax element above. | 1...99 |
PriceRetail* |
|
| The retail price of the offer recommended by supplier (if applicable). The attributes are the same as described in Price element above. | 1...1 |
PriceRetail/Taxes |
|
| Provides information about taxes applied. | 0...1 |
PriceRetail/Taxes/Tax* |
|
| Defines taxes applied. Attributes are the same as Tax element above. | 1...99 |
PriceRetail/Fees |
|
| Provides information about fees applied, | 0...1 |
PriceRetail/Fees/Fee* |
|
| Defines fees applied, attributes are the same as Tax element above. | 1...99 |