WorldSpan - 9I05 SecuRate Air Linear Entries Technical Guide

SecuRate Air Linear Entries Technical Guide
Version 1.0
Section One Fare Item Entries SecuRate Air Linear Entries Technical Guide
10/11/2001
I:\Terri K\16388 tech guide.doc
10/11/2001
Table Of Contents
1 SECTION ONE FARE ITEM ENTRIES......................................................... 1.1 FLAT RATE FARE ITEM CREATE ENTRY LAYOUT .................................................... 1.2 IELD DESCRIPTIONS ....................................................................................................... 1.2 DISCOUNTED PUBLISHED FARE ITEM CREATE ENTRY LAYOUT ............................... 1.5 FIELD DESCRIPTIONS..................................................................................................... 1.5 NET/NET FARE ITEM CREATE ENTRY LAYOUT ........................................................ 1.8 FIELD DESCRIPTIONS..................................................................................................... 1.8 CHANGE ENTRY FOR SINGLE FARE ITEM - LAYOUT ................................................. 1.11 FIELD DESCRIPTIONS................................................................................................... 1.11 CHANGE ENTRY FOR A RANGE OF FARE ITEMS - LAYOUT ........................................ 1.11 FIELD DESCRIPTIONS................................................................................................... 1.11 CHANGE ENTRY FOR A MULTIPLE FARE ITEMS - LAYOUT ........................................ 1.12 FIELD DESCRIPTIONS................................................................................................... 1.12 DELETE ENTRY FOR A SINGLE FARE ITEM LAYOUT ............................................... 1.13 FIELD DESCRIPTIONS................................................................................................... 1.13 DELETE ENTRY FOR A RANGE OF FARE ITEMS LAYOUT......................................... 1.13 FIELD DESCRIPTIONS................................................................................................... 1.13 DELETE ENTRY FOR MULTIPLE FARE ITEMS LAYOUT ........................................... 1.13 FIELD DESCRIPTIONS................................................................................................... 1.13 DELETE ENTRY FOR ALL FARE ITEMS LAYOUT ..................................................... 1.14 FIELD DESCRIPTION .................................................................................................... 1.14 DELETE ENTRY FOR FIELD(S) WITHIN A SINGLE FARE ITEM LAYOUT .................. 1.15 FIELD DESCRIPTIONS................................................................................................... 1.15 DELETE ENTRY FOR FIELD(S) WITHIN A RANGE OF FARE ITEMS LAYOUT ............. 1.15 FIELD DESCRIPTIONS................................................................................................... 1.15 DELETE ENTRY FOR FIELD(S) WITHIN MULTIPLE FARE ITEMS LAYOUT ................ 1.16 FIELD DESCRIPTIONS................................................................................................... 1.16 DELETE ENTRY FOR FIELD(S) WITHIN MULTIPLE FARE ITEMS LAYOUT ............... 1.16 FIELD DESCRIPTIONS................................................................................................... 1.16 2 SECTION TWO: FIELD IDENTIFIERS ........................................................... 2.1 CXR............................................................................................................................. 2.1 BAG ............................................................................................................................ 2.2 BKG ............................................................................................................................ 2.2 CAR............................................................................................................................. 2.3 CMP ............................................................................................................................ 2.3 CMU............................................................................................................................ 2.4 COM............................................................................................................................ 2.4 CON ............................................................................................................................ 2.4
10/11/2001
CUR............................................................................................................................. 2.5 DIR.............................................................................................................................. 2.5 DST ............................................................................................................................. 2.6 PCT ............................................................................................................................. 2.7 MST............................................................................................................................. 2.8 NET ............................................................................................................................. 2.8 NON ............................................................................................................................ 2.9 ORG .......................................................................................................................... 2.10 PFB............................................................................................................................ 2.11 RTG........................................................................................................................... 2.12 SCA ........................................................................................................................... 2.12 SEL............................................................................................................................ 2.13 TDC........................................................................................................................... 2.13 TFB ........................................................................................................................... 2.13 TVL ........................................................................................................................... 2.14 UPG........................................................................................................................... 2.14 VAL........................................................................................................................... 2.14 3 SECTION THREE: DESCRIPTORS ................................................................. 3.1 DESCRIPTOR CREATE ENTRY LAYOUT ..................................................................... 3.2 FIELD DESCRIPTION ...................................................................................................... 3.2 DESCRIPTOR DELETE ENTRY LAYOUT ..................................................................... 3.2 FIELD DESCRIPTION ...................................................................................................... 3.2 DESCRIPTOR RULE MODIFICATION ENTRY LAYOUT................................................ 3.2 FIELD DESCRIPTIONS..................................................................................................... 3.2 DESCRIPTOR DISPLAY ENTRY LAYOUT .................................................................... 3.3 FIELD DESCRIPTIONS..................................................................................................... 3.3 APPLYING A DESCRIPTOR .............................................................................................. 3.3 4 SECTION FOUR: AGREEMENT LEVEL RULES (UNDER DEVELOPMENT) .. 4.1 5 6 7 SECTION FIVE: FARE ITEM LEVEL RULES (UNDER DEVELOPMENT) ....... 5.1 SECTION SIX: ERROR CONDITIONS SPECIFIC TO LINEAR ENTRIES 6.1 SECTION SEVEN: INPUT/OUTPUT ................................................................ 7.1
10/11/2001
Introduction:
This document provides SecuRate Air users with the technical information necessary to interface with Worldspans SecuRate Air Database. Using Linear Entries, users can administer SecuRate Air without using templates. Linear Entries provide manual template users with some desirable shortcuts. In addition, Linear Entries provide third party users and robotics the necessary medium to more easily add, delete, and modify information within the SecuRate Air Database. The Linear Entries in this document are broken down into separate components for ease of application. This allows users to start taking advantage of Linear Entries while some components are still in development. At the initial release of the Technical Guide, several components of Linear Entries are still in development and those sections will be completed as products are released. Another reason for the sectional approach to the guide is to allow users to choose the component of the product that most specifically meets their most pressing business need, allowing them to tailor their adoption of Linear Entries to their business. Following is a list of the sections and what they cover:
Section
Section One: Fare Item Entries
Description
This section covers all the entries required to create, delete, and modify individual or multiple fare items. Mandatory fields are identified and format examples are included for optional fields. This section lists all of the mandatory and optional fields available for Fare Item entries. Field definitions, technical specifications and requirements are described for each individual field. This section covers the entries used to create, change, and delete descriptors. The Linear Entries for agreement level rules are currently under development and will be added as they are completed and released. In general, the agreement level rules are one rule per agreement that is applied for the whole agreement. These rules are found on the 4F- menu of the template product.
Section Two: Field Identifiers
Section Three: Descriptors Section Four: Agreement Level Rules
10/11/2001
Section Five: Fare Item Level Rules
The Linear Entries for fare item level rules are currently under development and will be added as they are completed and released. These rules are designed to be applied to individual fare items. These rules are found on the 4F-G menu of the template product. This section identifies error conditions and responses that are specific to the Linear Entry product. New errors will be added to this section as development continues. Please Note: The Linear product uses standard error responses where possible. For more information on SecuRate Air error responses see the SecuRate Air Manual. Designed specifically for robotics and third party users, this section provides character placement specifications for entries and responses. New entries and responses will be added to this section as they are released.
Section Six: Error Conditions
Section Seven: Input/Output
Once each component of linear entries is utilized to interface with the SecuRate Air database, they may be combined resulting in an environment where all phases of the database is manageable using Linear Entries.
10/11/2001
Section One Fare Item Entries

