1 - eService Staging Server€¦ · Web view · 2005-10-25Purpose This is the country of residence or destination. Acceptable Format(s) The user must enter a valid 2 or 3 character

APIS for Subscribers

Prepared by Teresa Newell (Sabre) September 23, 2005

Version 1.3


© 2023, Sabre Inc. All rights reserved.

This documentation is the confidential and proprietary intellectual property of Sabre Inc. Any unauthorized use, reproduction, preparation of derivative works, performance, or display of this document, or software represented by this document, without the express written permission of Sabre Inc. is strictly prohibited.

Sabresg0157637 and the Sabre logo design are trademarks and/or service marks of an affiliate of Sabre Inc. All other trademarks, service marks, and trade names are owned by their respective companies.

September 23, 2005Sabre Inc.

2


D O C U M E N T R E V I S I O N I N F O R M A T I O N

The following information is to be included with all versions of the document.

Project Name APIS for Subscribers Project Number JD271

Prepared by Ellen Moore / Teresa Newell Date Prepared September 15, 2005

Revised by Teresa Newell Date Revised Sept. 23, 2005

Revision Reason1) State/Province mandatory for

DOCA type ‘D’2) ‘A’ for all valid for segment select

for DOCS, DOCA, and DOCO

Edition No. 1.3

Revised by Date Revised

Revision Reason Edition No.


3


1 A P I S f o r S u b s c r i b e r s ...........................................................................................6

Overview.............................................................................................................................................6

GDS Role............................................................................................................................................7

Assumptions and Constraints.............................................................................................................7

Quick Reference – Format Examples.................................................................................................9

2 D O C x P N R S S R I t e m s ........................................................................................1 0

2.1 SSR DOCS entry and validation........................................................................................10

2.1.1 Overview........................................................................................................................10

2.1.2 Assumptions and Constraints........................................................................................10

2.1.3 DOCS Inputs.................................................................................................................11

2.1.4 DOCS Element Breakdown:..........................................................................................11

2.1.5 DOCS Entry Examples..................................................................................................20

2.1.6 DOCS Notes..................................................................................................................20

2.1.7 DOCS Output Summary................................................................................................21

2.2 SSR DOCO entry and validation........................................................................................24

2.2.1 Overview........................................................................................................................24


2.2.3 DOCO Inputs.................................................................................................................25

2.2.4 DOCO Element Breakdown:..........................................................................................25

2.2.5 DOCO Entry Examples..................................................................................................32

2.2.6 DOCO Notes..................................................................................................................33

2.2.7 DOCO Output Summary................................................................................................33

2.3 SSR DOCA entry and validation........................................................................................35

2.3.1 Overview........................................................................................................................35


2.3.3 DOCA Inputs.................................................................................................................35

2.3.4 DOCA Element Breakdown:..........................................................................................36

2.3.5 DOCA Entry Examples..................................................................................................43

2.3.6 DOCA Notes..................................................................................................................44

2.3.7 DOCA Output Summary................................................................................................45

3 T e l e t y p e U p d a t e s ...............................................................................................4 7

3.1 Teletype Table Overview....................................................................................................47

3.2 Display Airline Agreement Table, specifically for new APIS SSR Option...........................47

3.3 Airline Agreement Table Update for the new DOCx APIS SSR types...............................47


4


4 G l o s s a r y ..................................................................................................................4 9

The intent of this document is to provide the Sabre host Global Distribution Systems (GDS) with information pertaining to the format of the new APIS SSRs data items. Sabre Travel Network, Infini, and Abacus are already familiar with the current APIS SSR, PSPT. This document introduces the new SSR codes for APIS, and describes the guidelines in place for the use of these new SSR items by the GDS’s. It is not intended to identify which items (if any) the GDS’s are expected or required to input, as this would be an issue between the individual carriers and the GDS’s.

The 3 new SSRs described in this document are designed to meet the requirements for all participating countries and follow current IATA standards.

O v e r v i e w

Advanced Passenger Information (APIS) has been required from air carriers by various nations for some time. The existing APIS data is transmitted to participating countries by the air carrier using the PSPT SSR item data. IATA introduced 3 new SSR items to eventually replace the PSPT SSR.

It is the responsibility of the airline to provide APIS information to participating countries. GDS subscribers may capture this information during the reservation process at the discretion of the air carrier.

The United States government has published its new Advanced Passenger Information data requirements. The new requirements are effective October 4, 2005 for the travelers arriving in, or transiting through, the United States. Airlines may request different activation dates for the new data elements.

The Sabre system will support these new SSR items beginning in October. The specific implementation date may change, so please refer to Sabre Advance Notification for the latest implementation schedule.

Until a GDS is notified by one of their participating airlines that the new SSR items can be accepted, the current PSPT SSR item should continue to be used.


1 APIS for Subscribers

5


The Passport SSR (PSPT) will be supported by the Sabre system until it is discontinued by IATA. As today, Sabre will maintain a table defining the APIS SSR type supported by the GDS participating airlines.

There are 3 new SSRs approved by IATA in support of the new data that must be sent.

DOCS - Passport and secondary document data not including Visa.DOCA - Passenger’s Resident address and/or Destination address.DOCO - Passenger’s Visa, Place of Visa Issue and Passenger’s Place of Birth.

G D S R o l e

Subscribers will be allowed to enter DOCS, DOCA, and DOCO SSR items (GFAX) for all carriers as governed by the Airline Agreement table for each individual carrier.

Today, for PSPT acceptance, each GDS is responsible for updating the Airline Agreement table when a participating airline advises they will accept PSPT data from a GDS subscriber. With the new APIS SSR items, the process remains the same. There is a new code in the Airline Agreement table that refers specifically to the new SSR types.

For Sabre Travel Network Subscribers Only: Although AA allows Sabre Subscriber to enter Host Facts SSRs in general, only DOCA will be allowed for host fact for AA. 4DOCA and 4DOCO will be restricted.

A s s u m p t i o n s a n d C o n s t r a i n t s

