CarMatrix_6 Documentation

<CarMatrix_6> CAR01MATRIX

+ Responses

+ <CarMatrixAvail>

7171 1.5

+ <CarMatrixStaticInfo>

CMR1 2.0

Start Definition Of -Car Matrix Response KLR
<RespType>	Alphanumeric	1	Description of Field: Indication of error or good response. Format (x-alpha/numeric): x Special Format: 0 = No errors 1 = Error with no rate data returned 2 = Error with rate data returned How is null data specified? Character blank What does null data indicate? Invalid, a value will always be given in this field

Start Definition of Error Section. This detail is returned if Type Response Returned is E or W.
<ErrMsg>	Alphanumeric	64	Description of Field: Error or warning text in response to the request. Format(x-alpha/numeric): xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx How is null data specified? Character blanks What does null data indicate? No error or warning in this response.

End Definition of Error Section. This detail is returned if Type Response Returned is W or 0.
<RefPt>	Alphanumeric	30	Description of Field: Text description of pickup location Format (x-alpha/numeric): xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx Examples: OHARE INTL ARPT How is null data specified? Character blanks What does null data indicate? No text description available.

<City>

Alpha

Description of Field:
Typically this is an airport code
Format (a-alpha):
aaaaa
Special Format:
Last two characters are normally blank. Reserved for possible future code expansions
Examples:
DEN
How is null data specified?
Character blanks
What does null data indicate?
City code could not be determined.

<State>

Alpha

Description of Field:
State code for the rental
Format (a-alpha):
aa
Examples:
CO
How is null data specified?
Character blanks
What does null data indicate?
State code could not be determined.

Alpha

Description of Field:
Country code
Format (a-alpha):
aa
Examples:
US
How is null data specified?
Character blanks
What does null data indicate?
Country code could not be determined

Alpha

Description of Field:
M for miles, K for kilometers
Format (a-alpha):
a
Possible Values (List):
M - Miles
K - Kilometers
How is null data specified?
Character blank
What does null data indicate?
Invalid, will always return default value of K.

Alpha

Description of Field:
Field no longer used as of version 2, Nov. 2006.
Each supplier will reply with the rate type that they see appropriate to the date range requested.

Alphanumeric

Description of Field:
Rate category description
Format (x-alpha/numeric):
xxxxxxxxxxx
Examples:
STD/PROM
How is null data specified?
Character blanks
What does null data indicate?
No text description available

<Crncy>

Alpha

Description of Field:
Currency in which the rates are quoted. Can be overridden by Inside Availability vendors in the CMR2 KLR when the request specifies 'Return Source Currency' in the CMA1. In this override case, Number of Decimals would no longer apply.
Format (a-alpha):
aaa
How is null data specified?
Character blanks
What does null data indicate?
Invalid, a currency code should always be present

Alphanumeric

Description of Field:
The number of places to the right of the implied decimal for the currency the rates are quoted in
Format (x-alpha/numeric):
x
Possible values (List):
0 - 4
blank
How is null data specified?
Character blank
What does null data indicate?
Number of decimals not available for the given currency. Unlikely event.

Alpha

Description of Field:
When implied decimal places are very large
Format (a-alpha):
a
Possible Values (List):
Y - Truncate implied decimals
N - Do not truncate
How is null data specified?
Character blank
What does null data indicate?
Invalid, truncation instructions will always be given

Numeric

Description of Field:
Field no longer used as of version 2, Nov. 2006.
Each supplier will reply with the rate type that they see appropriate to the date range requested.

Numeric

Description of Field:
The total number of Vendor Locations included in this transmission.
Format:
nn
Possible Values (Range):
00 - 99
How is null data specified?
Zeroes - 00

What does null data indicate?
No vendor locations or rates returned

+ <CarMatrixLocnInfo>

CMR2 2.0

