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 |
|---|---|---|---|---|
<CarInformationRS> | Car information response 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 | ||
@Code | A code to uniquely identify a specific type of ForInfo message. Currently not returned for most ForInfo messages. | 0..1 | I00001 | |
@Lang | ISO language code. A two letter code as defined by ISO-639-1. | 0..1 | de | |
<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> | ||||
<PickUp> | Pickup group | 1 | ||
<Date/> | Pick up or drop off date in ISO 8601 format (yyyy-mm-dd). | 1 | 2002-02-20 | |
<Time/> | Pick up or drop off time in ISO 8601 format (hh:mm). | 0..1 | 14:30 | |
<AirportCode/> | Airport code. | 1 | JFK | |
<AirportName/> | Airport name. | 1 | John Fitzgerald Kennedy | |
<Location> | Location group | 0..1 | ||
<CityCode/> | 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] [*] | 0..1 | T |
<Number/> | Location number. | 0..1 | 01 | |
</Location> | ||||
<HoursOfOperation/> | Hours of vendor office operation. | 0..N | Unknown | |
</PickUp> | ||||
<DropOff> | Drop off group | 1 | ||
<AirportCode/> | Airport code. | 1 | JFK | |
<AirportName/> | Airport name. | 1 | John Fitzgerald Kennedy | |
<Date/> | Pick up or drop off date in ISO 8601 format (yyyy-mm-dd). | 1 | 2002-02-20 | |
<Time/> | Pick up or drop off time in ISO 8601 format (hh:mm). | 0..1 | 14:30 | |
<Location> | Location group | 0..1 | ||
<CityCode/> | 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] [*] | 0..1 | T |
<Number/> | Location number. | 0..1 | 01 | |
</Location> | ||||
<HoursOfOperation/> | Hours of vendor office operation. | 0..N | Unknown | |
</DropOff> | ||||
<CarVendorCode/> | Car vendor code. | 1 | ZI | |
<CarVendorName/> | Car vendor name. | 0..1 | Avis | |
<AlternateCarVendorCode/> | Alternate car vendor code. | 0..1 | AL | |
<RateInformation> | Rate information group | 0..N | ||
<Rate> | Rate group | 0..1 | ||
@Type | Rate Type. Values are: D = Daily E = Weekend W = Weekly M = Monthly H = Hourly P = Package | [D] [E] [W] [M] [H] [P] | 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 = 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 |
@Guarantee | Guarantee rate requested. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
<RateCode/> | Vendor rate code. | 1 | STD | |
<RateDescription/> | Rate code description. | 0..1 | Standard | |
</Rate> | ||||
<RateOptions> | Rate option group | 0..1 | ||
<RateQualifier/> | Rate qualifier. | 0..1 | Unknown | |
<Corporate> | Corporate rate | 0..1 | ||
<Account/> | Corporate account. | 1 | Unknown | |
</Corporate> | ||||
</RateOptions> | ||||
<CarType> | Car type. | 0..1 | 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 will be used instead. Values: SIPP .. SIPP code VS .. vendor specific code | [SIPP] [VS] | 0..1 | |
</CarType> | ||||
<CarTypeDescription/> | Car type description. | 0..1 | ECONOMY CAR AUTO A/C | |
<CurrencyCode> | Currency code. | 1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<RateAmount/> | Rate amount. | 1 | 4999 | |
<TotalAmount/> | Total rate amount. | 0..1 | 21900 | |
<DistanceUnit/> | Distance unit. | 0..1 | Unknown | |
<MileageAllowance/> | Mileage allowance. | 0..1 | Unknown | |
<MileageRateAmount/> | Mileage rate amount. | 0..1 | Unknown | |
<RequiredCharges/> | Required charges. | 0..1 | Unknown | |
<AdvanceBooking> | Advance booking. | 0..1 | Unknown | |
@Unit | Advance booking unit type. Values are: D = Days H = Hours W = Weeks M = Months | [D] [H] [W] [M] | 0..1 | D |
</AdvanceBooking> | ||||
<ExtraCharges> | 0..N | |||
@Type | Extra charges type. Values are: D = Day H = Hour T = Tax F = Drop off U = Some unspecified extra charges apply E=Employee W=Week M=Month PM=Per Mile PK=Per KM FM=Free Mile FK=Free KM A=Adult SP=Surcharge Policy CH=Child CP=Coverage Policy | [D] [H] [T] [F] [U] [E] [W] [M] [PM] [PK] [A] [CH] [SP] [CP] | 0..1 | D |
@Qualifier | Qualifier the possible values are: - IES included in Estimated Total - IBR included in Base Rate - OPT Optional - MAN Mandatory - NBR Not Included in Base Rate - ITX Policy amount Includes Tax - NTX Policy amount Not Includes Tax | [IES] [IBR] [OPT] [MAN] [NBR] [ITX] [NTX] | 0..1 | |
@PeriodType | PeriodType Possible values are 'PD' per day 'PW per week 'PM' per month 'PR' per rental 'TP' tax percentage 'NC' no coupon value available 'PC' per contract | [PD] [PW] [PM] [PR] [TP] [NC] [PC] | 0..1 | |
<Amount/> | Rate amount or extra charges amount. | 0..1 | 20000 | |
<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> | ||||
</RateInformation> | ||||
<ExtraDay> | Extra day group | 0..1 | ||
<RateAmount/> | Rate amount. | 1 | 4999 | |
<MileageAllowance/> | Mileage allowance. | 1 | Unknown | |
<MileageRateAmount/> | Mileage rate amount. | 0..1 | Unknown | |
</ExtraDay> | ||||
<ExtraHour> | Extra hour group | 0..1 | ||
<RateAmount/> | Rate amount. | 0..1 | 4999 | |
<MileageAllowance/> | Mileage allowance. | 0..1 | Unknown | |
<MileageRateAmount/> | Mileage rate amount. | 0..1 | Unknown | |
</ExtraHour> | ||||
<RuleInformation> | Rule information group | 0..1 | ||
<MaximumDays/> | Maximum days car can be booked. | 0..1 | 45 | |
<EarlyPickUpTime/> | Early time for car pick up in ISO 8601 format. | 0..1 | 06:30 | |
<LatestPickUpTime/> | Latest time for car pick up in ISO 8601 format. | 0..1 | 02:00 | |
<LatestDropOffTime/> | Latest time for car drop off in ISO 8601 format. | 0..1 | 12:00 | |
<Deposit> | Deposit group | 0..1 | ||
<Amount/> | Deposit amount. | 0..1 | 5000 | |
<Effective/> | Effective. | 0..1 | Unknown | |
<Discount/> | Discount. | 0..1 | Unknown | |
</Deposit> | ||||
<RateGuarantee> | Rate guarantee group | 0..1 | ||
<Effective/> | Effective. | 0..1 | Unknown | |
<Discount/> | Discount. | 0..1 | Unknown | |
</RateGuarantee> | ||||
<PayCC/> | Credit card payment. | 0..1 | Unknown | |
<GuaranteeCC/> | Credit card guarantee. | 0..1 | Unknown | |
<RateQualifier/> | Rate qualifier. | 0..1 | Unknown | |
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</RuleInformation> | ||||
</CarInformationRS> |
| 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