1.3.1 The maximum length of a DOCx item follows the current system constraints. If length is more than allowed, the following message is returned: #ITEM TOO LONG#

1.3.2 As today, the new SSR entries may be strung together with other PNR entries, using an end item.

1.3.3 As today, collected data is passed to the airport check in system, at time of flight initialization. Continued exchange of reservation and check in data will take place, as it does today.

1.3.4 The slash ‘/’ is used as a delimiter for inputting the different passenger data elements. If an element is optional, the slash is required as a place holder if followed by other data elements.


6


1.3.5 Multiple names in a PNR require name association in the entry.

1.3.6 Single name PNR may assume the single passenger name number.

1.3.7 Current Name Association rules apply for PNR DOCx items.

1.3.8 The DOCx SSR entries will not be permitted for PNRs with an IK (infant) segment status.


7


Q u i c k R e f e r e n c e – F o r m a t E x a m p l e s

DOCSFormat:3DOCS(seg nbr)/(doc type)/(issue country)/(doc nbr)/(nationality country)/(date of birth)/(gender)/(doc expire date)/(last name)/(first name) /(middle initial)/(H)-(name association)

Example: 3DOCS1/P/US/506435409090345/USA/06FEB1952/F/31FEB2008/PEREZ/MARIA/N-1.1

DOCAFormat:3DOCA(Seg nbr)/(adrs type)/country/street/city/state/zip/(infant indicator)-(name association)

Examples:3DOCA2/D/US/987 MAIN/EULESS/TX/76040(destination address type)

3DOCA2/R/GB(residence address type)

DOCOFormat:3DOCO(seg nbr)/(place of birth)/(doc type)/(doc nbr)/(issue country)/(issue date)/(applicable country)/(infant indicator)-(name association)

Examples:3DOCO1//V/789789/HOUSTON/14JUN04/USA(document type included, but place of birth not)

3DOCO/MUNICH//789789/HOUSTON/14JUN04/USA(place of birth included, but document type not)


2 DOCx PNR SSR Items

8


2 . 1 S S R D O C S e n t r y a n d v a l i d a t i o n

2 . 1 . 1 O v e r v i e w

DOCS is the new SSR code for entry of the passport, or other various document types and their associated data elements.

2 . 1 . 2 A s s u m p t i o n s a n d C o n s t r a i n t s

2.1.2.1 Sabre allows for the storage of multiple travel documents as long as the document types are different. E.G. 1st document type is P for passport, 2nd document type is A for Alien Resident Card.

2.1.2.2 Sabre Travel Network subscribers share host facts with American Airlines. At this time American Airlines has restricted host facts entry of DOCS (and DOCO) to agents with airport EPR keywords.


9


2 . 1 . 3 D O C S I n p u t s

2.1.3.1 DOCS SSR

3DOCSn/dt/ic/dn/ncc/ddmmmyy/dg/ddmmmyy/last/first/middle/H-x.xWhere:

Component Description Mandatory Optional

Notes

3 Primary action code MDOCS Secondary action code Mn Segment select O Number 1-99, or ‘A’ for all

*multiple allowed for GFAX and HFAX

dt Document type Mic Document country of issue M O for doc Fdn Document number M O for doc Fncc Doc nationality country Mddmmmyy -or- ddmmmyyyy

Date of birth M

dg Gender / infant gender M M, F, U, MI, FIddmmmyy-or-ddmmmyyyy

Doc expiration date M O for doc types F, A, N, and V

last Last name MFirst First name MMiddle Middle name or initial OH Multi passenger passport indicator O *only allowed if Document

Type = ‘P’-x.x PNR name number M O for single party PNR

M for multi party PNR

2 . 1 . 4 D O C S E l e m e n t B r e a k d o w n :


10


2.1.4.2 Segment Number Requested

EXAMPLES, ERRORS or REFERENCE

Name Segment NumberMax Field Length 2

Character Set Numeric Characters 1-99Purpose Associate SSR to Flight Segment Acceptable Format(s) N/A

Special Instructions

Multiple segment numbers allowed for GFAX

Required NOEdits

If no segment number is included and not at least 1 active host segment in the itinerary

If segment number is for a flight that is past date or carrier that does not accept DOCx

If segment number input is not a number 1-99

#CHECK ITINERARY#

Same as above error

#SEGMENT NUMBER NOT VALID#

2.1.4.3 Document Type Field


Name Document TypeMax Field Length 1

Character Set Alpha Characters A, C, P, T, F, M, N, and V only.A = Alien resident cardC = Permanent resident cardP = PassportT = Refugee travel document and re-entry permit, U.S. Travel documentF = Facilitation documentM = MilitaryN = Naturalization Certificate V = Border Crossing Card

Purpose This is the travel document type field. Acceptable Format(s) N/A

Special InstructionsRequired YesEdits User enters any other character

except A, C, P, T, F, M, N, or V

Document type field left blank

#INVALID DOCUMENT TYPE – USE A, C, P, T, F, M, N, OR V#

#DOCUMENT TYPE REQUIRED#


11


2.1.4.4 Document Issue Country Field


Name Document Issue CountryMax Field Length 3

Character Set Alpha Characters only.Purpose This is the travel document issue country

field. Acceptable Format(s)

The user must enter a valid 2 or 3 character country code.

Example:MEXICO = MXUNITED KINGDOM = GBUnited Kingdom 3-char = GRB


To be validated against the Sabre internal country code table

Required Yes, except for type F Edits Numeric or special characters

present

Country code entered is not a match in the Sabre internal country code table

If issue country field is blank (except for type F)

#INVALID COUNTRY or COUNTRY CODE – SEE HCCC/#

Same as above error

# ISSUE COUNTRY REQUIRED#

2.1.4.5 Document Number Field


Name Document NumberMax Field Length 15

Character Set Alpha/Numeric only.Purpose This is the travel document number field. Acceptable Format(s)

N/A

Special InstructionsRequired Yes - If travel document type = A, C,

P, T, M, N, V No – If travel document type = F

