|
+ Responses
|
|
+ <TravelScreenDetail>
|
4911 6.0
|
|
+ <HtlTravelscreenData>
|
HTTD 1.0
|
|
|
|
<PrefLevelInd>
|
Alpha
|
1
|
"B" = Business level preferences returned "P" = Personal level preferences returned "M" = Merged preferences returned
|
|
<TypeInd>
|
Alpha
|
1
|
Not used (blank)
|
|
|
|
+ <HtlGeneralPreferences>
|
HTTG 1.0
|
|
|
|
+ <HtlPreferences>
|
HTTP 1.0
|
|
|
|
+ <PropDataAry>
|
Array
|
n/a
|
|
|
+ <PropData>
|
FieldSet
|
n/a
|
|
|
|
|
|
|
|
|
+ <HotelType>
|
HTTR 1.0
|
|
|
|
<HtlTypeInd>
|
Alphanumeric
|
1
|
Type Of Response Returned List of Possible Values: P = Property List returned S = Similar Name List returned E = Error message returned H = Hotel Travelscreen response R = RoomMaster Response to an HOC Request I = Inside Availability Response to an HOC Request A = Alternate Availability Response to an HOC Request 0 = Link sell successful. F = Link sell failed. Required/Optional: Required
|
|
|
|
|
|
+ <HeadLineAd>
|
5501 5.0
|
|
|
|
|
|
<Type>
|
Alpha
|
1
|
Description of Field: Type Response Returned Format (a-alpha): a Special Format: N/A Possible Values (List): A=Ads returned N=No ADS were found (Ad Items = 0) E=Error occurred, number of ad Items will be 0 and only an Error Message exists below How is null data specified? N/A What does null data indicate? N/A
|
|
<EndPt>
|
Alpha
|
5
|
Description of Field: Destination Airport/City code Format (a-alpha) aaaaa Special Format: Left justified, blank filled. How is null data specified? N/A What does null data indicate? No data should result in error If variable length, specify the maximum allowable length. N/A
|
|
<StartPt>
|
Alpha
|
5
|
Description of Field: Origin Airport/City code Format (a-alpha): aaaaa Special Format: Left justified, blank filled. How is null data specified? N/A What does null data indicate? No data should result in error If variable length, specify the maximum allowable length. N/A
|
AdItemsCnt Structured data only. Not in XML.
|
Numeric
|
2
|
Description of Field: The number of ad items returned in this block Format (n-numeric): nn Special Format: Right justified, zero filled Examples: 02=2 ads returned How is null data specified? 00 What does null data indicate? No ads returned If variable length, specify the maximum allowable length. N/A
|
|
<TotAdItemsCnt>
|
Numeric
|
4
|
Description of Field: The total number of ad items combined from all 5501 blocks returned in this response Format (n-numeric): nnnn Special Format: Right justified, zero filled Examples: 0002=2 ads returned How is null data specified? 0000 What does null data indicate? No ads returned If variable length, specify the maximum allowable length. N/A
|
|
+ <TypeAQual>
[Qualified By: Type of A]
|
FieldSet
|
n/a
|
|
|
+ <AdItemAry>
|
Array
|
n/a
|
|
|
+ <AdItem>
|
FieldSet
|
n/a
|
|
|
<Vnd>
|
Alphanumeric
|
3
|
Description of Field: First part of key to ad. Previously contained ad number, currently does not have specific meaning other than to partially identify ad. All three fields (Vendor Code, Ad Number, and Vendor Type) must be sent in a 5510v5, Headlines Ads Text Request, exactly as received to request backup explanatory text. Format (x-alpha/numeric): xxx Special Format: N/A Examples: Any combination of alpha/numeric characters. How is null data specified? No data results in error What does null data indicate? No data results in error If variable length, specify the maximum allowable length. N/A
|
|
<Num>
|
Alphanumeric
|
4
|
Description of Field: Second part of key to ad. Previously contained ad number, currently does not have specific meaning other than to partially identify ad. All three fields (Vendor Code, Ad Number, and Vendor Type) must be sent in a 5510v5, Headlines Ads Text Request, exactly as received to request backup explanatory text. Format (x-alpha/numeric): xxxx Special Format: N/A Examples: Any combination of alpha/numeric characters. How is null data specified? No data results in error What does null data indicate? No data results in error If variable length, specify the maximum allowable length. N/A
|
|
<VType>
|
Alphanumeric
|
1
|
Description of Field: Third part of key to ad for which backup text was requested. Previously contained vendor type, currently does not have specific meaning other than to partially identify ad. All three fields (Vendor Code, Ad Number, and Vendor Type) must be sent in a 5510v5, Headlines Ads Text Request, exactly as received to request backup explanatory text. Format (x-alpha/numeric): x Special Format: N/A Examples: Any combination of alpha/numeric characters. How is null data specified? No data results in error What does null data indicate? No data results in error If variable length, specify the maximum allowable length. N/A
|
|
<POSParameter1>
|
Alphanumeric
|
1
|
Description of Field: First point of sale parameter used to select this ad Format (x-alphanumeric): x Special Format: Will always be blank, no longer supported. Possible Values: Character blank How is null data specified? Character blank What does null data indicate? OK
|
|
<POSParameter2>
|
Alphanumeric
|
1
|
Description of Field: Second point of sale parameter used to select this ad Format (x - alphanumeric): x Special Format: Will always be blank, no longer supported. Possible Values: Character blank How is null data specified? Character blank What does null data indicate? OK
|
|
<TextAvail>
|
Alpha
|
1
|
Description of Field: Indicates whether backup text is available Format (a-alpha): a Special Format: N/A. Possible Values: Y=Text exists for this ad N=No text exists for this ad How is null data specified? Character blank What does null data indicate? No data should be treated as "N"
|
|
<Ad>
|
Alphanumeric
|
57
|
Description of Field: Headline message Format (x-alpha/numeric): x Special Format: N/A Examples: Any alpha numeric data How is null data specified? Character blanks What does null data indicate? Character blanks should be output same as other data If variable length, specify the maximum allowable length. N/A
|
|
|
|
|
|
|
|
+ <TypeEQual>
[Qualified By: Type of E]
|
FieldSet
|
n/a
|
|
|
<Msg>
|
Character
|
64
|
Description of Field: Error Message Format (x-alpha/numeric): x Special Format: N/A Examples: N/A How is null data specified? Character blanks What does null data indicate? Character blanks should be output same as other data If variable length, specify the maximum allowable length. N/A
|
|
<Num>
|
Character
|
4
|
Description of Field: Error Number Format (x-alpha/numeric): xxxx Special Format: N/A Examples: N/A How is null data specified? Character blanks What does null data indicate? Character blanks should be output same as other data If variable length, specify the maximum allowable length. N/A
|
|
|
|
|
|
|
+ <ClientFile>
|
5901 1.0
|
|
+ <ClientFileDoubleTitleList>
|
CFDL 1.0
|
|
|
|
<BusinessTitle>
|
Alphanumeric
|
21
|
Description of Field: Business File Title of the Business Client File associated to this Personal Client File. Format (x-alpha/numeric): xxxxxxxxxxxxxxxxxxxxx How is null data specified? N/A - This field should always be populated What does null data indicate? An error condition has occurred
|
|
<PersonalTitle>
|
Alphanumeric
|
21
|
Description of Field: Personal File Title of this Personal Client File. Format (x-alpha/numeric): xxxxxxxxxxxxxxxxxxxxx How is null data specified? N/A - This field should always be populated What does null data indicate? An error condition has occurred
|
|
|
|
+ <ClientFileFixedLineData>
|
CFFD 1.0
|
|
|
This KLR will contain Client File Line header information for a Client File line. It must be preceded by the appropriate Header type KLR (eg. Create Request or Display Reply), and followed by at least one Data type KLR. This KLR will also be used for the Client File Maintenance process to send in the header information on a client file line to be modified.
|
|
<LineNum>
|
Numeric
|
3
|
Description of Field: Line number of this client file data item. As response data this is the line number as it exists on the host. As request data this is the line number to be modified and is mandatory. Format (n-numeric): nnn Special Format: Right justified, character zero filled Possible Values (Range): 001 - 200. 999 - Delete all lines How is null data specified? N/A - A line number will always exist What does null data indicate? This would be an error condition
|
|
<MoveInd>
|
Alphanumeric
|
1
|
Description of Field: Transfer code. Identifies which data is to be transferred into a Booking at Client File Move time. As response data this is the transfer code as it exists on the host. As request data this is the transfer code to be used in the modification and is mandatory. Format (x-alpha/numeric): x Special Format: For a value of B, no actual data is stored. As reply data, a value of X will never be returned. Possible Values (List): Y = Always Move O = Optionally Move N = Never Move B = Blank Line R = Passenger/Segment Related Data H = Debtor Bar Line (1G Only) (Response Only) X = Delete Line (request data only) How is null data specified? N/A - A move indicator will always exist What does null data indicate? This would be an error condition
|
|
<ClientInd>
|
Alphanumeric
|
1
|
Description of Field: Passenger/client identifier used to relate all Data for a passenger within the Client File. As response data this is the Client Identifier as it exists on the host. As request data this is the Client Identifier code to be used in the modification and is optional. Format (x-alpha/numeric): n Possible Values (Range): 1 - 9 How is null data specified? Character Blank What does null data indicate? As a response null data indicates no Client Indicator exists. As request null data indicates no Client Indicator is required.
|
|
<SecondaryInd>
|
Alphanumeric
|
1
|
Description of Field: Additional Qualifier used for grouping of data. Used in Terminal Emulation as a display option. As response data this is the qualifier as it exists on the host. As request data this is the Client Identifier code to be used in the modification and is optional. Format (x-alpha/numeric): x Possible Values (Range): A - Z How is null data specified? Character Blank What does null data indicate? As a response null data indicates no Qualifier exists. As request null data indicates no Qualifier is required.
|
|
<TertiaryInd>
|
Alphanumeric
|
2
|
Description of Field: Field is not used at this time. Format (x-alpha/numeric): xx Special Format: Always null How is null data specified? Character Blank What does null data indicate? Field currently not in use
|
|
<DataType>
|
Alphanumeric
|
4
|
Description of Field: Type of Data (TID) - Indicates the type of data contained in the following CFVD KLR. As request data this is the TID to be used in the modification and is mandatory. As response data this is the TID that resides on the host. (See associated TID Value table) Format (x-alpha/numeric): nnnn (for request data) xxxx (for response data) Special Format: As request data, the TID must be right justified, character zero filled. As response data, the TID will be Left justified, character blank filled. Possible Values (Range): 0001 - 9999 How is null data specified? N/A - A data type will always exist What does null data indicate? This would be an error condition
|
|
|
|
+ <ClientFilePositiveAck>
|
CFPA 1.0
|
|
|
|
<PosAckInd>
|
Alphanumeric
|
1
|
Description of Field: Positive Acknowledgment indicator. This field is not used at this time. Format (x-alpha/numeric): x How is null data specified? Character Blank What does null data indicate? This field will always contain null data at this time, as the field is not used.
|
|
<PosAckID>
|
Alphanumeric
|
4
|
Description of Field: Request KLR ID that Positive Acknowledgment is for. Format (x-alpha/numeric): xxxx Examples: CFMH CFUP How is null data specified? Character blanks, though this field should always be populated What does null data indicate? The core processing is in error and should be corrected
|
|
|
|
+ <ClientFileSingleTitleList>
|
CFSL 1.0
|
|
|
|
<FileInd>
|
Alphanumeric
|
1
|
Description of Field: The type of Client File that the subsequent Client File Title is for. Format (x-alpha/numeric): x Possible Values (List): M = Agency File B = Business File P = Personal File How is null data specified? N/A - This field will always be populated What does null data indicate? If there is no value as listed above, this is an error in the core processing that should be corrected
|
|
<Title>
|
Alphanumeric
|
21
|
Description of Field: Title of the Client File. The Title will be an Agency, Business or Personal Client File Title based on the Client File Type above. Format (x-alpha/numeric): xxxxxxxxxxxxxxxxxxxxx How is null data specified? N/A - this field will always be populated What does null data indicate? If there is no data in this field, this is an error in the core processing that should be corrected
|
|
|
|
+ <ClientFileTypeDisplayHeader>
|
CFTD 1.0
|
|
|
|
<FileInd>
|
Alphanumeric
|
1
|
Description of Field: The Client File type (level) that was returned. A separate CFTD will exist for each level of Client File returned. Format (x-alpha/numeric): x Possible Values (List): M = Agency B = Business P = Personal How is null data specified? N/A - This field should always be populated What does null data indicate? An error condition has occurred
|
|
<DataInd>
|
Alphanumeric
|
1
|
Description of Field: The type of Client File (relating to data content) that was returned. Format (x-alpha/numeric): x Possible Values (List): C = Customer Data I = Itinerary D = Debtor (not currently used) How is null data specified? N/A - This field should always be populated What does null data indicate? An error condition has occurred
|
|
<CRSID>
|
Alphanumeric
|
3
|
Description of Field: CRS ID of the owner of the returned Client File. Format (x-alpha/numeric): xxx Special Format: Left justified, character blank filled. Examples: 1Vblank - Apollo 1Gblank - Galileo How is null data specified? N/A - This field should always be populated What does null data indicate? An error condition has occurred
|
|
<PCC>
|
Alphanumeric
|
4
|
Description of Field: Pseudo city code of the owner of the returned Client File. Format (x-alpha/numeric): xxxx Special Format: Left justified, character blank filled if the Pseudo City code is 3 characters. Examples: GK4 7AA1 How is null data specified? N/A - This field should always be populated What does null data indicate? An error condition has occurred
|
|
<AgncyDesc>
|
Alphanumeric
|
21
|
Description of Field: The Agency File Title for the above Pseudo City Code. This field will always be populated even if no Agency Client File was requested. Format (x-alpha/numeric): Xxxxxxxxxxxxxxxxxxxxx How is null data specified? N/A - This field should always be populated What does null data indicate? An error condition has occurred
|
|
<BusinessTitle>
|
Alphanumeric
|
21
|
Description of Field: The Business File Title associated to the returned Personal Client file or for the returned Business Client File. Format (x-alpha/numeric): xxxxxxxxxxxxxxxxxxxx How is null data specified? Character blanks What does null data indicate? The returned Client File is an Agency Client File.
|
|
<PersonalTitle>
|
Alphanumeric
|
21
|
Description of Field: The Personal File Title for the returned Personal Client File. Format (x-alpha/numeric): xxxxxxxxxxxxxxxxxxxxx How is null data specified? Character blanks What does null data indicate? The returned Client File is an Agency or Business Client File.
|
|
<CreationDt>
|
Numeric
|
8
|
Description of Field: Date the returned Client File was originally created. Format (n-numeric): nnnnnnnn Special Format: YYYYMMDD How is null data specified? N/A - This field should always be populated What does null data indicate? An error condition has occurred
|
|
<PrefInd>
|
Alpha
|
1
|
Description of Field: The type of TravelScreen preferences that were invoked when the Client File was retrieved. Format (a-alpha): a Possible Values (List): (type of Preferences that are active) B = Business Preferences P = Personal Preferences M = Merged Preferences Blank = No Preferences M will only apply if the display request indicated Merged, and both the Business and Personal Files have Preferences. How is null data specified? Character Blanks What does null data indicate? No Preferences exist.
|
|
|
|
+ <ClientFileVariableLineData>
|
CFVD 1.0
|
|
|
|
<Data>
|
Character
|
To End
|
Description of Field: Actual data content for the Client File line as defined in the associated CFFD KLR. As response data this is the data content that resides on the host. As request data this is the data content to be used in the modification and is mandatory. See the associated Data Field Format document. Format (c-character): ccc... Special Format: Variable based on data type How is null data specified? N/A - This field should always be populated What does null data indicate? An error condition has occurred If variable length, specify the maximum allowable length. Minimum 1/Maximum 244 chars
|
|
|
|
+ <ErrText>
|
EROR 1.0
|
|
|
|
NOTE: When this KLR is returned it will be the only KLR present in the response.
|
|
<Err>
|
Alphanumeric
|
8
|
Field Description: Error code provided for the client. Format (x-alpha/ numeric): xxxxxxxx Special Format: All EROR KLRs contain an 8-byte error code field. In the interest of standardization and to ensure each error code is unique, applications must adhere to the following error code numbering system: Byte 1: Alphanumeric Id of the application area owning this error code Byte 2: Severity number of error. Blank and zero indicates no priority exists. Severity 9 is Catastrophic/Highest Severity. Bytes 3-8: Numeric in the range 000000 - 999999 identifying the error situation Possible Values(List): A = Availability B = PNR / Booking File C = Cars D = Document Production F = Fares H = Headlines I = Infrastructure (SDD) J = Leisure L = Links M = Seating P = Client File Q = Queues R = Hotels S = Sell T = Travelscreen V = Terminal Security W = Rail Example: Err = "A 000510" Err = "D 000000' "A" = Availability "D" = Document Production " " = Character blank "000105" = Error number for "NO DISPLAYABLE FLIGHTS" How is null data specified? N/A What does null data indicate? No data results in error.
|
|
<KlrInErr>
|
Alphanumeric
|
4
|
Field Description: ID of the KLR that caused this error. Format (x-alpha/numeric): xxxx Special Format: N/A Examples: DP01 AAGA 0000 How is null data specified? N/A What does null data indicates? No data results in error.
|
|
+ <InsertedTextAry>
|
Array
|
n/a
|
|
|
+ <InsertedText>
|
FieldSet
|
n/a
|
|
|
<Offset>
|
Numeric
|
3
|
Field Description: Location of start of inserted text in Error Text field Format (n-numeric): nnn Special Format: N/A Examples: 000 How is null data specified? N/A What does null data indicates? No data results in error
|
|
<Len>
|
Numeric
|
2
|
Field Description: Length of inserted text Format (n-numeric): nn Special Format: N/A Examples: 00 How is null data specified? N/A What does null data indicate? No data results in error
|
|
|
|
|
|
<Text>
|
Alphanumeric
|
To End
|
Field Description: Complete error message, including any inserted text items Format (x-alpha/numeric): xxxxxxxxxxxxxxxxxx Special Format: N/A Examples: ERROR 4366 - FORM OF PAYMENT REQUIRED How is null data specified? N/A What does null data indicates? No data results in error.
|
|
|
|
+ <MoreData>
|
MORE 1.0
|
|
|
|
<Token>
|
Alphanumeric
|
To End
|
Description of Field: Token data generated for the host to process a "More" request.
|
|
|
|
|
|
+ <SimilarNames>
|
6181 6.0
|
|
|
|
|
6181 - Car/Hotel - Similar Names List Version: 06.00
This detail block will be repeated one or more times when there is a successful return from the availability re quest and the Type Response Returned field = S. The block will be preceded by the header of the transaction that invoked it. It is transaction type 6181.
|
BlkCnt Structured data only. Not in XML.
|
Numeric
|
2
|
The number of detail similar name entries returned in this block. A maximum of 28 is allowed in each similar names block.
|
|
<TotCnt>
|
Numeric
|
4
|
The total number of items that will be returned from all 6181 blocks
|
|
+ <SmlrNameAry>
|
Array
|
n/a
|
|
|
+ <SmlrName>
|
FieldSet
|
n/a
|
|
|
|
|
|
|
|
|
|
+ <CarAvailDetail>
|
7101 7.0
|
|
|
|
|
|
<Signature>
|
Alphanumeric
|
1
|
Description of Field: Field shows which type of response block is being returned. Format (x-alpha/numeric): x Possible Values (List): 0=No errors S=Similar names list. See 6181 for details. E=Error with no data returned W=Error with data returned - an error message will follow How is null data specified? Field cannot be null. What does null data indicate? Problem with code or communication links
|
|
+ <ErrQual>
[Qualified By: Signature of W,E]
|
FieldSet
|
n/a
|
|
|
The next two fields are conditional and will only exist if the Type Response Returned field is W or E.
|
|
<Txt>
|
Character
|
64
|
Description of Field: Free form error message text Format (c-character): ccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc How is null data specified? Field will not be null. It will either be present with data, or completely absent, but not null. What does null data indicate? N/A
|
|
<Err>
|
Character
|
4
|
Description of Field: This is a numeric value relating to error message lists Format (c-character): cccc How is null data specified? If an error is returned, it will contain a numeric value. Nulls will not be present. What does null data indicate? N/A
|
|
|
|
+ <DataQual>
[Qualified By: Signature of W,0]
|
FieldSet
|
n/a
|
|
The remainder of the record will appear when the Type Response Returned field is 0 or W. Marketing Text Section
|
MktgTxtCnt Structured data only. Not in XML.
|
Numeric
|
1
|
Description of Field: Count of Marketing text lines sent for display. Format (n-numeric): n Possible Values (Range): 0 - 2 How is null data specified? Numeric zero What does null data indicate? No marketing text
|
|
+ <MktgTxtAry>
|
Array
|
n/a
|
|
|
<Txt>
|
Alphanumeric
|
64
|
Description of Field: If Marketing Text Line Count is zero the marketing text field will not be present. If the Marketing Text Line Count is two the marketing text field will be present twice. Format (x-alpha/numeric): xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx Examples: COOL CARS FROM AVIS How is null data specified? Field will contain data if returned. If no text is returned, the field will not be present. What does null data indicate? N/A
|
|
|
|
Rate Separator Text Section
|
RateSepCnt Structured data only. Not in XML.
|
Numeric
|
1
|
Description of Field: Count of Rate Separator text lines sent for display. Format (n-numeric): n Possible Values (Range): 0 - 3 How is null data specified? Numeric zero What does null data indicate? No separator text
|
|
+ <RateSepTextAry>
|
Array
|
n/a
|
|
|
+ <RateSepText>
|
FieldSet
|
n/a
|
|
|
<Num>
|
Numeric
|
1
|
Description of Field: Section number which rate separator text describes Format (n-numeric): n Possible Values (Range) 1 - 3 How is null data specified? Field will not contain null data. What does null data indicate? Null data will not be returned.
|
|
<Txt>
|
Alphanumeric
|
64
|
Description of Field: Description of Rate Separator Format (x-alpha/numeric): xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx Examples: FULLY QUALIFIED IA RATES How is null data specified? Separator text will be present. What does null data indicate? Null is not used.
|
|
|
|
|
|
<RefPt>
|
Alphanumeric
|
30
|
Description of Field: Text description of pickup location Format (x-alpha/numeric): xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx Examples: OHARE INTL ARPT How is null data specified? Blanks What does null data indicate? No description provided
|
|
<City>
|
Alpha
|
5
|
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: DENblankblank How is null data specified? Field will be populated with city code. What does null data indicate? Nulls will not be returned
|
|
<State>
|
Alpha
|
2
|
Description of Field: State code for the rental Format (a-alpha): aa Examples: CO How is null data specified? Blanks What does null data indicate? No state code present
|
|
<Country>
|
Alpha
|
2
|
Description of Field: Country code Format (a-alpha): aa Examples: US How is null data specified? Country code will always be present What does null data indicate? Nulls will not be returned
|
|
<DistUnit>
|
Alpha
|
1
|
Description of Field: Unit of distance to be used Format (a-alpha): a Possible Values (List): M - Miles K - Kilometers How is null data specified? Either M or K will be returned. What does null data indicate? Nulls will not be returned
|
|
<RateTypeDesc>
|
Alpha
|
7
|
Description of Field: Rate type description Format (a-alpha): aaaaaaa Examples: WEEKLY How is null data specified? Blanks What does null data indicate? No description present
|
|
<RateCatDesc>
|
Character
|
11
|
Description of Field: Rate category description Format (c-character): ccccccccccc Examples: STD/PROM How is null data specified? Blanks What does null data indicate? No description present
|
|
<Currency>
|
Alpha
|
3
|
Description of Field: Currency in which the rates are quoted Format (a-alpha): aaa How is null data specified? Currency will be present What does null data indicate? Nulls will not be used
|
|
<DecPos>
|
Numeric
|
1
|
Description of Field: The number of places to the right of the implied decimal for the currency the rates are quoted in Format (n-numeric): n Possible Values (Range): 0 - 9 How is null data specified? Zero What does null data indicate? No decimals are used
|
|
<TruncDec>
|
Alpha
|
1
|
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 Blank - Truncate How is null data specified? Blank What does null data indicate? Blank defaults to truncate or Y
|
|
<AltRateInd>
|
Numeric
|
1
|
Description of Field: Determines if another rate type might apply. The PC may be required to display a message corresponding to the following values. Format (n-numeric): n Possible Values (List): 0 - No message 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 How is null data specified? Field will always be populated What does null data indicate? Nulls will not be used
|
CarItemCnt Structured data only. Not in XML.
|
Numeric
|
2
|
Description of Field: The total number of car items included in this transmission Format: nn Possible Values (Range): 0 - 99 How is null data specified? Zero What does null data indicate? No car data returned
|
|
<MoreCarsInd>
|
Alpha
|
1
|
Description of Field: Indicates if more car items are available. To request more data, another 7100 is sent in with more data set to Y and the data base key from the next field below in the DB key field of the 7100. Format (a-alpha): a Possible Values (List): Y - Yes N - No How is null data specified? Field will always be populated What does null data indicate? N/A
|
|
<DBKey>
|
Alphanumeric
|
10
|
Description of Field: Data base key to get more rates. It must be transmitted in the 7100 requesting more data. Note this key differs from the rate database key embedded in the car items. Format (x-alpha/numeric): xxxxxxxxxx Examples: 7649347051 How is null data specified? Zeros or blanks What does null data indicate? No more data available
|
|
+ <CarDetailAry>
|
Array
|
n/a
|
|
Purpose: This detail block will be repeated several times when there is a successful return from the CAL request.
|
|
+ <CarDetail>
|
FieldSet
|
n/a
|
|
|
<Vnd>
|
Alpha
|
3
|
Description of Field: Car vendor code. Format (a-alpha): aaa Special Format Currently the third character is unused-always blank. Examples: ZIblank How is null data specified? Blank What does null data indicate? No data present
|
|
<LocAffiliate>
|
Alphanumeric
|
3
|
Description of Field: Identification of alternate vendor name used at this location, if any. Format (x-alpha/numeric): xxx Special Format: Typically this is a three digit code. Anything other than 001 means that the vendor has an agreement with another company to sell their cars. For example, Ace rental cars may be rented by a local company in Miami named Florida rentals. The numeric code has meaning only to the CarMaster internal database. How is null data specified? Field will contain 001 if there are no alternate vendors What does null data indicate? N/A
|
|
<PrimeLocn>
|
Alpha
|
1
|
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 (List): P - Prime location N - Not prime location How is null data specified? Field will not be null. What does null data indicate? N/A
|
|
<LinkInd>
|
Alpha
|
1
|
Description of Field: This describes the availability source of the car item. Format (a-alpha): a Possible Values (List): L - Link vendor N - Not Link vendor I - Inside Availability Vendor J - Inside Availability Vendor w/ alternate name W - Link vendor w/ alternate name O - Non-Link vendor w/ alternate name How is null data specified? Field will always be populated What does null data indicate? N/A
|
|
<City>
|
Alpha
|
5
|
Description of Field: Code of the pickup location Format (a-alpha): aaaaa Special Format: Three character city code followed by two blanks Examples: DENblankblank How is null data specified? Blanks What does null data indicate? No pickup location specified
|
|
<LocnCat>
|
Alpha
|
1
|
Description of Field: Category of location. 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? Field will not be null. What does null data indicate? N/A
|
|
<LocnExpansion>
|
Alphanumeric
|
1
|
Description of Field: Reserved for future use Format (x-alpha/numeric): x How is null data specified? 0 What does null data indicate? No expansion used.
|
|
<LocnNum>
|
Numeric
|
2
|
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 location number present
|
|
<Dist>
|
Alphanumeric
|
3
|
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
|
|
<Dir>
|
Alphanumeric
|
2
|
Description of Field: Direction from reference point Format (x-alpha/numeric): xx Possible Values: Normally compass direction. 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 direction present
|
|
<GeoLat>
|
Character
|
8
|
Description of Field: Geographic Coordinate for Latitude Format (c-character): cccccccc Special Format: First character is the latitude sign: Blank = North of the equator - = South of the equator Followed by 7 numeric in 3V4 format - example: 0843675 implies 3 digits to the left and 4 digits to the right if the implied decimal point (implied as 084.3675) How is null data specified? Character blanks What does null data indicate? No data present
|
|
<GeoLon>
|
Character
|
8
|
Description of Field: Geographic Coordinate for Longitude Format (c-character): cccccccc Special Format: First character is the longitude sign: Blank = East of the meridian - = West Followed by 7 numeric in 3V4 format - example: 1032419 implies 3 digits to the left and 4 digits to the right if the implied decimal point (implied as 103.2419) How is null data specified? Blanks What does null data indicate? No data present
|
|
<CarType>
|
Alpha
|
4
|
Description of Field: Details of specifying car types are found in the Apollo or Galileo User Format Guides. Format (a-alpha): aaaa Examples: ECAR ICAR CCAR How is null data specified? A value will always be returned. What does null data indicate? N/A
|
|
<YieldMgmt>
|
Alphanumeric
|
1
|
Description of Field: Needed for the sell. Vendors use this to manage inventory. This value should be passed back to the car vendor in the 7150 Sell Request. Format (x-alpha/numeric): x How is null data specified? Character blanks What does null data indicate? No yield management data used.
|
|
<Amt>
|
Numeric
|
9
|
Description of Field: The car rate expressed in the currency defined by Currency. Location of implied decimal point specified by Number of Decimals. Format (n-numeric): nnnnnnnnn Special Format: All 9s mean maximum display limit exceeded. Examples: 000003355 How is null data specified? 0 What does null data indicate? Rate is absent
|
|
<BaseRateAmt>
|
Numeric
|
12
|
Description of Field: Base rate accounts for the number of days, hours etc. of the rental, but may not include all fees. Format (n-numeric): nnnnnnnnnnnn Special Format: Right justified with leading zeros Examples: 000000001111 How is null data specified? 0 What does null data indicate? No base rate present
|
|
<DropChargeIncInd>
|
Alpha
|
1
|
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 How is null data specified? Blank What does null data indicate? No drop charge application data
|
|
<UpsellInd>
|
Alpha
|
1
|
Description of Field: Vendor provided indicator which designates that car type returned represents a car type which is better than that originally requested. Format (a-alpha): a Possible Values (List): Y - Upsell opportunity Blank How is null data specified? Character blanks What does null data indicate? Car is not an upsell type
|
|
<RatePlcmtInd>
|
Numeric
|
1
|
Description of Field: Indicates whether rates comply with CD, ID, or Drop Off requested. 1 is fully qualified, 2 is partly qualified, and 3 is other rates. Format (n-numeric): n Possible Values (List): 1 - Rates to Section 1 2 - Rates to Section 2 3 - Rates to Section 3 How is null data specified? A value will always be returned. What does null data indicate? N/A
|
|
<RateType>
|
Alpha
|
1
|
Description of Field: Indicates what the rate is based on. Format (a-alpha): a Possible Values (List): D - Daily E - Weekend W - Weekly M - Monthly H - Hourly P - Package How is null data specified? A value will always be returned What does null data indicate? N/A
|
|
<RateGuar>
|
Alpha
|
1
|
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? A value will always be returned. What does null data indicate? N/A
|
|
<AdditionalCharges>
|
Alpha
|
1
|
Description of Field: Indicates if there are other charges that are not included in the base rate. Format (a-alpha): a Possible Values (List): Y - Required charge exists N - No required charge How is null data specified? A value will always be returned What does null data indicate? N/A
|
|
<AvailStatus>
|
Alpha
|
1
|
Description of Field: Indicator of the availability of this car for rent. Format (a-alpha): a Possible Values (List): S - Available for sale N - Need to call C - Closed How is null data specified? A value will always be returned What does null data indicate? N/A
|
|
<MileRate>
|
Numeric
|
9
|
Description of Field: The charge for extra miles. Format (n-numeric): nnnnnnnnn Special Format: All 9s mean maximum display limit exceeded. Examples: 000000010 How is null data specified? 0 What does null data indicate? No charge
|
|
<Mile>
|
Alphanumeric
|
5
|
Description of Field: Numeric mileage limits or UNL for unlimited. Format (x-alpha/numeric): xxxxx Examples: UNLblankblank How is null data specified? Character blanks What does null data indicate? No mileage limit
|
|
<DropOffRestrictions>
|
Alpha
|
1
|
Description of Field: Field provides indicator of one-way rental possibilities. Format (a-alpha): a Possible Values (List): Y - Return to pickup point N - Drop off any location Blank - Return to pickup point
If the request is a one-way rental, the default for this indicator is ‘N’. If the request is not a one-way rental, the default is ‘Y’.
How is null data specified? Blank What does null data indicate? Blanks = Y or N, depending on request.
|
|
<RateCat>
|
Alpha
|
1
|
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? A value will always be returned What does null data indicate? N/A
|
|
<Rate>
|
Alphanumeric
|
6
|
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? Character blank What does null data indicate? No rate code
|
|
<RateDBKey>
|
Numeric
|
10
|
Description of Field: Data Base key for this rate Format (n-numeric): nnnnnnnnnn Examples: 1234567890 How is null data specified? 0 What does null data indicate? No rate database key
|
|
The following fields are conditional and will only exist if the Link Indicator is 'I' or 'J' for Inside Availability Vendor.
|
|
+ <InclRateQual>
[Qualified By: LinkInd of I,J]
|
FieldSet
|
n/a
|
|
|
<RateDesc>
|
Alpha
|
40
|
Description of Field: Free form text used to describe Rate Format (a-alpha): aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa Examples: Special daily How is null data specified? Character blanks What does null data indicate? No descriptor provided
|
|
<InclRate1>
|
Alphanumeric
|
3
|
Description of Field: Show additional changes included in rate. Inclusive rates can be sent by Inside Availability vendors. Format (x-alpha/numeric): xxx Examples: VAT How is null data specified? Character blanks What does null data indicate? No inclusive charge
|
|
<InclRate2>
|
Alphanumeric
|
3
|
Description of Field: Shows additional changes included in rate. Format (x-alpha/numeric): xxx Examples: LDW How is null data specified? Character blanks What does null data indicate? No inclusive charge
|
|
<InclRate3>
|
Alphanumeric
|
3
|
Description of Field: Shows additional changes included in rate Format (x-alpha/numeric): xxx Examples: VAT How is null data specified? Character blanks What does null data indicate? No inclusive charge
|
|
<InclRate4>
|
Alphanumeric
|
3
|
Description of Field: Shows additional changes included in rate Format (x-alpha/numeric): xxx Examples: VAT How is null data specified? Character blanks What does null data indicate? No inclusive charge
|
|
<PrePayInd>
|
Alpha
|
1
|
Description of Field: Indicates vendor requires certain payment information at the time of booking. Format (a-alpha): a Possible Values (List): Blank - None G - Guarantee D - Deposit P - Pre-pay How is null data specified? Blank What does null data indicate? Pay at pick up
|
|
<CarTypeDesc>
|
Alphanumeric
|
30
|
Description of Field: Expanded description of the car. Format (x-alpha/numeric): xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx Examples: Ford Taurus or Similar How is null data specified? Character blanks What does null data indicate? No description provided
|
|
<DropChargeAmt>
|
Numeric
|
10
|
Description of Field: Present when vendor returns a drop charge in response to a one way rental request Format (n-numeric): nnnnnnnnnn How is null data specified? 0 What does null data indicate? No drop charges provided
|
|
<ApproxTotAmt>
|
Numeric
|
12
|
Description of Field: This total is intended to be a true bottom line cost for the customer including all taxes and fees. Format (n-numeric): nnnnnnnnnnnn Special Format: Right justified, with leading zeros Examples: 000000001111 How is null data specified? 0 What does null data indicate? No data
|
|
|
|
|
|
|
|
|
|
|
|
|
+ <CarVErrors>
|
7103 7.0
|
|
|
|
|
|
Purpose: The Car Availability response describes the additional Vendor alert messages as it pertains to Inside Availability participants. This is an extension of the 7101 when a Car Inside Availability Participant alert Message exists.
|
VErrCnt Structured data only. Not in XML.
|
Numeric
|
2
|
Description of Field: Count of alerts sent by Inside Availability Participants. These are information messages for the user/agent. Format (n-numeric): nn Examples: 03 How is null data specified? 0
|
|
+ <VErrAry>
|
Array
|
n/a
|
|
|
+ <VErrInfo>
|
FieldSet
|
n/a
|
|
|
Beginning of Vendor Alert Section
|
|
<Num>
|
Numeric
|
4
|
Description of Field: Error Code returned from vendor. Meaningful to CarMaster. The most common is a 34 which indicates text is from vendor. Format (n-numeric): nnnn Examples: 0034
|
|
<Msg>
|
Alpha
|
64
|
Description of Field: This is the content of the message. Each message is 64 characters maximum. This includes the vendor code and location number, which are auto appended to the beginning of the text. Format (a-alpha): aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa Examples: ZINYCC04-Stn closed at requested Pickup time
|
|
<TypeInd>
|
Alpha
|
1
|
Description of Field: Meaningful to CarMaster. Format (a-alpha): A Possible Values (List): F - Fixed Message T - Vendor Text A - Fixed Message with appended text.
|
|
<Vnd>
|
Alpha
|
3
|
Description of Field: Vendor Code Format (a-alpha): aaa Special Format: Trailing blank Examples: ZIblank
|
|
<Locn>
|
Alpha
|
6
|
Description of Field: Location Code. This relates to the location codes in the 7100 and 7101. Format (a-alpha): aaaaaa Examples: DENT01
|
|
|
|
|
|
|
|
|
+ <CarIndex>
|
7116 7.0
|
|
|
|
|
|
<Signature>
|
Alphanumeric
|
1
|
0=No errors S=Similar names list. Refer to transaction 6181 for details. E=Error with no data returned W=Error with data returned - an error message will follow
|
|
The next two fields are conditional and will exist only if the Type Response Returned field is W or E.
|
|
+ <ErrQual>
[Qualified By: Signature of E,Value,W]
|
FieldSet
|
n/a
|
|
|
|
|
The remainder of the record will appear when the Type Response Returned field is 0 or W.
|
|
+ <DataQual>
[Qualified By: Signature of 0,W]
|
FieldSet
|
n/a
|
|
|
<RefName>
|
Alphanumeric
|
30
|
|
|
<State>
|
Alpha
|
2
|
State code for the rental
|
|
<Country>
|
Alpha
|
2
|
Country code
|
|
<DistUnit>
|
Alpha
|
1
|
M=Miles K=Kilometers
|
|
<TotCnt>
|
Numeric
|
2
|
The total number of location items included in this trans mission. These items will be in an associated 7117 trans action.
|
|
<MoreAvail>
|
Alpha
|
1
|
Y=Yes N=No
|
|
The following Get More fields are included in the request only if More Indicator = Y.
|
|
+ <MoreAvailQual>
[Qualified By: MoreAvail of Y]
|
FieldSet
|
n/a
|
|
|
<IDMSControl>
|
Numeric
|
1
|
Control used by MVS for "Get More"
|
|
<StartDBKey>
|
Numeric
|
10
|
Data base key for start of location index
|
|
<RefPtDBKey>
|
Numeric
|
10
|
Data base key for reference point
|
|
<GroupSubscript>
|
Numeric
|
5
|
MVS control information
|
|
<NewHeaderInd>
|
Character
|
1
|
Control data used by MVS. Will contain Y or N.
|
|
|
|
|
|
|
|
|
+ <CarIndexDetail>
|
7117 7.0
|
|
|
|
|
RecCnt Structured data only. Not in XML.
|
Numeric
|
2
|
The number of location items returned in this block. A maximum of 20 is allowed in each location item block.
|
|
<TotCnt>
|
Numeric
|
4
|
The total number of items that will be returned from all 7117 blocks
|
|
+ <LocnAry>
|
Array
|
n/a
|
|
|
+ <Locn>
|
FieldSet
|
n/a
|
|
|
<Group>
|
Alpha
|
2
|
Unique identifier that associated one or more items to a logical location
|
|
<VSuf>
|
Alpha
|
3
|
Identification of alternate vendor name used at this location, if any
|
|
<PrimeLocn>
|
Alpha
|
1
|
P=Prime location N=Not prime location
|
|
<LinkInd>
|
Alpha
|
1
|
L=Link vendor N=Not Link vendor I = Inside Availability Vendor J = Inside Availability Vendor w/ alternate Name W = Link vendor w/ alternate name O = Non-Link vendor w/ alternate name
|
|
<LocnCat>
|
Alpha
|
1
|
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=Rail
|
|
<Filler>
|
Numeric
|
1
|
Reserved for future use
|
|
<LocnNum>
|
Numeric
|
2
|
A two-digit number used to identify specific rental location within a location category
|
|
<LocnAddr>
|
Alphanumeric
|
26
|
|
|
<Dist>
|
Alphanumeric
|
3
|
Distance from reference point
|
|
<Dir>
|
Character
|
2
|
Direction from reference point
|
|
<GeoLat>
|
Alpha
|
8
|
Geographic Coordinants for Latitude
|
|
<GeoLon>
|
Alpha
|
8
|
Geographic Coordinants for Longitude
|
|
|
|
|
|
|
|
|
|
|