Tabular overview of all nodes, which may occur in this message. See legend below for description of table columns.
Note: Some sibling elements or complete sub-trees of the hierarchy may be defined as mutually exclusive alternative choices. This information cannot be expressed in this tabular overview. Please refer to schema diagram for a graphical representation of the message schema.
| Node | Description | Values | Occurs | Example |
|---|---|---|---|---|
<CarAvailabilityRQ> | Car availability request root element | 1 | ||
@version | Version number. | 0..1 | 1.0 | |
@Lang | ISO language code. A two letter code as defined by ISO-639-1. This code specifies the requested language for text content. Default value is 'en'. | 0..1 | ||
@Source | Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. | 0..1 | 1A, 1V, or other. | |
@NumberOfAlternates | Maximum number of options requested. The service will collect options until this number is reached or the provider returns no more options (whatever happens first). The resulting set of options will be returned to the client. CAUTION: Depending on the value this can be a time consuming transaction! Values are: Either a positive integer value identifying the number of requested options or 'ALL' to retrieve all of them. | 0..1 | ||
@Timeout | Timeout in seconds. Only supported by some adapters which send multiple parallel backend requests to gather information for the XX/1 response. If a timeout is specified, XX/1 will only wait for the specified number of seconds for the parallel backend requests to complete. Information from backend requests which have not completed when the timeout is reached are ignored in the XX/1 response without issuing an error message. | 0..1 | 3 | |
<PickUp> | Pick up information group | 1 | ||
<Location> | Specification of car vendor location(s) to search for. | 1 | ||
<CityCode/> | IATA 3-letter city/airport code for location. In case of non-airport location Category need to be present (Number for particular locaction). | 1 | NYC | |
<Category/> | Car location category. Values are: T = Airport terminal O = Off-airport C = City location P = Port X = Rail N = North suburban E = East suburban S = South suburban W = West suburban A = All suburban locations R = Resort location D = default location for the city F = Chauffeur Drive Station * = content of Number element contains complete location code (city code is ignored) | [A] [C] [D] [E] [F] [N] [O] [P] [R] [S] [T] [W] [X] [*] | 1 | T |
<Number/> | Location number used to identify specific rental location within a location category. | 0..1 | 001 | |
</Location> | ||||
<Date/> | Specifies pick up or drop of date in ISO 8601 format (YYYY-MM-DD). | 1 | 2001-12-25 | |
<Time/> | Specifies pick up or drop off time in ISO 8601 twenty-four hour format. | 1 | 14:00 | |
</PickUp> | ||||
<DropOff> | Drop off information group | 1 | ||
<Location> | Specification of car vendor location(s) to search for. | 1 | ||
<CityCode/> | IATA 3-letter city/airport code for location. In case of non-airport location Category need to be present (Number for particular locaction). | 1 | NYC | |
<Category/> | Car location category. Values are: T = Airport terminal O = Off-airport C = City location P = Port X = Rail N = North suburban E = East suburban S = South suburban W = West suburban A = All suburban locations R = Resort location D = default location for the city F = Chauffeur Drive Station * = content of Number element contains complete location code (city code is ignored) | [A] [C] [D] [E] [F] [N] [O] [P] [R] [S] [T] [W] [X] [*] | 1 | T |
<Number/> | Location number used to identify specific rental location within a location category. | 0..1 | 001 | |
</Location> | ||||
<Date/> | Specifies pick up or drop of date in ISO 8601 format (YYYY-MM-DD). | 1 | 2001-12-25 | |
<Time/> | Specifies pick up or drop off time in ISO 8601 twenty-four hour format. | 1 | 14:00 | |
</DropOff> | ||||
<Preferences> | Preferences group | 0..1 | ||
@UnlimitedMileKm | Unlimited Miles/Kilometers indicator. Values are: Y = Yes (return only offers with unlimited miles/km) N = No (return all) | [Y] [N] | 0..1 | Y Default: N |
<CarVendorCode> | Car vendor code for vendor specific search. Restrictions: - Amadeus supports up to 5 codes. - Sabre supports up to 50 codes. | 0..N | ZI | |
@LinkType | Link Type. Values are: GCM = Galileo carmaster only participant GCO = Galileo carmaster only participant secondary GLP = Galileo link partner GLO = Galileo link partner secondary GIA = Galileo inside availability link GIO = Galileo inside availability link secondary ASA = Amadeus standard access ACA= Amadeus complete access ACP= Amadeus complete access plus SDA= Sabre direct connect access SDC= Sabre direct connect sell SOL= Sabre other link type WAP= WebSphereDIR WMP= WebSphereDIR WNA= WebSphereDIR AMADEUS default is ASA | [GCM] [GCO] [GLP] [GLO] [GIA] [GIO] [ASA] [ACA] [ACP] [SDA] [SDC] [SOL] [WAP] [WMP] [WNA] | 0..1 | ASA |
</CarVendorCode> | ||||
<LinkType/> | Link Type. Values are: GCM = Galileo carmaster only participant GLP = Galileo link partner GIA = Galileo inside availability link ASA = Amadeus standard access ACA= Amadeus complete access ACP= Amadeus complete access plus SDA= Sabre direct connect access SDC= Sabre direct connect sell SOL= Sabre other link type WAP= WebSphereDIR WMP= WebSphereDIR WNA= WebSphereDIR AMADEUS default is ASA | [GCM] [GLP] [GIA] [ASA] [ACA] [ACP] [SDA] [SDC] [SOL] [WAP] [WMP] [WNA] | 0..1 | ASA |
<CarType> | Car type code for car type specific search. GDS use car types defined by standard interline practicesand procedures (SIPP) manual. Each car-type code consists of four letters, one letter from each of the following categories : - CLASS - TYPE - SHIFT - AIR CONDITIONING. i.e. ECMR = Economy Class + 2/4 Door Car + Manual Transmisson + Air-Conditioning. You can use asterisks, in any position, to indicate all. So to search for any car so long as it is automatic, enter: **A* . You can use up to 3 asterisks ( **** not allowed). CLASS: M = Mini N = Mini Elite E = Economy H = Economy Elite C = Compact D = Compact Elite I = Intermediate J = Intermediate Elite S = Standard R = Standard Elite F = Full Size G = Full Size Elite P = Premium U = Premium Elite L = Luxury W = Luxury Elite O = Oversize X = Special TYPE: B = 2-3 DOOR CAR C = 2/4 DOOR CAR D = 4-5 DOOR CAR E = COUPE F = SUV G = CROSSOVER H = MOTOR HOME J = OPEN AIR ALL TERRAIN K = COMMERCIAL VAN/TRUCK L = LIMOUSINE M = MONOSPACE N = ROADSTER P = PICK UP REGULAR CAB Q = PICK UP EXTENDED CAB R = RECREATIONAL VEHICLE S = SPORT T = CONVERTIBLE V = PASSENGER VAN W = WAGON/ESTATE X = SPECIAL Y = 2 WHEEL VEHICLE Z = SPECIAL OFFER CAR TRANSMISSION/DRIVE TYPES: M = MANUAL UNSPECIFIED DRIVE N = MANUAL 4WD C = MANUAL AWD A = AUTOMATIC UNSPECIFIED DRIVE B = AUTOMATIC 4WD D = AUTOMATIC AWD FUEL/AIR CONDITIONING: R = UNSPECIFIED FUEL/POWER WITH AIR CONDITIONING N = UNSPECIFIED FUEL/POWER WITHOUT AIR CONDITIONING D = DIESEL WITH AIR CONDITIONING Q = DIESEL WITHOUT AIR CONDITIONING H = HYBRID WITH AIR CONDITIONING I = HYBRID WITHOUT AIR CONDITIONING E = ELECTRIC WITH AIR CONDITIONING C = ELECTRIC WITHOUT AIR CONDITIONING L = LPG/COMPRESSED GAS WITH AIR CONDITIONING S = LPG/COMPRESSED GAS WITHOUT AIR CONDITIONING A = HYDROGEN WITH AIR CONDITIONING B = HYDROGEN WITHOUT AIR CONDITIONING M = MULTI FUEL/POWER WITH AIR CONDITIONING F = MULTI FUEL/POWER WITHOUT AIR CONDITIONING V = PETROL WITH AIR CONDITIONING Z = PETROL WITHOUT AIR CONDITIONING U = ETHANOL WITH AIR CONDITIONING X = ETHANOL WITHOUT AIR CONDITIONING | 0..N | ECAR | |
@CodeType | Type of the CarType code. If not specified the specified CarType is handled as SIPP code. For systems that dont support SIPP codes the vendorspecific type must be used instead. Values: SIPP .. SIPP code VS .. vendor specific code | [SIPP] [VS] | 0..1 | |
</CarType> | ||||
<RateOptions> | Rate options group | 0..1 | ||
@Type | Rate Type. Values are: D = Daily E = Weekend W = Weekly M = Monthly H = Hourly. | [D] [E] [W] [M] [H] | 0..1 | W |
@Category | Rate Category. Values are: A = Association B = Business standard C = Corporate G = Government I = Industry (Travel) K = Package L = Inclusive P = Promotiona R = Credential S = Standard U = Consortium V = Convention X = Negotiated. | [A] [B] [C] [G] [I] [K] [L] [P] [R] [S] [U] [V] [X] | 0..1 | S |
@Guarantee | Guarantee rate requested. Values are: Y = Yes (return only guaranteed rates) N = No (return all rates) | [Y] [N] | 0..1 | Y Default: N |
<RateCode/> | Requested rate code. | 0..1 | STD | |
<CorporateDiscount> | Corporate discount group | 0..N | ||
<CorporateVendorCode/> | Corporate discount vendor code. | 0..1 | AXD | |
<DiscountNumber/> | Corporate discount number. | 1 | C0001 | |
</CorporateDiscount> | ||||
<FrequentGuest> | 0..3 | |||
<FGCode/> | Frequent guest provider code. Use this element only if you do not perform single vendor availability search | 0..1 | ||
<FGNumber/> | Frequent guest number. | 1 | 123456 | |
</FrequentGuest> | ||||
<FrequentFlyer> | Frequent Flyer Group | 0..3 | ||
<FFCode/> | Frequent flyer code. | 1 | DL | |
<FFNumber/> | Frequent flyer number. | 1 | 0956301007 | |
</FrequentFlyer> | ||||
<Tour> | Tour numbers. | 0..3 | ||
<TourVendorCode/> | Car vendor company code with which the tour number as defined in the TourNumber element is contracted. | 0..1 | HZ | |
<TourNumber/> | Tour number/code. | 1 | ||
</Tour> | ||||
<Promotion> | Promotion number/code information. | 0..N | ||
<PromotionVendorCode/> | Car vendor company code to which the promotion number as defined in the PromotionNumber element is applicable. | 0..1 | HZ | |
<PromotionNumber/> | Promo number/code. | 1 | ||
</Promotion> | ||||
<CurrencyCode> | 0..1 | |||
</CurrencyCode> | ||||
<Range> | Rate range group | 0..1 | ||
<LowerLimit/> | Lower limit for a rate range search. | 0..1 | 100 | |
<UpperLimit/> | Upper limit for a rate range search. | 0..1 | 300 | |
</Range> | ||||
</RateOptions> | ||||
<OptionalEquipment> | OTA Equipment type code. | 0..N | 1 | |
@Type | OTA code type. EQP .. Equipment type VS .. Vendor specific code | [EQP] [VS] | 1 | |
@Quantity | number of equipment items, i.e. number of child seats. | 0..1 | ||
</OptionalEquipment> | ||||
</Preferences> | ||||
<MoreCarsToken/> | Token used to request more cars. In some cases it is a number obtained from the GDS from a previous car availability response, while in other cases, it could contain the Yes or No indication of more cars. | 0..1 | 124523467899 or Y. | |
<DriverGroup> | Defines driver specific information. | 0..1 | ||
<Driver> | 1 | |||
@Age | Traveler age. | 0..1 | 20 | |
@CountryOfResidency | Optional. Could be used to add ISO 2-Letter code to identify country of residency. | 0..1 | US | |
@DateOfBirth | Traveler birth date in ISO 8601 format (yyyy-mm-dd). | 0..1 | ||
</Driver> | ||||
</DriverGroup> | ||||
<OutputFilter> | Contains flags which control the creation of specific parts of the output. The flags can e.g. serve to suppress information by setting it to 'N', but also trigger additional processing (including additional backend communication) in order to return some information by setting it to 'Y'. | 0..1 | ||
@OptionalEquipment | For Britz the value N has the effect to avoid additional getExtraHireItems requests. Y .. return optional equipment. N .. do NOT return optional equipment. | [Y] [N] | 0..1 | |
@MakeInformation | Controls whether some vehicle type information (e.g. Capacity, Doors, Make) is returned in CarAvailabilityRS/Cars. Y .. return make information. N .. do NOT return make information. | [Y] [N] | 0..1 | |
</OutputFilter> | ||||
</CarAvailabilityRQ> |
| Column | Description |
|---|---|
| Node | Name of message node (element or attribute). Nodes in bold type are mandatory, if their parent element occurs in the message. Point mouse cursor at table cell to view complete XPath. |
| Description | Description of meaning and usage of the node. |
| Values | List of predefined values (each in square brackets) or range of values ("[a] to [z]") allowed for the node, if formally defined in the schema. |
| Occurs | Minimum and maximum number of times the node must/may occur, if its parent element occurs in the message. Examples: 0..3 Node is optional and may occur up to 3 times. 1..N Node must occur at least one (mandatory) and may occur any number of times. 2 Node must occur exactly twice. |
| Example | Example value for the node. |
XML Schema documentation generated with XX/1 server