Edits Special characters present

Document types A, C, P, T, M, N, V present and no travel document number present

Document Number is longer than 15 characters

#INVALID TVL DOCUMENT NUMBER – NO SPCL CHARS ALLOWED#

#TRAVEL DOC NUMBER REQUIRED#

#VERIFY TVL DOCUMENT NUMBER – ENTER FIRST 15 CHARS#


12


2.1.4.6 Document Nationality Country Field


Name Document Nationality CountryMax Field Length 3

Character Set Alpha Characters only.Purpose This is the travel document nationality

country field. Acceptable Format(s)


Example:MEXICO = MXUNITED KINGDOM = GBUnited Kingdom 3-char = GRB



Required Yes Edits Numeric or special characters

present


If nationality country field is blank

#INVALID COUNTRY CODE – SEE HCCC/#

Same as above error

#NATIONALITY COUNTRY CODE REQUIRED#

2.1.4.7 Date of Birth Field


Name Date of BirthMax Field Length 9

Character Set Alpha/Numeric Characters only.Purpose This is the passenger date of birthAcceptable Format(s)

ddmmmyy –or- ddmmmyyyy Examples:09APR5709APR1957


none

Required Yes Edits User enters invalid date data or

invalid acceptable format

Birth date left blank

#INVALID BIRTH DATE – USE DDMMMYY OR DDMMMYYYY#

#BIRTHDATE REQUIRED#


13


2.1.4.8 Gender Field


Name GenderMax Field Length 2

Character Set Alpha Characters M, F, U, MI, FI onlyM = MaleF = FemaleU = Unknown at time of bookingMI = Male traveling with Lap infantFI = Female traveling with Lap infant

Purpose This is the travel document gender field. Acceptable Format(s)Special InstructionsRequired Yes Edits Numeric, special characters or a

character other than M, F, MI, FI, or U is present

Gender field blank

#INVALID GENDER – USE M, F, MI, FI, OR U ONLY#

#GENDER REQUIRED#

2.1.4.9 Document Expiration Date Field


Name Document expiration dateMax Field Length 9

Character Set Alpha/Numeric Characters only.Purpose This is the travel document expiration

date field. Acceptable Format(s)



The year must be equal to, or greater than the current year. 9999 is a valid year for the expiration date. The day and month must be reasonable.

Required Yes – except for document types F, A, N, & V

Edits User enters invalid date data or invalid acceptable format

Document expiration date field blank and doc type P, C, T, or M

#INVALID EXPIRATION DATE – USE DDMMMYY OR DDMMMYYYY#

#EXPIRATION DATE REQUIRED#


14


2.1.4.10 Last Name Field


Name Last NameMax Field Length

30

Character Set Alpha Characters and space only.Purpose This is the travel document last name


Names are not necessarily restricted to a single name. Multiple names will be accepted.

Example:GARCIAGARCIA MENDEZ


For hyphenated names spaces must be substituted for special characters, e.g. “/” or “-“.

Required Yes Edits Any character other than an alpha or

a space.

Last name field is blank

If more than 30 Chars are input.

#INVALID LAST NAME – NO SPCL CHARS ALLOWED#

#LAST NAME REQUIRED#

#VERIFY LAST NAME – INPUT FIRST 30 CHARS#

2.1.4.11 First Name Field


Name First NameMax Field Length

30

Character Set Alpha Characters and space only.Purpose This is the travel document first name


Alpha characters and spaces. A space can be included in the first name

Example:MARYMARY ELIZABETH


Spaces must be substituted for special characters, e.g. “/” or “-“.

Required Yes Edits Any character other than an alpha or

a space.

First name fields is blank

If more than 30 Characters are input

#INVALID FIRST NAME – NO SPCL CHARS ALLOWED#

#FIRST NAME REQUIRED#

#VERFIFY FIRST NAME – INPUT FIRST 30 CHARS#


15


2.1.4.12 Middle Name Field


Name Middle or Second given nameMax Field Length

30

Character Set Alpha characters and spaces. A space can be included in the middle name

Purpose This is the travel document middle initial or name field.

Acceptable Format(s)

N/A


Required No Edits Any character other than an

alpha or space is present.

If more than 30 Characters are input

#INVALID MIDDLE NAME – NO SPCL CHARS ALLOWED#

#VERIFY MIDDLE NAME – INPUT FIRST 30 CHARS#

2.1.4.13 Multi passenger passport and this SSR is for the primary passport holder, include the letter ’H’ (conditional)


Name Primary holder of multi name passportMax Field Length

1

Character Set Alpha character H onlyPurpose Indicated primary holder of multi-name

passportAcceptable Format(s)

N/A


only allowed if Document Type = ‘P’

Required No


16


Edits Any character other than H

H indicator is present and Document Type is not ‘P’

Note: This is a positional field. If the correct number of slashes is not present, this could be interpreted as part of the name.

#USE H FOR MULTI NAME PSPT#

#MULTI PSGR INDICATOR /H ONLY ALLOWED FOR DOCUMENT TYPE P#


17


2.1.4.15 Name Association Field Separator


Name Field SeparatorMax Field Length 1

Character Set Special Character “-” only.Purpose This is the field separator to indicate

which name field to attach the data.Acceptable Format(s) N/A

Special Instructions N/A

Required Yes – When followed by a name number.

No – if single name PNR.Edits Any character other than “-” #FORMAT#

2.1.4.16 Name Association Number


Name Name Association NumberMax Field Length 5

Character Set Numeric followed a ”.” and another Numeric

1.1 10.2 11.9 10.12

Purpose The Name Association Number of the passenger that the SSR data is being input for.

Acceptable Format(s) N/A


Name Association not allowed for B/, C/, I/, or Z/

Required Yes – For multi name PNR No – For single name PNR.

For single name PNR the item is automatically associated to the single name.

Edits Any character other than Numeric or “.”

If the item is associated to more than one name

If the item name association number belongs to an infant

If the item name association number belongs to a group name

If the item name association number belongs to a BSG name