Start Definition Of - Car Matrix Response KLR Vendor Location Information
<Type>	Alphanumeric	1	Description of Field: Applies to Inside Availability Vendors only. Non-IA will always be set to 0. This is an indication of error or good response from this individual vendor/location link query. The specific vendor error messages will not be included, simply indication of the error via Vendor Error Code. Format (x-alpha/numeric): x Special Format: 0 - No errors E - Vendor could not satisfy request/no data returned. W - Vendor replied with rates but restrictions may apply/see rules T - No reply from vendor/vendor time-out D - Link down How is null data specified? Character blank What does null data indicate? Invalid, a value will always be given in this field

Alphanumeric

Description of Field:
Applies to Inside Availability Vendors only. This would be the code returned from the vendor to indicate an error or a warning. This would be used for diagnostic purposes only as it would need translation by the vendor.
Format (x-alpha/numeric):
xxxx
How is null data specified?
Character blanks
What does null data indicate?
No error returned from the vendor.

Alpha

Description of Field:
Car vendor code. Currently two alpha characters
Format (a-alpha):
aaa
Special Format
Currently the third character is unused-always blank.
Examples:
ZIblank
How is null data specified?
Invalid, data must be present
What does null data indicate?
Invalid, data must be present.

Alpha

Description of Field:
Code of the pickup location
Format (a-alpha):
aaaaa
Special Format:
Currently the last two characters are always blank
Examples:
DENblankblank
How is null data specified?
Invalid, data must be present
What does null data indicate?
Invalid, data must be present

Alpha

Description of Field:
Category of location. See possible values below.
Format (a-alpha):
a
Possible Values (List):
T - Airport terminal
O - Off-airport
C - City location
N - North suburban
E - East suburban
S - South suburban
W - West suburban
R - Resort location
P - Port
X - Train station
How is null data specified?
Invalid, data must be present
What does null data indicate?
Invalid, data must be present

Numeric

Description of Field:
Reserved for future use
Format (n-numeric):
n
How is null data specified?
Zero - 0
What does null data indicate?
Normal response, this field not in use

Numeric

Description of Field:
A two-digit number used to identify specific rental location within a location category
Format (n-numeric):
nn
Examples:
01
How is null data specified?
Invalid, data must be present
What does null data indicate?
Invalid, data must be present

Alpha

Description of Field:
It is meaningful to vendors and CarMaster to have a primary rental location distinguished from others in a given area. Typically this is the airport location.
Format (a-alpha):
a
Possible Values:
P - Prime location
S - Secondary location
How is null data specified?
Character blank
What does null data indicate?
Unable to determine if this is a primary location

Alpha

Description of Field:
This describes the availability source of the car item.
Format (a-alpha):
a
Possible Values:
L - Link vendor
N - Not Link vendor
M - Inside Availability vendor Matrix reply
W - Link vendor w/ alternate name
O - Non-Link vendor w/ alternate name
How is null data specified?
Invalid, data must be present
What does null data indicate?
Invalid, data must be present

<Dist>

Alphanumeric

Description of Field:
Distance from reference point. Nominally this is distance from the airport or from the city center when these are used for the availability request.
Format (x-alpha/numeric):
xxx
Examples:
003
How is null data specified?
Character blanks
What does null data indicate?
No data available

<Dir>

Alpha

Description of Field:
Direction from reference point
Format (a-alpha):
aa
Possible Values (List):
Normally compass direction.
N, E, S, W, NE, NW, SE, SW
Defaults to location category when rental site is at category (i.e.T-airport terminal)
How is null data specified?
Character blanks
What does null data indicate?
No data available

Start Definition of Property Geocode KLR - for internal Galileo use only Data for the Property Latitude and Longitude is NOT currently available via structured data or XML.
<LatSign>	Character	1	Description of Field: Geographic Coordinate Sign for Latitude Format (c-character): c Possible Values (List): Blank = North of Equator - = South of Equator How is null data specified? Character blank What does null data indicate? No data available

<Lat>

Numeric

Description of Field:
Geographic Coordinate for Latitude
Format (n-numeric):
nnnnnnn
Examples:
Example: 0843675 implies 3 digits to the left and 4 digits to the right of the implied decimal point (implied as 084.3675)
How is null data specified?
Character blanks
What does null data indicate?
No data available