SecuRate Air Linear Entries may be used to create, modify, or delete Flat Rate, Discounted Published, or Net/Net fare items. In almost all cases, linear entries are completely compatible with the template product. Fare Items built using the template product can be changed or deleted using linear entries and fare items built with linear entries may be changed or deleted using templates. In a few instances, the user has additional functionality when using linear entries. Once the additional functionality has been taken advantage of, the user is required to continue to use linear entries to make changes to those fare items. Those instances will be identified through out this document, when they apply.
1.1
10/11/2001
Flat Rate Fare Item Create Entry Layout
4F-F/FR/CXR-AA/DIR-B/TFB-CCCCCCCC/AMTDDDDDDDD/BKG-EE*EE/DESC-FFFF Please Note: This entry includes all mandatory fields. Additional optional fields may also be added. For a comprehensive list of all fields and their description, please see the Field Identifier Chart in Section Two. Field 4F-F / FR / CXRAA / DIRB / TFBCCCCCCC / AMTDDDDDDDD / BKGEE*EE / DESCFFFF Description Function Identifier Field Separator Indicates Flat Rate Field Separator Airline Carrier Code Field Identifier Airline Carrier Code Field Separator Direction of Travel Field Identifier Direction of Travel Field Separator Ticketed Fare Basis Code Field Identifier Ticketed Fare Basis Code Field Separator Fare Amount Field Identifier Amount of Fare Field Separator Booking Class Field Identifier Booking Class Field Separator Descriptor Field Identifier Descriptor Number (see Section Three) Please Note: For a comprehensive list of all fields and their description please see the Field Identifier Chart in Section Two. Max 4 1 2 1 4 2 1 4 1 1 4 8 1 4 8 1 4 29 1 5 4
Field Descriptions
1.2
10/11/2001
Example of Linear Entry using the mandatory fields to create a Flat Rate Fare:
Entry: 4F-F/FR/CXR-DL/DIR-B/TFB-TEST/AMT-100.00/BKG-Y/DESC-0005
Rule Descriptor Booking Class Amount of Fare Ticketing Fare Basis Code Direction of Travel Airline Carrier Code Designates this as a Flat Rate Fare Function Identifier
Response: >4F-F/FR/CXR-XX/DIR-B/TFB-TEST/AMT-100.00/BKG-Y/DESC-0005 ( OK - FARE ITEM CREATED ** Please Note: The input message is redisplayed with the confirmation message, allowing the user to check his work.
1.3
The following fare item is created: Entry: 4F-U*F/SIDAGR
10/11/2001
Response: SECURATE FARE ITEMS AGREEMENT SIDAGR 001 ANYWHERE - ANYWHERE A/L-XX DIR-B TVL-000 RTG-0000 BKG-Y TKT DSG-UNASSIGNED CUR-USD TKT FBC-TEST PUBL FBC-N/A UPGRADE-N FARE AMT100.00 SCALED-N/A COMB-P/U DESC-0005 RULES-Z05C **END** > If any of the mandatory fields have not been added in the creation entry SecuRate AIR will return an error message identifying the field that must be added. CONDITION ERROR RESPONSE
Missing or invalid Flat Rate Fare indicator Missing Airline Carrier Code Invalid or missing Direction of Travel Invalid or missing Ticketing Fare Basis Code Invalid or missing Amount of Fare Invalid or missing Booking Class If a rule descriptor with a B is attached Missing descriptor
INVALID FARE TYPE INVALID AIRLINE CODE INVALID DIRECTION-MUST BE O D B INVALID TICKETED FARE BASIS INVALID AMOUNT / CURRENCY INVALID BOOKING CODE B RULE INVLD FOR THIS FARE TYPE INVALID DESCRIPTOR NUMBER
1.4
10/11/2001
Discounted Published Fare Item Create Entry Layout
4F-F/DP/CXR-XX/DIR-B/TFB-CCCCCCCC/PFBDDDDDDDD/PCT-EE/BKG-F Please Note: This entry includes all mandatory fields. Additional optional fields may also be added. For a comprehensive list of all fields and their description, please see the Field Identifier Chart in Section Two. Field 4F-F / DP / CXRAA / DIRB / TFBCCCCCCCC / PFBDDDDDDDD / PCTEEE / BKGFF*FF Description Function Identifier Field Separator Indicates Discounted Published Field Separator Airline Carrier Code Field Identifier Airline Carrier Code Field Separator Direction of Travel Field Identifier Direction of Travel Field Separator Ticketed Fare Basis Code Field Identifier Ticketed Fare Basis Field Separator Published Fare Basis Code Field Identifier Published Fare Basis Code Field Separator Percent Field Identifier Discount Percent Field Separator Booking Code Field Identifier Booking Code Please Note: For a comprehensive list of all fields and their description please see the Field Identifier Chart in Section Two. Max 4 1 2 1 4 2 1 4 1 1 4 8 1 4 8 1 4 3 1 4 29
Field Descriptions
1.5
10/11/2001
Example of Linear Entry using the mandatory fields to create a Discounted Published Fare:
Entry: 4F-F/DP/CXR-XX/DIR-B/TFB-TEST/PFB-YPUB/PCT-40/BKG-Y
Booking Class Discount Percent ** Published Fare Basis Code Ticketing Fare Basis Code Direction of Travel Airline Carrier Code Designates Discount Published Fare
Function Identifier **Please Note: Either the Discount Percent (PCT) -OR- the Discount Amount field (AMT) is required
1.6
Response: >4F-F/DP/CXR-XX/DIR-B/TFB-TEST/PFB-YPUB/PCT-40/BKG-Y ( OK - FARE ITEM CREATED
10/11/2001
** Please Note: The input message is redisplayed with the OK message allowing the user to check his work. The following fare item is created: Entry: 4F-U*F/SIDAGR Response: SECURATE FARE ITEMS AGREEMENT SIDAGR 001 ANYWHERE - ANYWHERE A/L-XX DIR-B TVL-000 RTG-0000 BKG-Y TKT DSG- SIDAGR CUR-N/A TKT FBC-TEST PUBL FBC-YPUB UPGRADE-N FARE AMT-N/A SCALED-N/A DISC PCT- 40 COMB-P/U MUST STOP-N CONNEX-N NONSTOP-N FBC-I **END** > If any of the mandatory fields have not been added in the creation entry SecuRate AIR will return an error message identifying the field that must be added. CONDITION ERROR RESPONSE
Missing or invalid Flat Rate Fare indicator Missing Airline Carrier Code Invalid or missing Direction of Travel Invalid or missing Ticketing Fare Basis Code Invalid or missing Amount of Fare Invalid or missing Booking Class If a rule descriptor with a B is attached Missing descriptor
INVALID FARE TYPE INVALID AIRLINE CODE INVALID DIRECTION-MUST BE O D B INVALID TICKETED FARE BASIS INVALID AMOUNT / CURRENCY INVALID BOOKING CODE B RULE INVLD FOR THIS FARE TYPE INVALID DESCRIPTOR NUMBER
1.7
10/11/2001
Net/Net Fare Item 4F-F/NN/CXR-AA/DIR-B/TFB-CCCCCCCC/NETDDDDDDDDD/CUR-EEE/BKG-FF*FF/DESC-GGGG Create Entry Layout Please Note: This entry includes all mandatory fields. Additional
optional fields may also be added. For a comprehensive list of all fields and their description please see the Field Identifier Chart in Section Two.
Field Descriptions
Field 4F-F / NN / CXRAA / DIRB / TFBCCCCCCCC / NETDDDDDDDDD / CUREEE / BKGFF*FF / DESCGGGG
Description Function Identifier Field Separator Indicates Net/Net Field Separator Airline Carrier Code Field Identifier Airline Carrier Code Field Separator Direction of Travel Field Identifier Direction of Travel Field Separator Ticketed Fare Basis Code Field Identifier Ticketed Fare Basis Code Field Separator Net Fare Amount Field Identifier Net Fare Amount Field Separator Currency Code Field Identifier Currency Code Field Separator Booking Code Field Identifier Booking Code Field Separator Descriptor Field Identifier Descriptor Number
Max 4 1 2 1 4 2 1 4 1 1 4 8 4 9 1 4 3 1 4 4 29 1 5 4
1.8
10/11/2001
Example of Linear Entry using the mandatory fields to create a Net/Net Fare:
Entry: 4F-F/NN/CXR-XX/DIR-B/TFB-TEST/NET-50.00/CUR-USD/BKG-Y/DESC-0005
Rule Descriptor Booking Class Currency Net Amount of Fare Ticketing Fare Basis Code Direction of Travel Airline Carrier Code Designates this as a Net/Net Fare Function Identifier
Response: >4F-F/NN/CXR-XX/DIR-B/TFB-TEST/AMT-100.00/CUR-USD/BKG-Y/DESC-0005 ( OK - FARE ITEM CREATED ** Please Note: The input message is redisplayed with the OK message allowing the user to check his work.
1.9
10/11/2001
The following fare item is created. Entry: >4F-U*F/SIDAGR
001 ANYWHERE - ANYWHERE A/L-NW DIR-B TVL-000 RTG-0000 BKG-Y TKT DSG-UNASSIGNED CUR-USD TKT FBC-TEST PUBL FBC-N/A COMB-Y NET50.00 SELL-N/A PLUS UP-N/A AMT-N/A BAGGAGE-N/A COMM-N/A DESC-0005 RULES-Z05C C.A.R-N/A VALUE CODE-N/A **END** > If any of the mandatory fields have not been added in the creation entry SecuRate AIR will return an error message identifying the field that must be added CONDITION ERROR RESPONSE
Designates this as a Net/Net Fare Missing Airline Carrier Code Invalid or missing Direction of Travel Missing Ticketing Fare Basis Code Missing Net Amount of Fare Invalid or missing currency Decimal placement of amount does not match currency Invalid or missing booking class Missing Rule Descriptor
INVALID FARE TYPE

INVALID AIRLINE CODE
INVALID DIRECTION-MUST BE O D B INVALID TICKETED FARE BASIS NET FARE RQRD INVALID CURRENCY CODE INVALID NET FARE / CURRENCY INVALID BOOKING CODE INVALID DESCRIPTOR NUMBER
1.10
10/11/2001
Change Entry for 4F-F/C/AAAA/BBBSingle Fare Item Layout

Field Descriptions
Field 4F-F / C / AAAA / BBBDescription Function Identifier Field Separator Indicates Change Entry Field Separator Fare Item Number Field Separator Field Identifier of field(s)to be changed Please Note: For a comprehensive list of all fields and their description please see the Field Identifier Chart in Section Two. Max 4 1 1 1 4 1 4
Change Entry for a Range of Fare Items - Layout

Field Descriptions
4F-F/C/AAAA-BBBB/CCC-
Field 4F-F / C / AAAA BBBB / CCC-
Description Function Identifier Field Separator Indicates Change Entry Field Separator Beginning Fare Item Number Field Separator Ending Fare Item Number Field Separator Field Identifier(s) to be Changed Please Note: For a comprehensive list of all fields and their description please see the Field Identifier Chart in Section Two.
Max 4 1 1 1 4 1 4 1 4
1.11
10/11/2001
Change Entry for a Multiple Fare Items - Layout

Field Descriptions
4F-F/C/AAAA/AAAA/AAAA/AAAA/AAAA/AAAA/BBB-
Field 4F-F / C / AAAA / BBB-
Description Function Identifier Field Separator Indicates Change Field Separator Fare Item Number (Maximum of 6) Field Separator Field Identifier(s) to be Changed Please Note: For a comprehensive list of all fields and their description please see the Field Identifier Chart in Section Two.
Max 4 1 1 1 4 1 4
Example of Linear Entry using the mandatory fields to change a fare: Entry: 4F-F/C/0005/ORG-MCI*C/DST-ATL*C Response: >4F-F/C/0005/ORG-MCI*C/DST-ATL*C( OK FARE ITEM CHANGED
1.12
10/11/2001
Delete Entry for a 4F-F/D/AAAA Single Fare Item Layout

Field Descriptions
Field 4F-F / D / AAAA Description Function Identifier Field Separator Indicates Delete Field Separator Fare Item Number Max 4 1 1 1 4
Delete Entry for a Range of Fare Items Layout

Field Descriptions
4F-F/D/AAAA-BBBB
Field 4F-F / D / AAAA BBBB
Description Function Identifier Field Separator Indicates Delete Field Separator Beginning Fare Item Number Field Separator Ending Fare Item Number
Max 4 1 1 4 1 4 4
Delete Entry for Multiple Fare Items Layout

Field Descriptions
4F-F/D/AAAA/AAAA/AAAA/AAAA
Field 4F-F / D / AAAA
Description Function Identifier Field Separator Indicates Delete Field Separator Fare Item Number (Maximum of 6)
Max 4 1 1 1 4
1.13
10/11/2001
Delete Entry for All Fare Items Layout

Field Description
4F-F/D/ALL
Field 4F-F / D / ALL
Description Function Identifier Field Separator Indicates Delete Field Separator Indicates All
Max 4 1 1 1 4
Example:
Entry to delete a single Fare Item: 4F-F/D/0001 Response: >4F-F/D/0001 ( OK AGREEMENT UPDATED
1.14
10/11/2001
Delete Entry for Field(s) within a Single Fare Item Layout

Field Descriptions
4F-F/D/AAAA/BBB-
Field 4F-F / D / AAAA / BBB-
Description Function Identifier Field Separator Indicates Delete Field Separator Fare Item Number Field Separator Field Identifier to be Deleted
Max 4 1 1 1 4 1 4
Delete Entry for field(s) within a Range of Fare Items Layout

Field Descriptions
Please Note: For a comprehensive list of all fields and their description please see the Field Identifier Chart in Section Two 4F-F/D/AAAA-BBBB/CCC-
Field 4F-F / D / AAAA BBBB / CCC-
Description Function Identifier Field Separator Indicates Delete Field Separator Beginning Fare Item Number Field Separator Ending Fare Item Number Field Separator Field Identifier(s) to be Deleted Please Note: For a comprehensive list of all fields and their description please see the Field Identifier Chart in Section Two
Max 4 1 1 4 1 4 4 1 4
1.15
10/11/2001
Delete Entry for field(s) within Multiple Fare Items Layout

Field Descriptions
4F-F/D/AAAA/AAAA/AAAA/AAAA/BBB-
Field 4F-F / D / AAAA / BBB-
Description Function Identifier Field Separator Indicates Delete Field Separator Fare Item Number (Maximum of 6) Field Separator Field Identifier(s) to be Deleted Please Note: For a comprehensive list of all fields and their description please see the Field Identifier Chart in Section Two
Max 4 1 1 1 4 1 4
Delete Entry for Field(s) within Multiple Fare Items Layout

Field Descriptions
4F-F/D/ALL/AAA
Field 4F-F / D / ALL / AAA
Description Function Identifier Field Separator Indicates Delete Field Separator Indicates All Field Separator Field Identifier(s) to be deleted Please Note: For a comprehensive list of all fields and their description please see the Field Identifier Chart in Section Two
Max 4 1 1 1 3 1 3
1.16
Section One Fare Item Entries SecuRate Air Linear Entries Technical Guide Example of a delete entry used to delete a field: Entry:
4F-F/D/0001/XXX Response: >4F-F/D/0001/XXX ( OK - FIELDS DELETED The following fields may be deleted in any combination or order: Field Origin and Origin type Destination and Destination type Travel/Ticket Item Number Routing Ticket Designator Baggage Car Code Value Code Descriptor Code (Discounted Published Fare Only) Field Identifier ORG DST TVL RTG TDC BAG CAR VAL DESC
10/11/2001
** Please Note: Any field not listed above is not eligible for the delete entry, a change entry is required.
1.17
Section Two: Field Identifiers SecuRate Air Linear Entries Technical Guide
10/11/2001
Section Two: Field Identifiers
Following is a list consisting of all field identifiers for use in Discounted Published, Flat Rate, and Net/Net fares, and their definitions. Field Identifier Example: Definition Create Flat Rate Change Delete Discounted Published Create Change Delete Create Net/Net Change Delete
CXR
/CXR-DL/
AMT
/AMT247.50/
Airline Carrier Code If used, this field must consist of 2 characters Applicable to Discounted Published, Flat Rate and Net/Net Fares Amount Use this field in a Flat Rate fare to indicate a one way base fare. Use this field in a Discounted Published entry to replace the published base fare. Use this field in a Net/Net fare to designate the plus up amount. Maximum of 8 characters including the decimal point (depending on the currency used). Applicable to Discounted Published, Flat Rate and Net/Net Fares
N/A
N/A
N/A
N/A
O1
N/A2
The Discounted Published Fare Item may only have an amount or discount percent. If the fare item has a discount percent and a change entry is made to add an amount, the amount is added and the percent field is automatically deleted by the system. 2 The Discounted Published rule must have either an amount or a discount percent. The amount field is automatically deleted when a discount percent is added.
2.1
Section Two: Field Identifiers SecuRate Air Linear Entries Technical Guide Field Identifier Example: Definition Create
O3
10/11/2001
Flat Rate Change Delete
Discounted Published Create

O3
Net/Net Delete Create Change Delete
Change
BAG
/BAG-1PC/
BKG
/BKG-Y*YN/
Baggage Example: 40K (40 Kilos) 1PC (1 piece) NO (No baggage allowed) 20L (20 Pounds) Maximum of 3 characters Applicable to Net/Net, Flat Rate and Discount Published Fares Booking Class A maximum of 10 classes of service may be entered (Maximum of 2 will display in fare display and all will display in 4F.R entry). Each class of service entered has a maximum of 2 characters, if 2 classes of service are added they are separated by a asterisk (*) Applicable to Discounted Published, Flat Rate and Net/Net Fares
N/A
N/A
N/A
The baggage field is applicable to Flat Rate And Discounted Published Fare Items using linear entries only. Once a baggage field is applied to a Flat Rate or Discounted Published fare that Fare Item is no longer compatible with the template product, and can only be changed or deleted using linear entries. If the user attempts to use the template product to change or delete the Fare Item, he will receive an error response.
2.2
C.A.R Code Commercial Agreement Reference Maximum of 15 alphanumeric characters Applicable to the Net/Net Fare Combine Published Use this field to designate whether the fare item is combinable with published fares. If this field is not entered in the creation entry, SecuRate AIR will default to yes (/CMP-Y/). Enter /CMP-N/ to designate that the fare is not combinable with other published fares. Applicable to Discounted Published and Flat Rate Fares N/A
10/11/2001
Flat Rate Change

N/A
Discounted Published Delete Create

N/A
Change
CAR
/CARDISCOUNT/
N/A
N/A
N/A
CMP
/CMP-Y
CH
CH
N/A N/A N/A
2.3
Section Two: Field Identifiers SecuRate Air Linear Entries Technical Guide Field Identifier Example: Definition Create Flat Rate Change Delete Discounted Published Create Change Delete Create
10/11/2001
Net/Net Change Delete
CMU
/CMU-Y/
COM CON
/COM-10/
/CON-Y/
Combine Unpublished Use this field to designate whether the fare item is combinable with other unpublished fares. If this field is not entered in the creation entry, SecuRate AIR will default to yes (/CMU-Y). Enter /CMU-N/ to designate that the fare is not combinable with other unpublished fares. Applicable to Flat Rate Fares Commission Enter the commission percent. Applicable to Net/Net Connection - Y or N Use this field to designate whether the negotiated fare requires a connecting flight. If this field is not entered during creation, SecuRate AIR will default to no (/CON-N/). Enter /CON-Y/ to designate that the fare does require a connection to qualify. Applicable to Discounted Published Fares (Net/Net and Flat Rate will be address in a future product for the general rule)
CH
N/A
N/A
N/A
N/A N/A N/A
N/A
N/A
N/A
N/A
N/A
N/A
O4
CH
N/A
N/A
N/A
N/A N/A N/A
Currently This Field is deleted by using the existing expert entry to change the commission amount to 0%. The current entry is: 4F-F/C/xxxx/CCOM-yy.yy
2.4
10/11/2001
CUR
/CUR-USD/
DIR
/DIR-B/
Currency The currency will default to USD if no Currency code is entered in the creation entry on Flat Rate or Discounted Published fares This is a mandatory field in the creation of a Net/Net fare. Currency is only a valid field on a Discounted Published fare when a flat amount has been entered. The currency code of the published fare is used when a percentage discount is taken. If used, this field must contain 3 characters. Applicable to Discounted Published, Flat Rate, and Net/Net Fares. Direction of Travel For travel valid from Enter point of origin only O destination only D both origin and destination B Applicable to Discounted Published, Flat Rate, and Net/Net Fares.
N/A
N/A
N/A
N/A
2.5
/DST-MCI*C/ Destination The City, Airport, or Zone Code for the destination of the fare item. If this field is not entered when creating a fare SecuRate AIR assumes that the fare is valid to any destination. If used, this field may consist of 2 or 3 characters Applicable to Discounted Published, Flat Rate and Net/Net Fares Follow by - Location Code of Destination If a Destination is entered, the Location Code of the Destination is mandatory. If this field is not entered, along with the destination code, when creating a fare SecuRate AIR assumes that the fare item is valid to any destination. Any one of the following location codes may be used: A - Airport C - City U - Country S - State B - Subcontinent K - Continent T - region Z - Zone If used, this field must consist of one character. O
10/11/2001
Flat Rate Change

O
Discounted Published Delete Create Change Delete Create
DST
2.6
N/A
10/11/2001
Flat Rate Change

N/A

O5
Change
O5
PCT
/PCT-50/
Percent Percentage to be subtracted from the published amount on a Discounted Published Fare. Either discount percent or amount is required for all Discounted Published Fares, but both may not be entered in the same fare item. When used with a Net/Net Fare, SecuRate AIR will add this amount to the net fare to obtain the sell fare. Decimal points apply consistent with the currency code of the fare item. If both a plus up percent and amount are entered on a Net/Net fare, SecuRate AIR will add the plus up percent first then the plus amount to obtain the sell fare. Applicable to Discounted Published and Net/Net Fares
N/A
O6
The Discounted Published Fare Item may only have an amount or discount percent. If the fare item has an amount and a change entry is made to add a discount percent, the percent is added and the amount field is automatically deleted by the system.
6
Currently this Field is deleted by using the existing expert entry to change the amount to 0. The entry is: 4F-F/C/xxxx/CAMT-yyy.yy
2.7
N/A
10/11/2001
Flat Rate Change

N/A

O
Change
MST
/MST-Y/
NET
/NET-100.00/
Must Stop This field designates whether flights must stop to qualify for the fare. If this field is not entered on a creation entry, SecuRate AIR will default to no (/MST-N/). Enter /MST-Y/ to designate that the fare does require a stop to qualify. Applicable to Discounted Published (Net/Net and Flat Rate will be address in a future product for the general rule) Net Fare If used, this field contains a maximum of 9 numerics. This is a mandatory field for the creation of Net/Net fares Applicable to Net/Net Fares
N/A
CH
N/A N/A N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
2.8
N/A
10/11/2001
Flat Rate Change

N/A

O
Change
NON
/NON-N/
Nonstop This field designates whether flights must be nonstop to qualify for the fare. If this field is not entered in the creation entry, SecuRate AIR will default to no (/NON-N/). Enter /NON-Y/ to designate that the fare does require a nonstop to qualify. Applicable to Discounted Published Fares (Net/Net and Flat Rate will be address in a future product for the general rule)
N/A
CH
N/A N/A N/A
2.9
Origin The City, Airport, or Zone Code for the origin of the fare item. If this field is not entered when creating a fare SecuRate AIR assumes that the fare is valid to any origin. If used, this field may consist of 2 or 3 characters Applicable to Discounted Published, Flat Rate and Net/Net Fares Followed by - Origin Type If an origin is entered, the Location Code of the origin is mandatory. If this field is not entered, along with the origin code, when creating a fare SecuRate AIR assumes that the fare item is valid to any origin. Any one of the following location codes may be used: A - Airport C - City U - Country S - State B - Subcontinent K - Continent T - region Z - Zone If used, this field must consist of one character.
10/11/2001
Flat Rate Change Delete
Discounted Published Create Change Delete Create
ORG
/ORGATL*C/
2.10
Published Fare Basis Mandatory for creation of Discounted Published fares. To apply a discount to all fare basis codes within a booking class enter a single asterisk (e.g. /PFB-*/) on a Discounted Published Fare. To exclude a published fare basis code from a Discount Published Fare item, follow that code with *E (e.g. PFB-YUP*E). If used, this field contains a maximum of 8 characters (excluding *E if used). Applicable to Net/Net and Discounted Published Fares N/A
10/11/2001
Flat Rate Change

N/A

M
Change
PFB
/PFBKR21NR/
N/A
N/A
2.11
O
10/11/2001
Flat Rate Change

O
Discounted Published Delete Create Change Delete Create
RTG
/RTG-104/
SCA
/SCA-Y/
Routing Number If a routing number is entered, this is the only routing number used by the system. SecuRate AIR defaults to any valid published routing if this field is not entered. If used, this field contains a maximum of 4 numerics. Applicable to Discounted Published, Flat Rate and Net/Net Fares Scaled Amount/Mileage Add this field if this is a scaled discount. If this field is not added, SecuRate AIR will default to no (/SCA-N/). Enter /SCA-Y/ to apply the scaled discount to the fare item. Complete the Scaled Amount template to apply to Discounted Published Fares. Complete the Scaled Mileage template to apply to Flat Rate Fares. Applicable to Flat Rate And Discounted Published Fares.
O7
N/A
O8
ON/A N/A N/A N/A
Flat Rate Fare Items may not have an amount listed and a scaled amount used at the same time. If the fare item has an amount and a change entry is made to apply a scaled mileage template, the amount field is automatically deleted by the system. 8 Discounted Published Fare Items may not have an amount or percent and a scaled amount used at the same time. If the Fare Item has an amount or percent used and a change entry is made to apply a scaled amount template item, the amount or percent field is automatically deleted by the system.
2.12
10/11/2001
Net/Net Change O9 Delete
SEL
/SEL-200.00/
TDC
TFB
Sell Fare Enter a sell amount only if no plus up percent or amount exist. SecuRate AIR will not accept a plus up percent/amount and a sell fare for the same fare item. Maximum of 9 numerics. Applicable to Net/Net Fares /TDC-SHOW/ Ticket Designator Use this field only if the Agreement Control template shows N specifying that the agreement number is not the ticket designator. If used, this field contains a maximum of 13 characters. Applicable to Discounted Published, Flat Rate and Net/Net Fares /TFB-KDISC/ Ticketed Fare Basis Code A ticketed fare basis code is mandatory to create a fare. Maximum of 8 characters. Applicable to Discounted Published, Flat Rate and Net/Net Fares
N/A N/A N/A N/A N/A N/A
N/A
N/A
N/A
N/A
If the user attempts to change a SEL field when the sell fare has been calculated by adding a plus up amount and/or percent to the Net fare they will receive an error response.
2.13
10/11/2001
TVL
/TVL-002/
UPG
/UPG-Y/
VAL
/VALCOMPANY/
Travel/Ticket Item Number Enter the applicable item number from the Travel and Ticketing Dates (4F-D) template. Maximum of 3 numerics Applicable to Discounted Published, Flat Rate and Net/Net Fares Upgrade Enter this field if a passenger can pay to upgrade to the next cabin. Use the UPG field in conjunction with a discount rule indicating the upgrade. Applicable to Flat Rate Fares Value Code Maximum of 15 alphanumeric characters Applicable to Net/Net Fares
CH
N/A
N/A
N/A
N/A N/A N/A
N/A
N/A
N/A
N/A
N/A
N/A
Key:
M = Mandatory O = Optional CH = Field may not be Deleted Must be Changed N/A = Not Applicable
2.14
Section Three: Descriptors SecuRate Air Linear Entries Technical Guide
10/11/2001
Section Three: Descriptors
Groups of SecuRate Air Fare Item level rules are defined by the system as Descriptors. The following linear entries provide functionality to create/add/change/delete descriptors. Once the descriptors are created they the user will be able to append the descriptor number to the fare item being created with the SecuRate AIR linear entry. Unlike the template product, unlimited rules may be associated to one descriptor number.
3.1
10/11/2001
Descriptor Create Entry Layout

Field Description
4F-R/CREATE/DESC/AAAA/AAAA/AAAA
Field 4F-R / CREATE / DESC / AAAA
Description Function Identifier Field Separator Indicates Create Field Separator Indicates Descriptor Field Separator Rule Number
Max 4 1 6 1 4 1 4
Descriptor Delete Entry Layout

Field Description
4F-R/DELETE/DESC/0001
Field 4F-R / DELETE / DESC / AAAA
Description Function Identifier Field Separator Indicates Delete Field Separator Indicates Descriptor Field Separator Rule Number
Max 4 1 6 1 4 1 4
Descriptor Rule Modification Entry Layout

Field Descriptions
4F-R/DESC/AAAA/B-CCCC/B-CCCC/B-CCCC
Field 4F-R / DESC / AAAA / B CCCC
Description Function Identifier Field Separator Indicates Descriptor Entry Field Separator Descriptor Number Field Separator A Indicates Add / D Indicates Delete10 Field Separator Rule Number
Max 4 1 4 1 4 1 1 1 4
10
SecuRate Air will accept multiple adds and deletes in the same entry.
3.2
10/11/2001
Descriptor Display Entry Layout

Field Descriptions
4F-G*D
Field 4F-G * D
Description Function Identifier Field Separator Indicates Descriptor
Max 4 1 1
Applying a Descriptor
The descriptor is then associated to a fare item using the field identifier DESC- and the number of the desired descriptor in any of the create entries described in section one. Following is an example of a Discounted Published fare item create entry with a descriptor attached. Entry: >4F-F/DP/CXR-XX/DIR-B/TFB-TEST/PFB-YPUB/PCT-40/BKG-Y/DESC0005 Response: >4F-F/DP/CXR-XX/DIR-B/TFB-TEST/PFB-YPUB/PCT-40/BKG-Y/ DESC-0005 OK FARE ITEM CREATED
The DESC- field identifier is also valid in the change entry as in the following example: Entry: 4F-F/C/0003/DESC-0008 Response: >4F-F/C/0003/DESC-0008( OK FARE ITEM CHANGED
3.3
Section Four: Agreement Level Rules SecuRate Air Linear Entries Technical Guide
10/11/2001
Section Four: Agreement Level Rules (Under Development)
Linear Entries for Agreement Level Rules are currently in development and will be documented here as they are released on line.
4.1
Section Five: Fare Item Level Rules SecuRate Air Linear Entries Technical Guide
10/11/2001
Section Five: Fare Item Level Rules (Under Development)
Linear Entries for Fare Item Level Rules are currently in development and will be documented here as they are released on line.
5.1
Section Six: Error Conditions Specific to Linear Entries SecuRate Air Linear Entries Technical Guide
10/11/2001
Section Six: Error Conditions Specific to Linear Entries

CONDITION ERROR RESPONSE
CAN NOT DELETE XXX
If the user tries to delete a field that is not eligible for deletion. XXX = field identifier The user requested a descriptor that hasn't been built yet. The user tries to attach a descriptor to a fare and the descriptor has already been deleted. User attempted to change SCA field to N. Enter an amount in the AMT field for a Flat Rate Fare or the AMT or Pct Field for a Discounted Published Field Displayed if the user doesn't enter valid numeric data in the create entry after DESC-, or the user enters zero. Linear entry begins with 4F-F/ and one character other than C or D Linear entry begins with 4F-F/ and two or more characters other than DP, FR or NN An entry is made and the user is not in update mode User attempted to include SEL Field with Plus Up AMT or PCT field on a Net/Net fare, either by putting all of them in the original entry or by trying to change the SEL field where the sell price was established by a Plus Up amount or percent. Anytime a create or change entry is made using a field that is valid only once more than once. Any time a create, change or delete entry is made specifying a field that is not compatible with the fare type. XXX = field identifier Linear entry begins with 4F-F/ and one character other than C or D
DESCRIPTOR DOES NOT EXIST DESCRIPTOR HAS BEEN DELETED
INVALID AMOUNT / CURRENCY
INVALID DESCRIPTOR NUMBER
INVALID OPTION INVALID FARE TYPE SELECTED
NO AGREEMENT IN FOREGROUND PLUS UP NOT VALID WITH SELL
XXX FIELD CANNOT BE ENTERED TWICE
XXX FIELD INVALID WITH FARE TYPE SELECTED
INVLD TRANS - CK FORMAT
6.1
Section Seven: Input/Output SecuRate Air Linear Entries Technical Guide
10/11/2001
Section Seven: Input/Output
When a SecuRate Air Linear Entry is entered successfully, the first line of the response is always a reiteration of the entry preceded by a start of message indicator (e.g. > ) and followed by a tab (e.g. ( ). This allows the manual user to reuse the original entry to make an additional, similar entry. The line after the redisplay of the input is blank and the following line of the response to a successful entry begins with OK and is followed by a descriptive statement defining the action taken by the system. Example Input:
1234567890123456789012345678901234567890123456789012345678901234 1 4F-F/DP/CXR-DL/DIR-B/TFB-TEST/PFB-BPUB/PCT-40/BKG-Y 2 3 4 5 6 7 8 9 10 11 12 13
Example Output:
1234567890123456789012345678901234567890123456789012345678901234 1 >4F-F/DP/CXR-DL/DIR-B/TFB-TEST/PFB-BPUB/PCT-40/BKG-Y( 2 3 OK FARE ITEM CREATED 4 5 6 Original Input 7 Blank Line 8 OK Descriptive Message 9 10 11 12 13
7.1
Section Seven: Input/Output SecuRate Air Linear Entries Technical Guide
10/11/2001
The descriptive message will vary depending on the task the system has completed. Below is a list of messages and the circumstances under which the system will display them.
Descriptive Message
FARE ITEM CREATED
Displayed When:
Used when a Flat Rate, Discounted Published, or Net/Net Fare Item is created using a linear entry. Used when a Flat Rate, Discounted Published or Net/Net Fare Item is deleted using a linear entry Used when field(s) have been deleted from a Fare Item(s). Used when field(s) have been changed within a Fare Item(s)
FARE ITEM(s) DELETED
FIELD(S) DELETED FARE ITEM(S) CHANGED
7.2

WorldSpan - 9I05 SecuRate Air Linear Entries Technical Guide

Hochgeladen von

Dokumentinformationen

Copyright

Verfügbare Formate

Dieses Dokument teilen

Dokument teilen oder einbetten

Freigabeoptionen

Stufen Sie dieses Dokument als nützlich ein?

Sind diese Inhalte unangemessen?

Copyright:

Verfügbare Formate

WorldSpan - 9I05 SecuRate Air Linear Entries Technical Guide

Hochgeladen von

Copyright:

Verfügbare Formate

SecuRate Air Linear Entries Technical Guide

I:\Terri K\16388 tech guide.doc

I:\Terri K\16388 tech guide.doc

I:\Terri K\16388 tech guide.doc

Section Two: Field Identifiers

Section Three: Descriptors Section Four: Agreement Level Rules

I:\Terri K\16388 tech guide.doc

Section Five: Fare Item Level Rules

Section Six: Error Conditions

Section Seven: Input/Output

I:\Terri K\16388 tech guide.doc

Section One Fare Item Entries

I:\Terri K\16388 tech guide.doc

Flat Rate Fare Item Create Entry Layout

I:\Terri K\16388 tech guide.doc

I:\Terri K\16388 tech guide.doc

I:\Terri K\16388 tech guide.doc

Discounted Published Fare Item Create Entry Layout

I:\Terri K\16388 tech guide.doc

I:\Terri K\16388 tech guide.doc

I:\Terri K\16388 tech guide.doc

Field 4F-F / NN / CXRAA / DIRB / TFBCCCCCCCC / NETDDDDDDDDD / CUREEE / BKGFF*FF / DESCGGGG

I:\Terri K\16388 tech guide.doc

I:\Terri K\16388 tech guide.doc

The following fare item is created. Entry: >4F-U*F/SIDAGR

INVALID FARE TYPE

I:\Terri K\16388 tech guide.doc

Change Entry for 4F-F/C/AAAA/BBBSingle Fare Item Layout

Change Entry for a Range of Fare Items - Layout

Field 4F-F / C / AAAA BBBB / CCC-

I:\Terri K\16388 tech guide.doc

Change Entry for a Multiple Fare Items - Layout

Field 4F-F / C / AAAA / BBB-

I:\Terri K\16388 tech guide.doc

Delete Entry for a 4F-F/D/AAAA Single Fare Item Layout

Delete Entry for a Range of Fare Items Layout

Field 4F-F / D / AAAA BBBB

Delete Entry for Multiple Fare Items Layout

Field 4F-F / D / AAAA

I:\Terri K\16388 tech guide.doc

Delete Entry for All Fare Items Layout

Field 4F-F / D / ALL

I:\Terri K\16388 tech guide.doc

Delete Entry for Field(s) within a Single Fare Item Layout

Field 4F-F / D / AAAA / BBB-

Delete Entry for field(s) within a Range of Fare Items Layout

Field 4F-F / D / AAAA BBBB / CCC-

I:\Terri K\16388 tech guide.doc

Delete Entry for field(s) within Multiple Fare Items Layout

Field 4F-F / D / AAAA / BBB-

Delete Entry for Field(s) within Multiple Fare Items Layout

Field 4F-F / D / ALL / AAA

I:\Terri K\16388 tech guide.doc

I:\Terri K\16388 tech guide.doc

Section Two: Field Identifiers

I:\Terri K\16388 tech guide.doc

Flat Rate Change Delete

Discounted Published Create

Net/Net Delete Create Change Delete

I:\Terri K\16388 tech guide.doc

Flat Rate Change

Discounted Published Delete Create

Net/Net Delete Create Change Delete

N/A N/A N/A