#FORMAT#

#CAN ONLY ASSOCIATE TO ONE PSGR#

#CANNOT ASSOCIATE TO INFANT NAME#

#CANNOT ASSOCIATE TO GROUP NAME#

#CANNOT ASSOCIATE TO BSG NAME#


18


2 . 1 . 5 D O C S E n t r y E x a m p l e s

2.1.5.1 Segment Select Example

3DOCS1/P/US/506435409090345/USA/06FEB1952/F/31FEB2008/PEREZ/MARIA/N-1.1

2.1.5.2 Multiple Segment Select Example

3DOCS1,3/P/US/506435409090345/USA/06FEB1952/F/31FEB2008/PEREZ/MARIA/N-1.1

2.1.5.3 Multi-passenger Passport Example – with middle initial

3DOCS1/P/US/506435409090345/USA/06FEB1952/F/31DEC2008/PEREZ/MARIA/N/H-1.1

2.1.5.4 Mandatory Components Only Example 3DOCS/P/US/506435409090345/USA/06FEB1952/F/31DEC2008/PEREZ/MARIA-1

Optional components do not have to be identified with slashes, as long as there are no remaining components to include, other than name association

2 . 1 . 6 D O C S N o t e s

2.1.6.1 Multiple DOCS items are permitted for the same passenger, as long as each DOCS item is a different document type, or it is a document type F, or the additional item is for an associated infant/lap child.

2.1.6.2 Deletion of a DOCS item can be deliberately requested by using the SSR item number in the deletion request.

Example: 3(line/item number)@

37@

2.1.6.3 Change or modify of General fact to a DOCS is not applicable, and not allowed. Issue error if data following the change key (@) is a DOCS SSR.

2.1.6.4 All mandatory components must be present at input. If some mandatory components are missing, the error response will include the first missing mandatory item in the DOCS that caused the failure.

2.1.6.5 If document type is not included, or is not A, C, P, T, F, M, N, or V process error.

2.1.6.6 If the issue country is not included, and the document type is A, C, P, T, M, N, or V issue error.


19


2.1.6.7 If the document type is A, C, P, T, M, N, or V validate that there is a document number included.

2.1.6.8 DOCS can be associated only to confirmed segment status code, as today for PSPT. Those status codes include:SC, SS, PS, RR, VG, MM, BK, GK, KK, HK, PK, SK, and TK.

Infant PNRs may not have DOCS in them. Segment status codes for infant PNRs is IK.

2.1.6.9 If segment association is included, verify at least one active, future date, airline itinerary segment is present before accepting the DOCS.

2.1.6.10 Infant name will not be validated; the name association will be accepted if the MI or FI gender codes are used.

2.1.6.11 General Facts DOCS will not overlay previously entered General Facts DOCS items. The agent must manually delete any General Facts DOCS that are no longer needed.

2.1.6.12 If a general facts DOCS item is added to the PNR without specific segment association, it will be internally aligned to the specific other airline segments already present in the PNR. This is following rules in place today for general facts items.

2.1.6.13 The Sabre internal country code table will be used to validate the country code.

2 . 1 . 7 D O C S O u t p u t S u m m a r y

2.1.7.1 Successful input will cause the standard passenger data field response: *.

2.1.7.2 Error Messages:

#INVALID DOCUMENT TYPE – USE A, C, P, T, F, M, or N#If invalid document type is input

#DOCUMENT TYPE REQUIRED#If no document type is included in input

#ISSUE COUNTRY REQUIRED#If no country, and document type is A, C, P, T, F, M, or N

#INVALID COUNTRY CODE – SEE HCCC/#If country name or code has no match, or has other than alpha characters.

#TRAVEL DOC NUMBER REQUIRED#If there is no document number included



20


If other than alpha or numeric characters

#VERIFY TVL DOCUMENT NUMBER – ENTER FIRST 15 CHARS#If document number entered is more than 15 characters long

#NATIONALITY COUNTRY REQUIRED#If the document nationality country is not included

#INVALID BIRTHDATE – USE DDMMMYY OR DDMMMYYYY#If the birthdate has invalid characters, or isn’t reasonable

#BIRTHDATE REQUIRED#If no birthdate included

#GENDER REQUIRED#If no gender included

#INVALID GENDER – USE M, F, MI, FI, OR U ONLY#If gender code other than identified

#EXPIRATION DATE REQUIRED#If no expiration date included

#INVALID EXPIRATION DATE – USE DDMMMYY OR DDMMMYYYY#If expiration date is not a valid date

#VERIFY LAST NAME – INPUT FIRST 30 CHARS#If more than 30 characters in last name

#LAST NAME REQUIRED#If no last name provided

#INVALID LAST NAME – NO SPCL CHARS ALLOWED#If other than alpha or space in last name

#FIRST NAME REQUIRED#If no first name provided

#VERIFY FIRST NAME – INPUT FIRST 30 CHARS#If more than 30 characters in the first name

#INVALID FIRST NAME – NO SPCL CHARS ALLOWED#If other than alpha or space in first name

#VERIFY MIDDLE NAME – INPUT FIRST 30 CHARS#If more than 30 characters in the middle name #INVALID MIDDLE NAME – NO SPCL CHARS ALLOWED#If other than alpha or space in middle name

#USE H FOR MULTI NAME PSPT#If multi name passport input, the ‘H’ idicator must be used

#FORMAT#Used for unidentified characters in the message


21


#ITEM TOO LONG#If characters are more than 127 total

#CHECK ITINERARY#If there are no future date or active airline segments

#SEGMENT NUMBER NOT VALID#If the segment number does not exist in itinerary

#INVALID ACTION FOR DOCS#If request is to change data within the SSR

#MULTI PSGR INDICATOR /H ONLY ALLOWED FOR DOCUMENT TYPE P#If /H Multiple Passenger Passport indicator is included in the DOCS and the Document Type is not ‘P’


22


2 . 2 S S R D O C O e n t r y a n d v a l i d a t i o n

2 . 2 . 1 O v e r v i e w