End Definition of Property Latitude Start Definition of Property Longitude
<LongSign>	Character	1	Description of Field: Geographic Coordinate for Longitude Format (c-character): c Possible Values (List): Blank = East of Meridian - = West How is null data specified? Character blanks What does null data indicate? No data available

<Long>

Numeric

Description of Field:
Geographic Coordinate for Longitude
Format (n-numeric):
nnnnnnn
Examples:
Example: 1032419 implies 3 digits to the left and 4 digits to the right of the implied decimal point (implied as 103.2419)
How is null data specified?
Character blanks
What does null data indicate?
No data available

End Definition of Property Longitude
<Crncy>	Alpha	3	Description of Field: Currency in which the rates are quoted. This could be an Inside Availability override of the default currency quoted in the CMR1 record. Applies when Return Source Currency Indicator flagged as Y in CMA1 request KLR. If not an override, it will match the Currency specified in the CMR1 KLR. Decimal placement will not be provided for override currencies. Format (a-alpha): aaa How is null data specified? Character blanks What does null data indicate? Invalid, a currency code should always be present

Numeric

Description of Field:
Key of associated rate items - CMR3
Format (n-numeric):
nn
Possible Values:
01-99
How is null data specified?
Character zeroes
What does null data indicate?
Not valid, there must be an association key.

Numeric

Description of Field:
Number of rate items (CMR3) associated to this location.
Format (n-numeric):
nn
Possible Values:
00-99
How is null data specified?
Character zeroes
What does null data indicate?
No rates for this location

Alpha

Description of Field:
Code of the drop off location
Format (a-alpha):
aaaaa
Special Format:
Currently the last two characters are always blank
Examples:
DENblankblank
How is null data specified?
Invalid, data must be present
What does null data indicate?
Invalid, data must be present

Alpha

Description of Field:
Category of drop off location. See possible values below.
Format (a-alpha):
a
Possible Values (List):
T - Airport terminal
O - Off-airport
C - City location
N - North suburban
E - East suburban
S - South suburban
W - West suburban
R - Resort location
P - Port
X - Train station
How is null data specified?
Blank
What does null data indicate?
No drop off location category provided.

Alphanumeric

Description of Field:
Used for non-carmaster location
Format (x-alpha/numeric):
x
How is null data specified?
0
What does null data indicate?
Not a non-carmaster location.

Numeric

Description of Field:
A two-digit number used to identify specific rental location within a location category
Format (n-numeric):
nn
Examples:
01

How is null data specified?
Zero
What does null data indicate?
No drop off location number present

+ <CarMatrixRateInfo>

CMR3 4.0

Rate Description Section of Rate Item
<RateKey>	Numeric	2	Description of Field: Key of location item (CMR2) associated to this rate item. Associated CMR2 will have a matching Rate Key field. Format (n-numeric): nn Possible Values: 01-99 How is null data specified? Character zeroes What does null data indicate? Not valid, there must be an association key.

Alphanumeric

Description of Field:
ICAR, ECAR, etc.
Format (x-alpha/numeric):
xxxx
How is null data specified?
Invalid, data must be present
What does null data indicate?
Invalid, data must be present

Alphanumeric

Description of Field:
Needed for the sell. Vendors use this to manage inventory. May not always be returned.
Format (x-alpha/numeric):
x
How is null data specified?
Character blanks
What does null data indicate?
No yield management number available for this rate

Alpha

Description of Field:
Indicates the kind of rate provided.
Format (a-alpha):
a
Possible Values (List):
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
How is null data specified?
Invalid, data must be present
What does null data indicate?
Invalid, data must be present

<Rate>

Alphanumeric

Description of Field:
An alphanumeric code defined by the vendor which should be returned when a car item is sold
Format (x-alpha/numeric):
xxxxxx
Special Format:
Left justified, blank filled.
Examples:
MCLDblankblank
How is null data specified?
Invalid, data must be present
What does null data indicate?
Invalid, data must be present

