2.2. CRUISE AVAILABILITY SEARCH REQUEST
Cruise Availability Search Request is used to get the full list of cruises available at the particular timespan and destination.
OTA_CruiseSailAvailRQ:
*mandatory
Element | Attribute | Type | Description | Min…Max occurs |
---|---|---|---|---|
|
| For more information see Common Data Description section in Glossary. | 0...1 | |
| 0...1 | |||
AvailRatesOnly | boolean | If it is set to "true", it is used to search for available cruises only that could be immediately confirmed. If it is set to "false", it is used to search for all cruises including cruises with "on request" availability. | 0...1 | |
GuestCounts/GuestCount* |
|
| Specifies the number of guests willing to book a cruise offer. | 1...9 |
| For more information see Common Data Description section in Glossary. | 1...1 | ||
Quantity* | int (1 - 9) | Defines a number of passengers for an associated AgeQualifyingCode. | 1...1 | |
Age | int (0 - 150) | Indicates a passenger age. For an adult the attribute is optional; for child and infant it is mandatory. | 0...1 | |
SailingDateRange* |
|
| Specifies a timespan in scope of which it's needed to find a cruise offer. | 1...1 |
MinDuration | duration (PnYnMnDTnHnMnS) | Describes minimum amount of time which a user consider to go for a cruise. | 0...1 | |
MaxDuration | duration (PnYnMnDTnHnMnS) | Describes maximum amount of time which a user consider to go for a cruise. | 0...1 | |
SailingDateRange/StartDateWindow* |
|
| Identifies a start date window for a cruise tour. | 1...1 |
EarliestDate* | date | Specifies the earliest day when a cruise tour might start. | 1...1 | |
LatestDate | date | Specifies the latest day when a cruise tour might start. | 0...1 | |
SailingDateRange/EndDateWindow |
|
| Identifies an end date window of cruise tour. Note: it is not implemeted currently in GP HUB. | 0...1 |
EarliestDate | date | Specifies the earliest day when a cruise tour might end. | 0...1 | |
LatestDate | date | Specifies the latest day when a cruise tour might end. | 0...1 | |
CruiseLinePrefs |
|
| Specifies main cruise preferences. | 0...1 |
CruiseLinePrefs/CruiseLinePref* |
|
| Specifies the cruise preference. | 1...99 |
VendorCode | string (1 - 64) | Specifies a cruise line code. | 0...1 | |
ShipCode | string (1 - 64) | Specifies a ship's code for a cruise. | 0...1 | |
VendorCodeContext | string (1 - 32) | Specifies a cruise line vendor name. | 0...1 | |
CruiseLinePrefs/CruiseLinePref/SearchQualifiers |
|
| Specifies destination preferences for a cruise. | 0...1 |
CruiseLinePrefs/CruiseLinePref/SearchQualifiers/Port |
|
| Contains port information. | 0...2 |
CityCode | string (1 - 64) | Defines a code of a city where the port in located. | 0...1 | |
CityCodeContext | string (1 - 32) | Defines a context where city code would be taken from. | 0...1 | |
PortCode | string (1 - 64) | Defines a code of a port. | 0...1 | |
PortCodeContext | string (1 - 32) | Defines a context where port code would be taken from. | 0...1 | |
PointType* | string ("StartPoint", "IntermediatePoint", "FinishPoint") | Defines a type of a point city/port is considered to be. Once PortCode or CityCode is specified PointType attribute is mandatory. | 1...1 | |
RegionPref |
|
| Specifies region preferences for a cruise. Either SearchQualifiers or RegionPref elements should be set to make a cruise search. | 0...1 |
RegionCode* | string (1 - 64) | Defines a region code of a cruise to take place in. | 1...1 | |
RegionCodeContext* | string (1 - 32) | Defines a context where region code is taken from. | 1...1 |