DOCO is the new SSR code for travel Visa and Other information.2 . 2 . 2 A s s u m p t i o n s a n d C o n s t r a i n t s

2.2.2.1 The new entries may be strung together with an end item, as today.

2.2.2.2 As today, collected data is passed to the airport check in system, at time of flight initialization. Continued exchange of reservation and check in data will take place, as it does today.

2.2.2.3 AA will apply special agent security for inputting Host Facts (4 entry) DOCO SSR items. Sabre Subscribers will not be permitted to enter 4DOCO SSR items.This applies to Sabre Subscribers only as Infini and Abacus do not use Host Facts .

2.2.2.4 The Place of Birth, the Document Type, or both must be present.

2.2.2.4.1 If the Document type is present, the document number, place of issue, Visa issue date, and Applicable Country must also be present.

2.2.2.4.2 If the Document type is omitted, the document number, place of issue, Visa issue date, and Applicable Country must also be omitted.


23


2 . 2 . 3 D O C O I n p u t s

3DOCOn/pb/v/dn/ic/di/cc/I-x.x

Where:Component Description Mandatory

OptionalNotes

3 Primary action code MDOCO Secondary action code Mn Segment select O Number 1-99, or ‘A’ for all

* multiple allowed for GFAX and HFAX

pb Place of Birth O O if Document Type is included

M it Document Type is omitted

v Document type O If omitted place of birth must be included, and document number, place of issue, Visa issue date, and Applicable Country should also be omitted

dn Document number M Only Mandatory if document type is present, otherwise should be omitted

ic Place of issue M Only Mandatory if document type is present, otherwise should be omitted

di Visa issue date M Only Mandatory if document type is present, otherwise should be omitted

cc Applicable Country M Only Mandatory if document type is present, otherwise should be omitted

I lap child indicator O-x.x PNR name association M O for single party PNR

M for multi party PNR

2 . 2 . 4 D O C O E l e m e n t B r e a k d o w n :


24




Name Segment NumberMax Field Length

2



Multiple segment numbers allowed for GFAX

Required NOEdits


If segment number is for a flight that is past date or does not accept DOCx


#CHECK ITINERARY#

Same as above error



25


2.2.4.2 Place of Birth Field


Name Place of BirthMax Field Length 35

Character Set Alpha Characters and spaces only. Purpose This is the field for the Visa holder’s

Place of BirthAcceptable Format(s)

The user may enter a complete country name or the 2-character country designator, a city and state, or a city and country name.

Example:User may enter MEXICO or MXUser may enter GB or United Kingdom

Special Instructions Minimum length of 2

Required No – if Document Type included

Yes – if Document Type omitted

If omitted, Document Type (as well as Document Number, Place of Issue, Visa Issue Date, and Applicable Country) must be included

Edits User enters any character other than alpha characters or spaces

User enters only 1 character

User enters more than 35 characters

User doesn’t enter a Place of Birth and Document Type is not included

#INVALID PLACE OF BIRTH#

Same as above error

#INVALID PLACE OF BIRTH – USE FIRST 35 CHARS#

#MUST INCLUDE EITHER PLACE OF BIRTH OR DOCUMENT TYPE OR BOTH#


26


2.2.4.3 Document Type Field


Name Document TypeMax Field Length

1

Character Set Alpha Character V only.V = Visa

Purpose This is the “other” travel document type field. Currently only ‘Visa is valid


Special InstructionsRequired

No - if Place of Birth included

Yes - if Place of Birth is omitted

If omitted, Place of Birth must be included (and Document Number, Place of Issue, Visa Issue Date, and Applicable Country should also be omitted)

Edits User enters any other character except V

Document type field left blank and Place of Birth not included

#INVALID DOCUMENT TYPE – USE V#


2.2.4.4 Visa/Document Number Field


Name Visa/Document NumberMax Field Length 15

Character Set Alpha/Numeric only.Purpose This is the visa document number field. Acceptable Format(s)

N/A

Special InstructionsRequired Yes – if Document Type is present

No – if Document type omitted

Required if Document Type is present, but should be omitted if Document Type is omitted

Edits Special characters present

No Travel Document Number resent and Document Type is present

Document Number is longer than 15 characters


#TRAVEL DOC NUMBER REQUIRED#

#VERIFY TVL DOCUMENT NUMBER – ENTER FIRST 15 CHARS#


27


2.2.4.5 Visa Place of Issue Field


Name Visa Issue CountryMax Field Length 35

Character Set Alpha Characters and spacesPurpose This is the travel document place of visa

issue fieldAcceptable Format(s)Special InstructionsRequired Yes – if Document Type is present

No – if Document type omitted

Required if Document Type is present, but should be omitted if Document type is omitted

EditsCharacter other than an Alpha, Numeric or a Space

No place of issue present and Document Type is present

Limited to 35 characters. If more than 35 characters are input

#INVALID VISA PLACE OF ISSUE – NO SPCL CHARS ALLOWED#

#VISA PLACE OF ISSUE REQUIRED#

#INVALID VISA PLACE OF ISSUE – USE FIRST 35 CHARS#

2.2.4.6 Visa Issue Date Field


Name Visa Date of IssueMax Field Length 9

Character Set Alpha/Numeric Characters only.Purpose This is the date which the Visa was

issuedAcceptable Format(s)



none

Required Yes – if Document Type is present No – if Document type omitted


Edits User enters invalid date data or invalid acceptable format

Issue date left blank and Document Type is present

#INVALID DATE – USE DDMMMYY OR DDMMMYYYY#

#DATE OF ISSUE REQUIRED#


28


2.2.4.7 Visa Applicable Country Field


Name Visa Applicable CountryMax Field Length 3

Character Set Alpha Characters only.Purpose This is the travel nationality country fieldAcceptable Format(s)


Example:MEXICO = MXUNITED KINGDOM = GBUnited Kingdom 3-char = GBR



Required Yes for Visa Document Type No – if Document type omitted


Edits Numeric or special characters present