Alphanumeric

Description of Field:
Data Base key for this rate. Needs to be returned when requesting a reference sell or rules against this rate.
Format (x-alpha/numeric):
xxxxxxxxxx
Examples:
XAB34X0000
How is null data specified?
Invalid, data must be present
What does null data indicate?
Invalid, data must be present

Alpha

Description of Field:
Describes the type of rate, see possible values.
Format (a-alpha):
a
Possible Values (List):
D - Daily
E - Weekend
W - Weekly
M -Monthly
H - Hourly
P - Package
How is null data specified?
Invalid, data must be present
What does null data indicate?
Invalid, data must be present

Numeric

Description of Field:
The car rate expressed in the currency defined by Currency. Location of implied decimal point specified by Number of Decimals. These 2 fields are found in the CMR1 KLR, unless Return Source Currency was specified in the request. Then currency may be overridden by the IA vendor in the CMR2 and decimals must be calculated by the end user.
Format (n-numeric):
nnnnnnnnn
Special Format:
All 9s mean maximum display limit exceeded.
Examples:
000003355
How is null data specified?
Character zeroes
What does null data indicate?
No unit rate available. Should be an approx total rate amount.

Numeric

Description of Field:
The approximate total of the car rental expressed in the currency defined by Currency. Location of the implied decimal point specified by Number of Decimals. These fields follow the same rules as in Unit Rate Amount.
Format (n-numeric):
nnnnnnnnnnnn
Special Format:
Right justified with leading zeroes
Examples:
000000001111
How is null data specified?
Character zeroes
What does null data indicate?
No approximate total or base rate available. Should be a unit rate amount.

Alpha

Description of Field:
Indicates whether total represents base rate (accumulation of daily, weekly etc.) or approximate total (base rate + taxes and other required charges).
Format (a-alpha):
a
Possible Values (List):
B - Base rate
T - Approximate total
How is null data specified?
Invalid, data must be present
What does null data indicate?
Invalid, data must be present

Numeric

Description of Field:
The charge for extra miles. Currency and Decimals match that of the unit rate and approximate total fields
Format (n-numeric):
nnnnnnnnn
Special Format:
All 9s mean maximum display limit exceeded.
Examples:
000000010
How is null data specified?
Character zeroes
What does null data indicate?
No mileage rate available for this car

Alphanumeric

Description of Field:
Number if miles allowed before a mileage charge takes affect.
Format (x-alpha/numeric):
xxxxx
Special Format:
Right justified, blank filled.
Possible Values (List):
UNL = unlimited miles
Numeric value = number of miles

Examples:
UNLblankblank
234blankblank
How is null data specified?
Character blanks
What does null data indicate?
No mileage allowance for this car

