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 |
|---|---|---|---|---|
<CarAvailabilityRS> | Car availability request root element | 1 | ||
@version | Version number. | 0..1 | 1.0 | |
<InfoGroup> | Error and information group | 0..1 | ||
<ForInfo> | Information group | 0..N | ||
@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. | |
@SourceRef | PNR Record Locator associated to Source attribute. | 0..1 | ||
<Text/> | Information text or error text. | 1..N | Free flow text. Example: Invalid flight number | |
</ForInfo> | ||||
<Error> | Error group | 0..N | ||
@ErrorType | Type of error. | 1 | Air | |
@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. | |
@SourceRef | PNR Record Locator associated to Source attribute. | 0..1 | ||
<Code/> | Error code or equipment type code. | 1 | 0104 (error code), 747 (equipment code) | |
<Text/> | Information text or error text. | 1..N | Free flow text. Example: Invalid flight number | |
<UnderlyingError> | Errors of the backend system can be returned here. | 0..N | ||
@Code | error code of the backend system. | 0..1 | ||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</UnderlyingError> | ||||
</Error> | ||||
<BackOffice> | Generic back office response container. Serves as a placeholder for any context specific content. | 0..1 | ||
</BackOffice> | ||||
</InfoGroup> | ||||
<CarsHeader> | Cars header group | 1 | ||
<PickUp> | Pick up group | 1 | ||
<Date/> | Pick up or drop off date in ISO 8601 format (yyyy-mm-dd). | 1 | 2001-12-25 | |
<Time/> | Pick up or drop off time in ISO 8601 format (hh:mm). | 1 | 14:50 | |
</PickUp> | ||||
<DropOff> | Drop Off group | 1 | ||
<Date/> | Pick up or drop off date in ISO 8601 format (yyyy-mm-dd). | 1 | 2001-12-25 | |
<Time/> | Pick up or drop off time in ISO 8601 format (hh:mm). | 1 | 14:50 | |
</DropOff> | ||||
<CurrencyCode> | Currency code. | 1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<DistanceUnit/> | Distance unit applied for all distance information (may be overridden for specific Cars elements by Cars/DistanceUnit). Possible values: M = Miles K = Kilometers | [K] [M] | 0..1 | M |
<AlternateRate/> | Determines if another rate type might apply. Possible values are: 1 = Weekend and/or weekly rates may apply 2 = Weekly and/or monthly rates may apply 3 = Weekly rates may apply 4 = Monthly rates may apply 5 = Weekend rates may apply | [1] [2] [3] [4] [5] | 0..1 | 3 |
</CarsHeader> | ||||
<Cars> | Cars group | 0..N | ||
@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 | [GCM] [GCO] [GLP] [GLO] [GIA] [GIO] [ASA] [ACA] [ACP] [SDA] [SDC] [SOL] [WAP] [WMP] [WNA] | 0..1 | ASA |
@Status | Availability Status. Values are: A = Available for sale R = On request, need to call vendor C = Closed. | [A] [R] [C] | 0..1 | A |
@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. | |
<CarVendorCode/> | Car vendor code. | 1 | ZI | |
<CarVendorName/> | Car vendor name. | 0..1 | Avis | |
<AlternateCarVendorCode/> | Identification of alternate vendor name used at this location. | 0..1 | HZ | |
<Location> | Pick up and/or drop off location. If location information is returned, there are two distinct cases: - Only one Location element is returned without @Type: the Location applies to both pick up and drop off. - Two Location elements are returned: one with @Type "PICKUP", the other with @Type "DROPOFF". | 1..2 | ||
@Type | Type of Location. Values: - PICKUP - DROPOFF | [PICKUP] [DROPOFF] | 0..1 | PICKUP |
<CityCode/> | Location city code. | 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 | |
<OpeningInterval> | Several instances of this element indicate different intervals of opening hours for the specified day. | 0..N | ||
@OpeningTime | Opening hours of the pick up or drop off location in ISO 8601 time format. | 0..1 | 00:00 | |
@ClosingTime | Closing hours of the pick up or dropoff location in ISO 8601 time format. | 0..1 | 23:59 | |
</OpeningInterval> | ||||
<Address> | 0..1 | |||
<Name/> | Station name. | 0..1 | ||
<Street/> | Street or PO Box address. | 0..1 | 5301 Blue Lagoon Drive | |
<City/> | City name. | 0..1 | Miami | |
<PostalCode/> | Postal code or zip code. | 0..1 | 33126 | |
<StateCode/> | State code. | 0..1 | NY | |
<CountryCode/> | Country code. | 0..1 | US | |
</Address> | ||||
</Location> | ||||
<DeskLocation/> | Indicates where the car vendor desk is located in regards to the terminal. Possible values are: I = In terminal, does not require schuttle to counter O = off airport, shuttle required S = in or on airport, shuttle required N = off airport, no shuttle service C = Customer must call car rental company and request transportation to rental location | 0..1 | I | |
<ReferencePoint/> | Reference point description. | 0..1 | Eiffel Tower | |
<Distance/> | Distance from reference point. | 0..1 | 15 | |
<Direction/> | Direction from reference point: N = North E = East S = South W = West NE = NorthEast NW = NorthWest SE = SouthEast SW = SouthWest | [N] [E] [S] [W] [NE] [NW] [SE] [SW] | 0..1 | NE |
<CarType> | Car type. | 1 | ICAR | |
@UpsellInd | Indicates that car type returned represents a car type which is better than that originally requested. | [Y] | 0..1 | Y |
@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 will be used instead. Values: SIPP .. SIPP code VS .. vendor specific code | [SIPP] [VS] | 0..1 | |
</CarType> | ||||
<CarTypeDescription/> | Car type description. | 0..1 | Economy | |
<Capacity/> | Passenger capacity. | 0..1 | 4 | |
<Doors/> | Number of doors. | 0..1 | 2-4 | |
<Baggage/> | Baggage capacity in bags. | 0..1 | 8 | |
<Rate> | Rate amount group | 1 | ||
@Type | Rate Type. Values are: D = Daily E = Weekend W = Weekly M = Monthly H = Hourly P = Package. B = Base Rate R = Rental period. | [D] [E] [W] [M] [H] [P] [B] [R] | 0..1 | W |
@Guarantee | Rate guarantee. Values are: Y = Rate guaranteed, N = Rate not guaranteed. | [Y] [N] | 0..1 | Y |
@Category | Rate Category. Values are: A = Association B = Business standard C = Corporate G = Government I = Industry (Travel) K = Package L = Inclusive P = Promotional 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 |
@NeedCC | Optional identifier in case this rate needs a Credit Card to be entered in PNRCreateRQ (while creating a reservation). NOTE: Deprecated. Rather use PaymentRequirements attribute as it is more precise about the type of guarantee that is required. | [Y] [N] | 0..1 | |
@NeedFlightTicket | Indicates if an airline ticket is required for this rental. Values: Y .. Yes N .. No | [Y] [N] | 0..1 | |
@PaymentRequirements | Indicates whether and which type of guarantee information is required at the time of booking in PNRCreateRQ in SupplementalInformation/PaymentGuarantee. If this attribute is not returned either no guarantee information is available or no guarantee is required. Values: G = Guarantee (to guarantee a reservation; credit cards are only validated but not used for any payment) D = Deposit (a more restrictive type of guarantee, where a certain amount can be taken from credit card by the vendor. - Advantage: offers with deposit requirement are cheaper in most cases. - Disadvantage: In case of a cancellation this deposit amount can not be refunded, but this depends on cancellation policy. ) P = PrePay (the most restrictive type of guarantee, where the complete amount must be paid already at the time of booking. It also depends on cancellation policy whether the amount can be refunded.) | [D] [G] [P] | 0..1 | G |
<RateCode/> | Vendor rate code. | 1 | STD | |
<RateID/> | Rate identification number. | 0..1 | 153425 | |
<Amount/> | Rate amount applicable for the unit specified by Rate/@Type. | 1 | 20000 | |
<TotalAmount/> | Total rate amount. | 0..1 | 21900 | |
<MileKmRate/> | Rate charged per extra mile/kilometer. | 0..1 | 025 | |
<MileKmLimit/> | Rate Miles/Kilometers limit or extra charges limit: 'UNL' (Unlimited) or a miles/kilometers limit numeric value. | 0..1 | UNL (or 25) | |
<RateQualifier/> | Rate qualifier. | 0..1 | Unknown | |
</Rate> | ||||
<ExtraCharges> | Extra charges group | 0..N | ||
@Type | Extra charges description. Values are: H .. Hour D .. Day W .. Week M .. Month A .. Adult CH .. Child E .. Employee FE .. fee T .. Tax F .. Drop off SP .. Surcharge Policy CP .. Coverage Policy AR .. pay on arrival AD .. additional distance PM .. Per Mile PK .. Per KM FM .. Free Mile FK .. Free KM U .. Some unspecified extra charges apply | [H] [D] [W] [M] [A] [CH] [E] [FE] [T] [F] [SP] [CP] [AR] [AD] [PM] [PK] [FM] [FK] [U] | 0..1 | D |
@TaxIncluded | Y .. Yes N .. No U .. unknown | [Y] [N] [U] | 1 | |
@IncludedInRate | Indicates if the extra charge amount is included in the rate total amount. Y .. Yes N .. No U .. unknown | [Y] [N] [U] | 1 | |
<Amount> | Rate amount or extra charges amount; (for percentual values decimal points are allowed, i.e. '4.50'). | 0..1 | 20000 | |
@Type | Amount type (default: A), Values are: P .. Percent A .. Amount | [P] [A] | 0..1 | A |
</Amount> | ||||
<MileKmLimit/> | Rate Miles/Kilometers limit or extra charges limit: 'UNL' (Unlimited) or a miles/kilometers limit numeric value. | 0..1 | UNL (or 25) | |
<Description/> | Tax or surcharge description. | 0..1 | US national transportation | |
<CurrencyCode> | Currency code. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
</ExtraCharges> | ||||
<AdvanceBooking> | Number of advance booking units. | 0..1 | 3 | |
@Unit | Advance booking unit type. Values are: D = Days H = Hours W = Weeks M = Months. | [H] [D] [W] [M] | 0..1 | W |
</AdvanceBooking> | ||||
<MinimumBooking> | Number of minimum booking units. | 0..1 | 1 | |
@Unit | Advance booking unit type. Values are: D = Days H = Hours W = Weeks M = Months. | [H] [D] [W] [M] | 0..1 | W |
</MinimumBooking> | ||||
<MaximumBooking> | Number of maximum booking units. | 0..1 | 3 | |
@Unit | Minimum booking unit type. Values are: D = Days H = Hours W = Weeks M = Months. | [H] [D] [W] [M] | 0..1 | W |
</MaximumBooking> | ||||
<DistanceUnit/> | Distance unit applied for all distance information of this Cars element (overrides CarsHeader/DistanceUnit, if both are present). Values: K = kilometers M = miles | [K] [M] | 0..1 | M |
<Media> | Holds reference to multi media content such as pictures, videos, etc. | 0..1 | ||
<Url/> | Hyperlink defining the location of the referenced media (e.g. location of a JPG file). | 1 | ||
<Width> | Width of media content in specified units. | 1 | ||
@Unit | Unit used to specify dimensions of media content. | [px] [mm] | 1 | mm (millimeter) px (pixel) |
</Width> | ||||
<Height> | Height of media content in specified units. | 1 | ||
@Unit | Unit used to specify dimensions of media content. | [px] [mm] | 1 | mm (millimeter) px (pixel) |
</Height> | ||||
<Type> | Type of media content. For value 'OTA' the attributes @Type and @Code contain the media type information. Values other than 'OTA' are deprecated. Values: OTA image webcam video logo gallery 360 (panorama view) | [OTA] [image] [webcam] [360] [video] [logo] [map] [gallery] | 1 | OTA |
@Type | OTA code type. CTT .. Content Code PIC .. Picture Category Code | [CTT] [PIC] | 0..1 | |
@Code | OTA code. | 0..1 | 16 | |
@Description | Free text description. If none available the OTA code name is used. | 0..1 | Streaming video | |
</Type> | ||||
<Preview> | Preview of the referenced media content (e.g. thumbnail of the picture). | 0..N | ||
<Url/> | Hyperlink defining the location of the referenced media (e.g. location of a JPG file). | 1 | ||
<Width> | Width of media content in specified units. | 1 | ||
@Unit | Unit used to specify dimensions of media content. | [px] [mm] | 1 | mm (millimeter) px (pixel) |
</Width> | ||||
<Height> | Height of media content in specified units. | 1 | ||
@Unit | Unit used to specify dimensions of media content. | [px] [mm] | 1 | mm (millimeter) px (pixel) |
</Height> | ||||
<Type> | Type of media content. For value 'OTA' the attributes @Type and @Code contain the media type information. Values other than 'OTA' are deprecated. Values: OTA image webcam video logo gallery 360 (panorama view) | [OTA] [image] [webcam] [360] [video] [logo] [map] [gallery] | 1 | OTA |
@Type | OTA code type. CTT .. Content Code PIC .. Picture Category Code | [CTT] [PIC] | 0..1 | |
@Code | OTA code. | 0..1 | 16 | |
@Description | Free text description. If none available the OTA code name is used. | 0..1 | Streaming video | |
</Type> | ||||
</Preview> | ||||
<Description> | Media content description (e.g. exterior view). | 0..1 | ||
@Type | OTA code type. PIC .. Content Code | [PIC] | 0..1 | |
@Code | OTA code. | 0..1 | 3 | |
@Description | OTA code name. | 0..1 | Pool view | |
</Description> | ||||
<Caption/> | Title for the media. | 0..1 | Exterior | |
</Media> | ||||
<AvailableEquipment> | 0..1 | |||
<Equipment> | An optional equipment available for this offer. | 1..N | ||
@Type | OTA code type EQP .. equipment type VS .. vendor specific code | [EQP] [VS] | 0..1 | |
@Code | OTA code to specify the type of optional equipment. | 0..1 | ||
@Quantity | Number of equipment items | 0..1 | ||
@Description | Textual description of the optional equipment. | 0..1 | SKI RACK | |
<Amount/> | Rate amount or extra charges amount. | 0..1 | 20000 | |
<TaxIncluded/> | Indicates whether or not tax is included in the equipment fee amount. Y .. Yes N .. No U .. unknown | [Y] [N] [U] | 0..1 | |
<IncludedInRate/> | Indicates if the equipment amount is included in the rate total amount. Y .. Yes N .. No U .. unknown | [Y] [N] [U] | 0..1 | |
<Calculation> | Contains the breakdown of the amount for the equipment. It will be used to show the weekly, daily, hourly, ... charges that were used in the calculation of the the amount for the equipment. | 0..N | ||
@UnitCharge | Price part of the given unit. | 1 | 1500 | |
@UnitName | Specifies type of the unit charge. Values: D .. Day W .. Week M .. Month H .. Hour R .. Rental period KM .. kilometer MI .. mile | [D] [W] [M] [H] [R] [KM] [MI] | 1 | |
@Quantity | Number of days, weeks,... that were used for calculation. | 1 | 3 | |
</Calculation> | ||||
<CurrencyCode> | Currency code. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
</Equipment> | ||||
</AvailableEquipment> | ||||
<Coverage> | Coverage information | 0..N | ||
@Type | OTA or VS code type VCT .. OTA vehicle coverage type VS .. vendor specific code | [VCT] [VS] | 0..1 | VCT |
@Code | OTA code to specify the type of coverage. | 0..1 | 32 | |
@Description | Textual description of coverage | 0..1 | Personal Accident Insurance | |
@TaxIncluded | Y .. Yes N .. No U .. unknown | [Y] [N] [U] | 1 | |
@IncludedInRate | Indicates if the coverage amount is included in the rate total amount. Y .. Yes N .. No U .. unknown | [Y] [N] [U] | 1 | |
@Required | Indicates if the coverage is required or not. Y .. Yes N .. No U .. unknown | [Y] [N] [U] | 1 | |
<Amount/> | Coverage amount | 1 | 20000 | |
<Calculation> | Contains the breakdown of the amount for the coverage. It will be used to show the weekly, daily, hourly, ... charges that were used in the calculation of the the amount for the coverage. | 0..N | ||
@UnitCharge | Price part of the given unit. | 1 | 1500 | |
@UnitName | Specifies type of the unit charge. Values: D .. Day W .. Week M .. Month H .. Hour R .. Rental period KM .. kilometer MI .. mile | [D] [W] [M] [H] [R] [KM] [MI] | 1 | |
@Quantity | Number of days, weeks,... that were used for calculation. | 1 | 3 | |
</Calculation> | ||||
<CurrencyCode> | Currency code. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
</Coverage> | ||||
</Cars> | ||||
<MoreCarsToken/> | Token used to request more cars in the subsequent car availability request. | 0..1 | 124523467899 | |
</CarAvailabilityRS> |
| 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