Visa Applicable Country Field not present and Document Type is present

#INVALID COUNTRY CODE – SEE HCCC/#

Same as above error

#VISA APPLICABLE COUNTRY REQUIRED#

2.2.4.8 Lap Child Field


Name lap child indicatorMax Field Length

1

Character Set Alpha character I only Purpose Indicates information is associated to a

lap childAcceptable Format(s)

N/A


If input, no verification will be done to see if an infant name (I/) exists or if an INF OSI exists.

Required NoEdits Any character other than I #USE I FOR INFANT INDICATOR#


29





Character Set Special Character “-” only.Purpose This is the field separator following all

travel address information to indicate which name field to attach the data.



Required Yes – When followed by a name number.

No – if single name PNREdits Any character other than “-” #FORMAT#


30




Name Name Association NumberMax Field Length 1 name item (5 chars max per name item)


1.1 10.2 11.9 10.12





Required Yes – For multi name PNR No – For single name PNR

For single name PNR the item is automatically associated to the single name.


If the item is associated to more than 1 name




#FORMAT#

#CAN ONLY ASSOCIATE TO ONE PSGR#




2 . 2 . 5 D O C O E n t r y E x a m p l e s

2.2.5.1 Example with Only Mandatory Fields

3DOCO1//V/789789/HOUSTON/14JUN04/USA(document type included, but place of birth not)

3DOCO/MUNICH//789789/HOUSTON/14JUN04/USA(place of birth included, but document type not)

2.2.5.2 Name Select Example

3DOCO1/MUNICH/V/789789/HOUSTON/14JUN04/USA-1.13DOCO1/MUNICH/V/789789/HOUSTON/14JUN04/USA-1.1-5.1


31


2.2.5.3 Lap Child Example

3DOCO1/MUNICH/V/789789/HOUSTON/14JUN04/USA/I-1.1

2.2.5.4 Multiple Segment Select Example

3DOCO1,3-5/MUNICH/V/789789/HOUSTON/14JUN04/USA

2 . 2 . 6 D O C O N o t e s

2.2.6.1 Deletion of a DOCO item can be deliberately requested by using the SSR item number in the deletion request.

Example: 3(line/item number)@37@

2.2.6.2 Optional components do not have to be identified with slashes, as long as there are no remaining components to include, other than name association.

2.2.6.3 Change or modify of Host and General fact to a DOCO is not applicable, and not allowed. Issue error if data following the change key (@) is a DOCO SSR.

2.2.6.4 Multiple DOCO are permitted for the same passenger.

2.2.6.5 If all mandatory items in the DOCO are not included in the PNR entry, validation will reject the entry, and return an error response to the agent or application making the request. The PNR application will include the first missing mandatory item in the DOCO that caused the failure.


2 . 2 . 7 D O C O O u t p u t S u m m a r y



#INVALID PLACE IF BIRTH#If numeric or special characters present in Place of Birth

#INVALID DOCUMENT TYPE – USE V#If Document Type anything other than ‘V’



32


If Document Type or Place of Birth not included

#INVALID TVL DOCUMENT NUMBER – NO SPCL CHARS ALLOWED#If special characters included in Travel Document Number

#TRAVEL DOC NUMBER REQUIRED#If no Travel Document Number included and Document Type is present

#INVALID VISA PLACE OF ISSUE – NO SPCL CHARS ALLOWED#If Special characters included in Visa Place of Issue

#VISA PLACE OF ISSUE REQUIRED#If no Visa Place of Issue included and Document Type is present

#INVALID DATE – USE DDMMMYY OR DDMMMYYYY#If Date of Issue input is not in correct format

#DATE OF ISSUE REQUIRED#If Date of Visa Issue is not included and Document Type is present

#INVALID COUNTRY CODE – SEE HCCC/#If Numeric or special characters included in Country Code or If Country Code entered does not have a match in the Sabre internal country code table

#VISA APPLICABLE COUNTRY REQUIRED#If Visa Applicable Country not included and Document Type is present

#INVALID INFANT INDICATOR – USE I#If input Infant indicator is other than the letter I


33


2 . 3 S S R D O C A e n t r y a n d v a l i d a t i o n

2 . 3 . 1 O v e r v i e w

DOCA is the new SSR code for entry of the address, either residence or destination. This SSR may or may not be name and segment associated.2 . 3 . 2 A s s u m p t i o n s a n d C o n s t r a i n t s

2.3.2.1 The new entries may be strung together with an end item, as today.

2.3.2.2 As today, collected data is passed to the airport check in system, at time of flight initialization. Continued exchange of reservation and check in data will take place, as it does today.

2.3.2.3 Host Fact DOCA items will be allowed for Sabre Subscribers by AA. This is the only DOCx SSR allowed to be entered as a Host Fact by a GDS.

2 . 3 . 3 D O C A I n p u t s

3DOCAn/at/country/street/city/state/zip/I-x.x

4DOCAn/at/country/street/city/state/zip/I-x.x

Where:Component Description Mandatory

OptionalNotes

4 or 3 Primary action code M (4 entry only allowed by AA for Sabre Subscribers)

DOCA Secondary action code Mn Segment select O Number 1-99, or ‘A’ for all

*multiple allowed for GFAX and HFAX

at address type Mcountry Country Mstreet Street M O for Address Type ‘R’ esidencecity City M O for Address Type ‘R’ esidencestate State/Province M O for Address Type ‘R; esidencezip Zip/Postal O I lap child indicator O-x.x PNR name association O


34


2 . 3 . 4 D O C A E l e m e n t B r e a k d o w n :



Name Segment NumberMax Field Length

2



As today 1 segment number is the maximum allowed for HFAX

Multiple segment numbers only allowed for GFAX

Required NOEdits


If segment number input is for a host flight that has already departed

If segment number is for a flight that is past date or does not accept DOCx


#CHECK ITINERARY#

Same as above error

Same as above error


2.3.4.2 Address Type Field


Name Address TypeMax Field Length 1