Filtering Indication Section of Rate Item
<FullyQualRateInd>	Alpha	1	Description of Field: Describes if the rate has been fully qualified against the search parameters (CD#, ID#, IT#, PC, etc.) or if this is an alternate rate provided by the vendor. Format (a-alpha): a Special Format: Non-IA vendor rates will be Fully Qualified as they cannot be validated for discount codes. Possible Values (List): Y - Fully Qualified Rate N - Alternate Rate How is null data specified? Invalid, data must be present What does null data indicate? Invalid, data must be present

Alpha

Description of Field:
Used for the special circumstance where drop off requested to indicate base rate may not include drop fees
Format (a-alpha):
a
Possible Values(List):
W - Drop Charge may apply
Y - Drop Charge included (even if it's a zero drop charge)
How is null data specified?
Character blank
What does null data indicate?
Character blank indicates no warning

Alpha

Description of Field:
Indicates nature of the rate.
Format (a-alpha):
a
Possible Values (List):
G - Rate guaranteed
Q - Rate quoted
C - Currency conversion
How is null data specified?
Invalid, data must be present
What does null data indicate?
Invalid, data must be present

Alpha

Description of Field:
Indicates if the car is available to rent.
Format (a-alpha):
a
Possible Values (List):
S - Available for sale
N - Need to call
C - Closed
How is null data specified?
Invalid, data must be present
What does null data indicate?
Invalid, data must be present

Alpha

Description of Field:
Indicates vendor requires certain payment information at the time of booking.
Format (a-alpha):
a
Possible Values (List):
Blank - None
1 - Guarantee
3 - Deposit
4 - Pre-pay
How is null data specified?
Character blank
What does null data indicate?
No pre-payment information available

Alphanumeric

Description of Field:
Needed for the sell. Vendors use this to manage inventory. May not always be returned.
Format (x-alpha/numeric)
xxxx
Example:
2501
How is null data specified?
Character blanks
What does null data indicate?
No yield management number available for this rate

Alphanumeric

Description of Field:
Data Base key for this rate. Needs to be returned when requesting a reference sell or rules against this rate.
Format (x-alpha/numeric):
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Examples:
ASDFGHJKLM1254MNB0000023RTYUIOHow is null data specified?
Invalid, data must be present
What does null data indicate?
Invalid, data must be present

Alpha

Description of Field:
Location of the car rental counter and rental cars.
Format (x-alpha/numeric):
a
Possible Values (List):
T - Counter in terminal, walk to car
S - Counter in terminal, shuttle to car
C - Shuttle to counter and car
How is null data specified?
Blank
What does null data indicate?
Generic definition of car location.

Alpha

Description of Field:
Indicator to identify rentals where mileage restrictions apply.
Format (a-alpha):
a
Possible Values (List):
Y - Mileage restrictions apply
N - Mileage restrictions does not apply
How is null data specified?
Blank
What does null data indicate?
No information provided

Alpha

Description of Field:
Indicator to identify rentals where flight data is required
Format (a-alpha):
a
Possible Values (List):
Y - Flight data is required
N - Flight data is not required
How is null data specified?
Blank
What does null data indicate?
No information provided

<CCInd>

Alpha

Description of Field:
Indicator to identify rentals where a credit card is required.
Format (a-alpha):
a
Possible Values (List):
Y - Credit card guarantee is required
N - Credit card is not required
How is null data specified?
Blank
What does null data indicate?
No information provided

VSurchargeCnt
Structured data only.
Not in XML.

Numeric

Description of Field:
Count field for Vendor Surcharge.
Format (n-numeric):
nn
Possible Values (Range):
00 -04
How is null data specified?
00
What does null data indicate?
No data means that there are no vendor surcharge items.

+ <VSurchargeAry>

Array

n/a

+ <VSurcharge>

FieldSet

n/a

Alphanumeric

Description of Field:
Surcharge value code
Format (x-alpha/numeric):
xxx
How is null data specified?
Blank
What does null data indicate?
No data results in error

Alpha

Description of Field:
Descriptive Label
Format (a-alpha):
aaaaaaaaaaaaaaaaaaaa
How is null data specified?
Character blanks
What does null data indicate?
No Data

Alpha

Description of Field:
Item Currency
Format (a-alpha):
aaa
How is null data specified?
Character blanks
What does null data indicate?
No data

Alphanumeric

Description of Field:
Item Value
Format (x-alpha/numeric):
xxxxxxxxxxx
How is null data specified?
Character blanks
What does null data indicate?
No Data

Alpha

Description of Field:
Item Type indicator
Format (a-alpha):
a
Possible Values (List):
N - No charge
P - Percentage
R - Rental
C - Per Contract
H - Per Hour
D - Per Day
W - Per Week
M - Per Month
How is null data specified?
Character blanks
What does null data indicate?
No data results in error

Alpha

Description of Field:
Item Inclusion indicator
Format (a-alpha):
a
Possible Values (List):
N - Not Included
B - Included in Base Rate
T - Included in Total Rate
How is null data specified?
Character blanks
What does null data indicate?
No Data

+ <CarMatrixRateError>

CMR4 1.0

Start Definition Of -Car Matrix Response KLR
<RateKey>	Numeric	2	Description of Field: Key of location item (CMR2) associated to this rate item. Associated CMR2 will have a matching Rate Key field. Format (n-numeric): nn Possible Values: 01-99 How is null data specified? Character zeroes What does null data indicate? Not valid, there must be an association key.

<VErr>

Alphanumeric

Description of Field:
Applies to Inside Availability Vendors only. This would be the code returned from the vendor to indicate an error or a warning. Error code is also returned in the CMR2 KLR.
Format (x-alpha/numeric):
xxxx
How is null data specified?
Character blanks
What does null data indicate?
No error returned from the vendor.

Alphanumeric

Description of Field:
Error or warning text in response to the request.
Format(x-alpha/numeric):
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Example:
LOCATION CLOSED ON ARRIVAL
How is null data specified?
Character blanks
What does null data indicate?
Invalid. If this KLR is present, there should be error text here.

+ <CarMatrixRateItem>

CMR5 4.0

Rate Description Section of Rate Item
<RateKey>	Numeric	2	Description of Field: Key of location item (CMR2) associated to this rate item. Associated CMR2 will have a matching Rate Key field. Format (n-numeric): nn Possible Values: 01-99 How is null data specified? Character zeroes What does null data indicate? Not valid, there must be an association key.

Alphanumeric

Description of Field:
ICAR, ECAR, etc.
Format (x-alpha/numeric):
xxxx
How is null data specified?
Invalid, data must be present
What does null data indicate?
Invalid, data must be present

Alphanumeric

Alpha

Alphanumeric

Alphanumeric

Alpha

Numeric

Numeric

Alpha

Numeric

<Mile>

Alphanumeric

Filtering Indication Section of Rate Item
<FullyQualRateInd>	Alpha	1	Description of Field: Describes if the rate has been fully qualified against the search parameters (CD#, ID#, IT#, PC, etc.) or if this is an alternate rate provided by the vendor. Format (a-alpha): a Special Format: Non-IA vendor rates will be Fully Qualified as they cannot be validated for discount codes. Possible Values (List): Y - Fully Qualified Rate N - Alternate Rate How is null data specified? Invalid, data must be present What does null data indicate? Invalid, data must be present

Alpha

Alpha

Alpha

Alpha

Alphanumeric

Alphanumeric

Numeric

Description of Field:
The charge for one way rental expressed in the currency defined by Currency. Location of implied decimal point specified by Number of Decimals. These 2 fields are found in the CMR1 KLR, unless Return Source Currency was specified in the request. Then currency may be overridden by the IA vendor in the CMR2 and decimals must be calculated by the end user.
Format (n-numeric):
nnnnnnnnn
Special Format:
All 9s mean maximum display limit exceeded.
Examples:
000003355
How is null data specified?
Character zeroes
What does null data indicate?
No drop charge available.

Alpha

Alpha

Alpha

<CCInd>

Alpha

VSurchargeCnt
Structured data only.
Not in XML.

Numeric

Description of Field:
Count field for Vendor Surcharge.
Format (n-numeric):
nn
Possible Values (Range):
0 -4
How is null data specified?
00
What does null data indicate?
No data means that there are no vendor surcharge items.

+ <VSurchargeAry>

Array

n/a

+ <VSurcharge>

FieldSet

n/a

Alphanumeric

Description of Field:
Surcharge value code
Format (x-alpha/numeric):
xxx
How is null data specified?
Blank
What does null data indicate?
No data results in error

Alpha

Description of Field:
Descriptive Label
Format (a-alpha):
aaaaaaaaaaaaaaaaaaaa
How is null data specified?
Character blanks
What does null data indicate?
No Data

Alpha

Description of Field:
Item Currency
Format (a-alpha):
aaa
How is null data specified?
Character blanks
What does null data indicate?
No data

Alphanumeric

Description of Field:
Item Value
Format (x-alpha/numeric):
xxxxxxxxxxx
How is null data specified?
Character blanks
What does null data indicate?
No Data

Alpha

Alpha