Character Set Alpha Characters R, D only. R = residence, D = destinationPurpose This is the field for the passenger’s

Residence address = R, or destination address = D


Special InstructionsRequired Yes


35


Edits User enters any other character except R or D

Address type field left blank

#INVALID ADDRESS TYPE – USE R OR D#

#ADDRESS TYPE REQUIRED#


36


2.3.4.3 Address Country Field


Name Address CountryMax Field Length 3

Character Set Alpha Characters only.Purpose This is the country of residence or

destination. Acceptable Format(s)


Example:MEXICO = MXUNITED KINGDOM = GBUnited Kingdom 3-char = GBR



Required Yes Edits Numeric or special characters

present


If country code is blank

#INVALID COUNTRY or COUNTRY CODE – SEE HCCC/#

Same as above error

#ADDRESS COUNTRY REQUIRED#


37


2.3.4.4 Address Street Field


Name Street Input FieldField Length 35Character Set Alpha/Numeric Characters and spacesPurpose Provide street addressAcceptable Format(s)Special InstructionsRequired Yes - Address Type “D”estination

No - Address Type “R”esidenceEdits Street field is blank and Address

Type is “D”

Characters other than alphanumeric or spaces


#STREET ADDRESS REQUIRED#

#INVALID STREET ADDRESS#

#INVALID STREET ADDRESS – USE FIRST 35 CHARS#

2.3.4.5 Address City


Name Address City FieldField Length 35Character Set Alpha Characters and spacesPurpose This is the field for the passenger’s

visiting city address or home city address.Acceptable Format(s)

Cities may be a single or multiple name. Example:DALLASLAS VEGAS

Special Instructions none

Required Yes - Address Type “D”estination No - Address Type “R”esidence

Edits City field is blank and Address Type is “D”



#ADDRESS CITY REQUIRED#

#INVALID CITY ADDRESS – USE ALPHA CHARS#

#INVALID CITY ADDRESS – USE FIRST 35 CHARS#


38


2.3.4.6 State/Province


Name State or Province Input FieldField Length 35Character Set Alpha Characters and spacesPurpose This is the field for the passenger’s

visiting US state address or home state/province address.

Acceptable Format(s)

States or Provinces may be a single or multiple name.

ExampleTEXASNEW JERSEYONTARIONOVA SCOTIA

Special InstructionsRequired Yes - Address Type “D”estination

No - Address Type “R”esidenceEdits State/Province field is blank and

Address Type is “D”



#STATE/PROV ADDRESS REQUIRED#

#INVALID STATE/PROVINCE ADDRESS – NO SPCL CHARS ALLOWED#

#INVALID STATE/PROVINCE ADDRESS – USE FIRST 35 CHARS#


39


2.3.4.7 Zip/Postal Code


Name Zip/Postal Code Input FieldField Length 17Character Set Alpha/Numeric Characters and spacesPurpose This is the field for the passenger’s

visiting US zip/postal code or home zip/postal code


Special InstructionsRequired NoEdits Characters other than alphanumeric

or spaces


#INVALID ZIP/POSTAL CODE – NO SPCL CHARS ALLOWED#

#INVALID ZIP/POSTAL CODE – USE FIRST 17 CHARS#

2.3.4.8 Lap Child Field


Name lap child indicatorMax Field Length

1

Character Set Alpha character I only Purpose Indicates address information is for a lap

child.Acceptable Format(s)

N/A


If input, no verification will be done to see if an infant name (I/) exists or if an INF OSI exists.

Required NoEdits Any character other than I #USE I FOR INFANT INDICATOR#


40





Character Set Special Character “-” only.Purpose This is the field separator following all

travel address information to indicate which name field to attach the data.



Required Yes – Only when a name number is input.

Edits Any character other than “-” #FORMAT#


41




Name Name Association NumberMax Field Length

30 name items (5 chars max per name item)


1.1 10.2 11.9 10.12





Required No

If DOCA is input without name association, the item applies to all passengers in the PNR


If the item is associated to more than 30 names




#FORMAT#

#MAXIMUM OF 30 NAMES ALLOWED#




2 . 3 . 5 D O C A E n t r y E x a m p l e s

GFAX Examples:

2.3.5.1 Segment Select Example:

3DOCA2/R/BR/987 MAIN/EULESS/TX/76040

2.3.5.2 Multiple Segment Select Example:

3DOCA2,3/R/BR/987 MAIN/EULESS/TX/76040


42


2.3.5.3 Mandatory Components Only:

3DOCA/R/GB

3DOCA/D/GB/987 MAIN/EULESS/TX

2.3.5.4 Lap Child Example:

3DOCA/R/USA/987 MAIN/EULESS/TX/76040/I-1.1

HFAX Examples (Sabre Subscribers Only):

2.3.5.5 Segment Select Example:

4DOCA2/R/BR/987 MAIN/EULESS/TX/76040

2.3.5.6 Name Select Examples:

4DOCA2/D/GR/10348 NEWBERRY LANE/RICHMOND/BC/V7B 1Y1-1.14DOCA2/D/GR/10348 NEWBERRY LANE/RICHMOND/BC/V7B 1Y1-1.1-5.1

2.3.5.7 Lap Child Example:

4DOCA/R/USA/987 MAIN/EULESS/TX/76040/I-1.1

2 . 3 . 6 D O C A N o t e s

2.3.6.1 Deletion of a DOCA item can be deliberately requested by using the SSR item number in the deletion request.

2.3.6.2 Optional components do not have to be identified with slashes, as long as there are no remaining components to include, other than name association

2.3.6.3 Change or modify of General fact to a DOCA is not applicable, and not allowed. Issue error if data following the change key (@) is a DOCA SSR.


2.3.6.5 DOCA can be associated only to confirmed segment status codes. Those status codes include:

SC, SS, PS, RR, VG, MM, BK, GK, KK, HK, PK, SK, and TK.Infant PNRs may not have DOCS in them. Segment status codes for infant PNRs is IK


43


2.3.6.6 General Facts DOCA will not overlay previously entered General Facts DOCA items. The agent must manually delete any General Facts DOCA that is no longer needed.

Host Facts Notes (pertaining to Sabre Subscribers only):

2.3.6.7 If the SSR is Host Facts, the airline segment should be for AA.

When adding a host fact DOCA and one is already present,

The old item will be overlaid with the new item if: Segment association is for the same segment

&Airline codes, Flight numbers, Departure Dates, and City Pairs all match&Request is for the same person (either the adult or the lap child)&Same Address Type

Otherwise the old item will remain and the new item will be added.

2.3.6.8 When a host facts DOCA is overlaid, the previous DOCA SSR will be added to the PNR history.

2.3.6.9 If the existing DOCA item is associated to multiple name IDs, and a new item comes in for a passenger ID already identified, the new item will be added. The name association of the existing item will not be modified.

2.3.6.10 If a host facts DOCA request is for an infant, only one lap child is permitted per adult. The steps identified above will overlay the existing DOCA for the lap child with a new DOCA item.

2.3.6.11 Any agent allowed to enter HFAX SSRs, will be allowed to enter HFAX DOCA SSRs depending on the PNR Options table.

2 . 3 . 7 D O C A O u t p u t S u m m a r y



#MAXIMUM OF 30 NAMES ALLOWED#If input more than 30 name associations


44


#ADDRESS TYPE REQUIRED#If Address Type not input

#INVALID ADDRESS TYPE – USE R OR D#If invalid Address Type input

#ADDRESS COUNTRY REQUIRED#If Country for the Address not input

#INVALID COUNTRY CODE – SEE HCCC/#If Country input is invalid

#STREET ADDRESS REQUIRED#If Address Street not input for type ‘D’

#INVALID STREET ADDRESS#If input contains characters other than alphas, numerics, or spaces

#INVALID STREET ADDRESS – USE FIRST 35 CHARS#If input Street Address contains more than 35 characters

#ADDRESS CITY REQUIRED#If Address City not input for type ‘D’

#INVALID CITY ADDRESS – USE ALPHA CHARS#If Address City contains characters other than Alpha or Spaces

#INVALID CITY ADDRESS – USE FIRST 35 CHARS#If input Street Address contains more than 35 characters #STATE/PROV ADDRESS REQUIRED#If Address State/Province not input for type ‘D’ #INVALID STATE/PROVINCE ADDRESS – NO SPCL CHARS ALLOWED#If the input State/Province contains characters other than alphas or spaces

#INVALID STATE/PROVINCE ADDRESS – USE FIRST 35 CHARS#If the input State/Province contains more than 35 characters

#INVALID ZIP/POSTAL CODE – NO SPCL CHARS ALLOWED#If the input Zip/Postal Code contains characters other than alphas, numerics, or spaces

#INVALID ZIP/POSTAL CODE – USE FIRST 17 CHARS#If the input Zip/Postal Code contains more than 17 characters

#USE I FOR INFANT INDICATOR#If input Infant indicator is other than the letter I


45


3 . 1 T e l e t y p e T a b l e O v e r v i e w

The Airline Agreement Table contains airlines with which we exchange information according to a bilateral agreement. To exchange DOCx information with an airline, the new APIS SSR code ‘DO’ must be added to the table.

Help desk agents at the GDS with duty code #, or EPR keyword FSGAGT or CRSAGT can display the table.

To display the Airline Agreement table:KRAAT*1 Displays and sets the default for any following entries to the Sabre

Travel Network airline agreement tableKRAAT*2 Displays and sets the default for any following entries to the

Abacus airline agreement tableKRAAT*3 Displays and sets the default for any following entries to the Infini

airline agreement table

As today, GDS agents that have the EPR keyword KRAAT@ are permitted to make changes to the Airline Agreement table.

3 . 2 D i s p l a y A i r l i n e A g r e e m e n t T a b l e , s p e c i fi c a l l y f o r n e w A P I S S S R O p t i o n

3.2.1 If the display request includes the new code ‘DO’, the table will display only those participating airlines who have agreed to accept the new DOCx items.

Example:KRAAT-DO1« SABRE -AIRLINE AGREEMENT TABLE AL RLC PARTICIPATION BA 6 AB RR DC TA QU SR RL 1S PS LK TS TG DS ET PM PU TE DU DO HA 6 AB RR DC TA BM SR RL FL PS TO TX ET DO

3 . 3 A i r l i n e A g r e e m e n t T a b l e U p d a t e f o r t h e n e w D O C x A P I S S S R t y p e s

3.3.1 The following entry will be used to add the new DO option to the Airline Agreement table.Format: KRAAT/ADD/airline code/DOExample: KRAAT/ADD/BA/DO


3 Teletype Updates

46


3.3.2 The following entry will be used to delete the new DO option from the Airline Agreement table.

Format: KRAAT/DEL/airline code/DOExample: KRAAT/DEL/SQ/DO

3.3.3 If the new APIS SSR codes will be used for a particular airline, normally the SP option (PSPT) will not longer be used. In that condition, it is recommended that the SP option be removed from the Airline Agreement table for the particular airline.Format: KRAAT/ADD/airline code/DOExample: KRAAT/ADD/BA/DO

Term DefinitionAPIS Advanced Passenger Information System

DOCx Refers to the various SSR codes utilized for APIS (DOCS, DOCA, DOCO)

EPR Employee Profile RecordGDS Global Distribution System (e.g. Amadeus, Sabre, Worldspan)GDS Participating Airline

An airline who has an agreement with a GDS to accept APIS SSR items from the GDS member location

IATA International Air Transport AssociationKRAAT Airline Agreement TablePNR Passenger Name RecordSabre Travel Network

GDS hosted in Sabre. The GDS code is 1S.

SSR Special Service RequestPNR Passenger Name RecordU.S. United States


4 Glossary

47

Documents

1 - eService Staging Server€¦ · Web view · 2005-10-25Purpose This is the country of residence or destination. Acceptable Format(s) The user must enter a valid 2 or 3 character