APIS for Subscribers
Prepared by Teresa Newell (Sabre)
September 23, 2005
Version 1.3
APIS for Subscribers
© 2017, 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, 2005
Sabre Inc.
2
APIS for Subscribers
DOCUMENT REVISION INFORMATION
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
Edition No.
1.3
Revision Reason
1) State/Province mandatory for
DOCA type ‘D’
2) ‘A’ for all valid for segment select
for DOCS, DOCA, and DOCO
Revised by
Date Revised
Revision Reason
Edition No.
September 23, 2005
Sabre Inc.
3
APIS for Subscribers
1
APIS for Subscribers...................................................... 6
Overview................................................................................................................................................... 6
GDS Role ................................................................................................................................................. 7
Assumptions and Constraints ................................................................................................................... 7
Quick Reference – Format Examples ....................................................................................................... 9
2
DOCx PNR SSR Items.................................................... 10
2.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.2
Assumptions and Constraints .............................................................................................. 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
3
SSR DOCS entry and validation ............................................................................................... 10
2.1.1
SSR DOCA entry and validation ............................................................................................... 35
2.3.1
Overview.............................................................................................................................. 35
2.3.2
Assumptions and Constraints .............................................................................................. 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
Teletype Updates ........................................................ 47
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
September 23, 2005
Sabre Inc.
4
APIS for Subscribers
4
Glossary .................................................................... 49
September 23, 2005
Sabre Inc.
5
APIS for Subscribers
1
APIS for Subscribers
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.
Overview
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.
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.
September 23, 2005
Sabre Inc.
6
APIS for Subscribers
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.
GDS Role
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.
Assumptions and Constraints
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.
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.
September 23, 2005
Sabre Inc.
7
APIS for Subscribers
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.
September 23, 2005
Sabre Inc.
8
APIS for Subscribers
Quick Reference – Format Examples
DOCS
Format:
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
DOCA
Format:
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)
DOCO
Format:
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)
September 23, 2005
Sabre Inc.
9
APIS for Subscribers
2
DOCx PNR SSR Items
2.1
SSR DOCS entry and validation
2.1.1
Overview
DOCS is the new SSR code for entry of the passport, or other various document
types and their associated data elements.
2.1.2
Assumptions and Constraints
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.
September 23, 2005
Sabre Inc.
10
APIS for Subscribers
2.1.3
DOCS Inputs
2.1.3.1 DOCS SSR
3DOCSn/dt/ic/dn/ncc/ddmmmyy/dg/ddmmmyy/last/first/middle/H-x.x
Where:
2.1.4
Component
Description
3
DOCS
n
Primary action code
Secondary action code
Segment select
Mandatory
Optional
M
M
O
dt
ic
dn
ncc
ddmmmyy
-orddmmmyyyy
dg
ddmmmyy
-orddmmmyyyy
last
First
Middle
H
Document type
Document country of issue
Document number
Doc nationality country
Date of birth
M
M
M
M
M
Gender / infant gender
Doc expiration date
M
M
Last name
First name
Middle name or initial
Multi passenger passport indicator
M
M
O
O
-x.x
PNR name number
M
Notes
Number 1-99, or ‘A’ for all
*multiple allowed for GFAX
and HFAX
O for doc F
O for doc F
M, F, U, MI, FI
O for doc types F, A, N,
and V
*only allowed if Document
Type = ‘P’
O for single party PNR
M for multi party PNR
DOCS Element Breakdown:
September 23, 2005
Sabre Inc.
11
APIS for Subscribers
2.1.4.2 Segment Number Requested
EXAMPLES, ERRORS or
REFERENCE
Name
Max Field
Length
Character Set
Purpose
Acceptable
Format(s)
Special
Instructions
Required
Edits
Segment Number
2
Numeric Characters 1-99
Associate SSR to Flight Segment
N/A
Multiple segment numbers allowed for
GFAX

NO

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
EXAMPLES, ERRORS or
REFERENCE
Name
Max Field
Length
Character Set
Document Type
Purpose
Acceptable
Format(s)
Special
Instructions
Required
Edits
This is the travel document type field.
September 23, 2005
Sabre Inc.
1
Alpha Characters A, C, P, T, F, M, N, and
V only.
A = Alien resident card
C = Permanent resident card
P =
Passport
T =
Refugee travel document and reentry permit, U.S. Travel document
F = Facilitation document
M = Military
N = Naturalization Certificate
V = Border Crossing Card
N/A


Yes
User enters any other character
except A, C, P, T, F, M, N, or V
#INVALID DOCUMENT TYPE – USE A,
C, P, T, F, M, N, OR V#

Document type field left blank
#DOCUMENT TYPE REQUIRED#
12
APIS for Subscribers
2.1.4.4 Document Issue Country Field
EXAMPLES, ERRORS or
REFERENCE
Name
Max Field
Length
Character Set
Purpose
Acceptable
Format(s)
Special
Instructions
Required
Edits
Document Issue Country
3
Alpha Characters only.
This is the travel document issue country
field.
The user must enter a valid 2 or 3
character country code.



To be validated against the Sabre
internal country code table
Yes, except for type F
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)
Example:
MEXICO = MX
UNITED KINGDOM = GB
United Kingdom 3-char = GRB
#INVALID COUNTRY or COUNTRY
CODE – SEE HCCC/#
Same as above error
# ISSUE COUNTRY REQUIRED#
2.1.4.5 Document Number Field
EXAMPLES, ERRORS or
REFERENCE
Name
Max Field
Length
Character Set
Purpose
Acceptable
Format(s)
Special
Instructions
Required
Edits
September 23, 2005
Sabre Inc.
Document Number
15
Alpha/Numeric only.
This is the travel document number field.
N/A



Yes - If travel document type = A, C,
P, T, M, N, V
No – If travel document type = F
Special characters present
#INVALID TVL DOCUMENT NUMBER
– NO SPCL CHARS ALLOWED#

Document types A, C, P, T, M, N, V
present and no travel document
number present
#TRAVEL DOC NUMBER REQUIRED#

Document Number is longer than 15
characters
#VERIFY TVL DOCUMENT NUMBER –
ENTER FIRST 15 CHARS#
13
APIS for Subscribers
2.1.4.6 Document Nationality Country Field
EXAMPLES, ERRORS or
REFERENCE
Name
Max Field
Length
Character Set
Purpose
Acceptable
Format(s)
Special
Instructions
Required
Edits
Document Nationality Country
3
Alpha Characters only.
This is the travel document nationality
country field.
The user must enter a valid 2 or 3
character country code.





To be validated against the Sabre
internal country code table
Yes
Numeric or special characters
present
Country code entered is not a match
in the Sabre internal country code
table
Example:
MEXICO = MX
UNITED KINGDOM = GB
United Kingdom 3-char = GRB
#INVALID COUNTRY CODE – SEE
HCCC/#
Same as above error
#NATIONALITY COUNTRY CODE
REQUIRED#
If nationality country field is blank
2.1.4.7 Date of Birth Field
EXAMPLES, ERRORS or
REFERENCE
Name
Max Field
Length
Character Set
Purpose
Acceptable
Format(s)
Date of Birth
Special
Instructions

none
Required
Edits


Yes
User enters invalid date data or
invalid acceptable format
#INVALID BIRTH DATE – USE
DDMMMYY OR DDMMMYYYY#

Birth date left blank
#BIRTHDATE REQUIRED#
September 23, 2005
Sabre Inc.
9
Alpha/Numeric Characters only.
This is the passenger date of birth
ddmmmyy –or- ddmmmyyyy
Examples:
09APR57
09APR1957
14
APIS for Subscribers
2.1.4.8 Gender Field
EXAMPLES, ERRORS or
REFERENCE
Name
Max Field
Length
Character Set
Purpose
Acceptable
Format(s)
Special
Instructions
Required
Edits
Gender
2
Alpha Characters M, F, U, MI, FI only
M = Male
F = Female
U = Unknown at time of booking
MI = Male traveling with Lap infant
FI = Female traveling with Lap infant
This is the travel document gender field.


Yes
Numeric, special characters or a
character other than M, F, MI, FI, or
U is present
#INVALID GENDER – USE M, F, MI,
FI, OR U ONLY#

Gender field blank
#GENDER REQUIRED#
2.1.4.9 Document Expiration Date Field
EXAMPLES, ERRORS or
REFERENCE
Name
Max Field
Length
Character Set
Purpose
Acceptable
Format(s)
Document expiration date
9
Alpha/Numeric Characters only.
This is the travel document expiration
date field.
ddmmmyy –or- ddmmmyyyy
Special
Instructions

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

Edits

Yes – except for document types F,
A, N, & V
User enters invalid date data or
invalid acceptable format

September 23, 2005
Sabre Inc.
Document expiration date field blank
and doc type P, C, T, or M
Examples:
09APR57
09APR1957
#INVALID EXPIRATION DATE – USE
DDMMMYY OR DDMMMYYYY#
#EXPIRATION DATE REQUIRED#
15
APIS for Subscribers
2.1.4.10 Last Name Field
EXAMPLES, ERRORS or
REFERENCE
Name
Max Field
Length
Character Set
Purpose
Acceptable
Format(s)
Last Name
30
Alpha Characters and space only.
This is the travel document last name
field.

Names are not necessarily restricted
to a single name. Multiple names will
be accepted.
Example:
GARCIA
GARCIA MENDEZ
Special
Instructions

For hyphenated names spaces must
be substituted for special characters,
e.g. “/” or “-“.
Required
Edits


Yes
Any character other than an alpha or
a space.
#INVALID LAST NAME – NO SPCL
CHARS ALLOWED#

Last name field is blank
#LAST NAME REQUIRED#

If more than 30 Chars are input.
#VERIFY LAST NAME – INPUT FIRST
30 CHARS#
2.1.4.11 First Name Field
EXAMPLES, ERRORS or
REFERENCE
Name
Max Field
Length
Character Set
Purpose
Acceptable
Format(s)
First Name
30
Alpha Characters and space only.
This is the travel document first name
field.

Alpha characters and spaces. A
space can be included in the first
name
Special
Instructions

Spaces must be substituted for
special characters, e.g. “/” or “-“.
Required

Yes
September 23, 2005
Sabre Inc.
Example:
MARY
MARY ELIZABETH
16
APIS for Subscribers
Edits

Any character other than an alpha or
a space.
#INVALID FIRST NAME – NO SPCL
CHARS ALLOWED#

First name fields is blank
#FIRST NAME REQUIRED#

If more than 30 Characters are input
#VERFIFY FIRST NAME – INPUT
FIRST 30 CHARS#
2.1.4.12 Middle Name Field
EXAMPLES, ERRORS or
REFERENCE
Name
Max Field
Length
Character Set
Purpose
Acceptable
Format(s)
Special
Instructions
Required
Edits
Middle or Second given name
30

Alpha characters and spaces. A
space can be included in the middle
name
This is the travel document middle initial
or name field.
N/A


No
Any character other than an alpha or
space is present.
#INVALID MIDDLE NAME – NO SPCL
CHARS ALLOWED#

If more than 30 Characters are input
#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)
EXAMPLES, ERRORS or
REFERENCE
Name
Max Field
Length
Character Set
Purpose
Acceptable
Format(s)
Special
Instructions
Required
September 23, 2005
Sabre Inc.
Primary holder of multi name passport
1
Alpha character H only
Indicated primary holder of multi-name
passport
N/A

only allowed if Document Type = ‘P’

No
17
APIS for Subscribers
Edits

Any character other than H
#USE H FOR MULTI NAME PSPT#

H indicator is present and Document
Type is not ‘P’
#MULTI PSGR INDICATOR /H ONLY
ALLOWED FOR DOCUMENT TYPE 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.
September 23, 2005
Sabre Inc.
18
APIS for Subscribers
2.1.4.15 Name Association Field Separator
EXAMPLES, ERRORS or
REFERENCE
Name
Max Field
Length
Character Set
Purpose
Acceptable
Format(s)
Special
Instructions
Required
Edits
Field Separator
1
Special Character “-” only.
This is the field separator to indicate
which name field to attach the data.
N/A
N/A



Yes – When followed by a name
number.
No – if single name PNR.
Any character other than “-”
#FORMAT#
2.1.4.16 Name Association Number
EXAMPLES, ERRORS or
REFERENCE
Name
Max Field
Length
Character Set
Purpose
Acceptable
Format(s)
Special
Instructions
Name Association Number
5
Numeric followed a ”.” and another
Numeric
The Name Association Number of the
passenger that the SSR data is being
input for.
1.1 10.2 11.9 10.12
N/A

Name Association not allowed for B/,
C/, I/, or Z/
Required


Yes – For multi name PNR
No – For single name PNR.
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
#CANNOT ASSOCIATE TO INFANT
NAME#

If the item name association number
belongs to a group name
#CANNOT ASSOCIATE TO GROUP
NAME#

If the item name association number
belongs to a BSG name
September 23, 2005
Sabre Inc.
For single name PNR the item is
automatically associated to the single
name.
#FORMAT#
#CAN ONLY ASSOCIATE TO ONE
PSGR#
#CANNOT ASSOCIATE TO BSG
NAME#
19
APIS for Subscribers
2.1.5
DOCS Entry Examples
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
DOCS Notes
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.
September 23, 2005
Sabre Inc.
20
APIS for Subscribers
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
DOCS Output Summary
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
#INVALID TVL DOCUMENT NUMBER – NO SPCL CHARS ALLOWED#
September 23, 2005
Sabre Inc.
21
APIS for Subscribers
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
September 23, 2005
Sabre Inc.
22
APIS for Subscribers
#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’
September 23, 2005
Sabre Inc.
23
APIS for Subscribers
2.2
SSR DOCO entry and validation
2.2.1
Overview
DOCO is the new SSR code for travel Visa and Other information.
2.2.2
Assumptions and Constraints
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.
September 23, 2005
Sabre Inc.
24
APIS for Subscribers
2.2.3
DOCO Inputs
3DOCOn/pb/v/dn/ic/di/cc/I-x.x
Where:
Component
Description
3
DOCO
n
Primary action code
Secondary action code
Segment select
Mandatory
Optional
M
M
O
pb
Place of Birth
O
Notes
Number 1-99, or ‘A’ for all
* multiple allowed for GFAX and
HFAX
O if Document Type is included
M it Document Type is omitted
2.2.4
v
Document type
O
dn
Document number
M
ic
Place of issue
M
di
Visa issue date
M
cc
Applicable Country
M
I
-x.x
lap child indicator
PNR name association
O
M
If omitted place of birth must be
included, and document number,
place of issue, Visa issue date,
and Applicable Country should
also be omitted
Only Mandatory if document type
is present, otherwise should be
omitted
Only Mandatory if document type
is present, otherwise should be
omitted
Only Mandatory if document type
is present, otherwise should be
omitted
Only Mandatory if document type
is present, otherwise should be
omitted
O for single party PNR
M for multi party PNR
DOCO Element Breakdown:
September 23, 2005
Sabre Inc.
25
APIS for Subscribers
2.2.4.1
Segment Number Requested
EXAMPLES, ERRORS or
REFERENCE
Name
Max
Field
Length
Character Set
Purpose
Acceptable
Format(s)
Special
Instructions
Required
Edits
September 23, 2005
Sabre Inc.
Segment Number
2
Numeric Characters 1-99
Associate SSR to Flight Segment
N/A
Multiple segment numbers allowed for
GFAX

NO

If no segment number is included and
not at least 1 active host segment in
the itinerary
#CHECK ITINERARY#

If segment number is for a flight that
is past date or does not accept DOCx
Same as above error

If segment number input is not a
number 1-99
#SEGMENT NUMBER NOT VALID#
26
APIS for Subscribers
2.2.4.2
Place of Birth Field
EXAMPLES, ERRORS or
REFERENCE
Name
Max Field
Length
Character Set
Purpose
Acceptable
Format(s)
Special
Instructions
Required
Edits
September 23, 2005
Sabre Inc.
Place of Birth
35
Alpha Characters and spaces only.
This is the field for the Visa holder’s
Place of Birth
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 MX
User may enter GB or United Kingdom
Minimum length of 2

No – if Document Type included

Yes – if Document Type omitted

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
If omitted, Document Type (as well as
Document Number, Place of Issue, Visa
Issue Date, and Applicable Country)
must be 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#
27
APIS for Subscribers
2.2.4.3
Document Type Field
EXAMPLES, ERRORS or
REFERENCE
Name
Document Type
Max
Field
Length
Character Set
Alpha Character V only.
V = Visa
This is the “other” travel document type
field. Currently only ‘Visa is valid
Purpose
Acceptable
Format(s)
Special
Instructions
Required
Edits
2.2.4.4
1
N/A
If omitted, Place of Birth must be
included (and Document Number, Place
of Issue, Visa Issue Date, and
Applicable Country should also be
omitted)

No - if Place of Birth included

Yes - if Place of Birth is omitted

User enters any other character
except V
#INVALID DOCUMENT TYPE – USE
V#

Document type field left blank and
Place of Birth not included
#MUST INCLUDE EITHER PLACE OF
BIRTH OR DOCUMENT TYPE OR
BOTH#
Visa/Document Number Field
EXAMPLES, ERRORS or
REFERENCE
Name
Max Field
Length
Character Set
Purpose
Acceptable
Format(s)
Special
Instructions
Required
Visa/Document Number


Yes – if Document Type is present
No – if Document type omitted
Edits

Special characters present

No Travel Document Number resent
and Document Type is present
#TRAVEL DOC NUMBER REQUIRED#

Document Number is longer than 15
characters
#VERIFY TVL DOCUMENT NUMBER –
ENTER FIRST 15 CHARS#
September 23, 2005
Sabre Inc.
15
Alpha/Numeric only.
This is the visa document number field.
N/A
Required if Document Type is present,
but should be omitted if Document Type
is omitted
#INVALID TVL DOCUMENT NUMBER
– NO SPCL CHARS ALLOWED#
28
APIS for Subscribers
2.2.4.5
Visa Place of Issue Field
EXAMPLES, ERRORS or
REFERENCE
Name
Max Field
Length
Character Set
Purpose
Acceptable
Format(s)
Special
Instructions
Required
Visa Issue Country
35
Alpha Characters and spaces
This is the travel document place of visa
issue field


Yes – if Document Type is present
No – if Document type omitted
Edits
Character other than an Alpha,
Numeric or a Space
2.2.4.6
Required if Document Type is present,
but should be omitted if Document type
is omitted
#INVALID VISA PLACE OF ISSUE –
NO SPCL CHARS ALLOWED#
No place of issue present and
Document Type is present
#VISA PLACE OF ISSUE REQUIRED#
Limited to 35 characters. If more than
35 characters are input
#INVALID VISA PLACE OF ISSUE –
USE FIRST 35 CHARS#
Visa Issue Date Field
EXAMPLES, ERRORS or
REFERENCE
Name
Max Field
Length
Character Set
Purpose
Acceptable
Format(s)
Visa Date of Issue
9
Alpha/Numeric Characters only.
This is the date which the Visa was
issued
ddmmmyy –or- ddmmmyyyy
Special
Instructions

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
September 23, 2005
Sabre Inc.
Examples:
09APR57
09APR1957
Required if Document Type is present,
but should be omitted if Document type
is omitted
#INVALID DATE – USE DDMMMYY
OR DDMMMYYYY#
#DATE OF ISSUE REQUIRED#
29
APIS for Subscribers
2.2.4.7
Visa Applicable Country Field
EXAMPLES, ERRORS or
REFERENCE
Name
Max Field
Length
Character Set
Purpose
Acceptable
Format(s)
Visa Applicable Country
Special
Instructions
Required

To be validated against the Sabre
internal country code table


Yes for Visa Document Type
No – if Document type omitted
Edits

Numeric or special characters
present

Country code entered is not a match
in the Sabre internal country code
table

Visa Applicable Country Field not
present and Document Type is
present
2.2.4.8
3
Alpha Characters only.
This is the travel nationality country field
The user must enter a valid 2 or 3
character country code.
Example:
MEXICO = MX
UNITED KINGDOM = GB
United Kingdom 3-char = GBR
Required if Document Type is present,
but should be omitted if Document type
is omitted
#INVALID COUNTRY CODE – SEE
HCCC/#
Same as above error
#VISA APPLICABLE COUNTRY
REQUIRED#
Lap Child Field
EXAMPLES, ERRORS or
REFERENCE
Name
Max Field
Length
Character Set
Purpose
Acceptable
Format(s)
Special
Instructions
Required
Edits
September 23, 2005
Sabre Inc.
lap child indicator
1
Alpha character I only
Indicates information is associated to a
lap child
N/A
If input, no verification will be done to
see if an infant name (I/) exists or if
an INF OSI exists.


No
Any character other than I
#USE I FOR INFANT INDICATOR#
30
APIS for Subscribers
2.2.4.9
Name Association Field Separator
EXAMPLES, ERRORS or
REFERENCE
Name
Max Field
Length
Character Set
Purpose
Acceptable
Format(s)
Special
Instructions
Required
Edits
September 23, 2005
Sabre Inc.
Field Separator
1
Special Character “-” only.
This is the field separator following all
travel address information to indicate
which name field to attach the data.
N/A
N/A



Yes – When followed by a name
number.
No – if single name PNR
Any character other than “-”
#FORMAT#
31
APIS for Subscribers
2.2.4.10
Name Association Number
EXAMPLES, ERRORS or
REFERENCE
Name
Max Field
Length
Character Set
Purpose
Acceptable
Format(s)
Special
Instructions
Name Association Number
1 name item (5 chars max per name item)
Numeric followed a ”.” and another
Numeric
The Name Association Number of the
passenger that the SSR data is being
input for.
1.1 10.2 11.9 10.12
N/A

Name Association not allowed for B/,
C/, I/, or Z/
Required


Yes – For multi name PNR
No – For single name PNR
Edits

Any character other than Numeric or
“.”

If the item is associated to more than
1 name
#CAN ONLY ASSOCIATE TO ONE
PSGR#

If the item name association number
belongs to an infant
#CANNOT ASSOCIATE TO INFANT
NAME#

If the item name association number
belongs to a group name
#CANNOT ASSOCIATE TO GROUP
NAME#

If the item name association number
belongs to a BSG name
#CANNOT ASSOCIATE TO BSG
NAME#
2.2.5
DOCO Entry Examples
2.2.5.1
Example with Only Mandatory Fields
For single name PNR the item is
automatically associated to the single
name.
#FORMAT#
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.1
3DOCO1/MUNICH/V/789789/HOUSTON/14JUN04/USA-1.1-5.1
September 23, 2005
Sabre Inc.
32
APIS for Subscribers
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
DOCO Notes
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.6.6
The Sabre internal country code table will be used to validate the country
code.
2.2.7
DOCO Output Summary
2.2.7.1
Successful input will cause the standard passenger data field response: *.
2.2.7.2
Error Messages:
#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’
#MUST INCLUDE EITHER PLACE OF BIRTH OR DOCUMENT TYPE OR BOTH#
September 23, 2005
Sabre Inc.
33
APIS for Subscribers
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
September 23, 2005
Sabre Inc.
34
APIS for Subscribers
2.3
SSR DOCA entry and validation
2.3.1
Overview
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
Assumptions and Constraints
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
DOCA Inputs
3DOCAn/at/country/street/city/state/zip/I-x.x
4DOCAn/at/country/street/city/state/zip/I-x.x
Where:
Component
Description
4 or 3
Primary action code
Mandatory
Optional
M
DOCA
n
Secondary action code
Segment select
M
O
at
country
street
city
state
zip
I
-x.x
address type
Country
Street
City
State/Province
Zip/Postal
lap child indicator
PNR name association
M
M
M
M
M
O
O
O
September 23, 2005
Sabre Inc.
Notes
(4 entry only allowed by AA for
Sabre Subscribers)
Number 1-99, or ‘A’ for all
*multiple allowed for GFAX and
HFAX
O for Address Type ‘R’ esidence
O for Address Type ‘R’ esidence
O for Address Type ‘R; esidence
35
APIS for Subscribers
2.3.4
2.3.4.1
DOCA Element Breakdown:
Segment Number Requested
EXAMPLES, ERRORS or
REFERENCE
Name
Segment Number
Max
Field
Length
Character Set
Purpose
Acceptable
Format(s)
Special
Instructions
Numeric Characters 1-99
Associate SSR to Flight Segment
N/A
As today 1 segment number is the
maximum allowed for HFAX
Multiple segment numbers only allowed
for GFAX

NO
Required
Edits
2.3.4.2
2

If no segment number is included and
not at least 1 active host segment in
the itinerary

If segment number input is for a host
flight that has already departed
Same as above error

If segment number is for a flight that
is past date or does not accept DOCx
Same as above error

If segment number input is not a
number 1-99
#SEGMENT NUMBER NOT VALID#
#CHECK ITINERARY#
Address Type Field
EXAMPLES, ERRORS or
REFERENCE
Name
Max Field
Length
Character Set
Purpose
Acceptable
Format(s)
Special
Instructions
Required
September 23, 2005
Sabre Inc.
Address Type
1
Alpha Characters R, D only.
This is the field for the passenger’s
Residence address = R, or destination
address = D
R = residence, D = destination
N/A

Yes
36
APIS for Subscribers
Edits
September 23, 2005
Sabre Inc.

User enters any other character
except R or D
#INVALID ADDRESS TYPE – USE R
OR D#

Address type field left blank
#ADDRESS TYPE REQUIRED#
37
APIS for Subscribers
2.3.4.3
Address Country Field
EXAMPLES, ERRORS or
REFERENCE
Name
Max Field
Length
Character Set
Purpose
Acceptable
Format(s)
Special
Instructions
Required
Edits
September 23, 2005
Sabre Inc.
Address Country
3
Alpha Characters only.
This is the country of residence or
destination.
The user must enter a valid 2 or 3
character country code.



To be validated against the Sabre
internal country code table
Yes
Numeric or special characters
present

Country code entered is not a match
in the Sabre internal country code
table

If country code is blank
Example:
MEXICO = MX
UNITED KINGDOM = GB
United Kingdom 3-char = GBR
#INVALID COUNTRY or COUNTRY
CODE – SEE HCCC/#
Same as above error
#ADDRESS COUNTRY REQUIRED#
38
APIS for Subscribers
2.3.4.4
Address Street Field
EXAMPLES, ERRORS or
REFERENCE
Name
Field Length
Character Set
Purpose
Acceptable
Format(s)
Special
Instructions
Required
Street Input Field
35
Alpha/Numeric Characters and spaces
Provide street address
Edits
Street field is blank and Address
Type is “D”
2.3.4.5


Yes - Address Type “D”estination
No - Address Type “R”esidence
#STREET ADDRESS REQUIRED#
Characters other than alphanumeric
or spaces
#INVALID STREET ADDRESS#
Limited to 35 characters. If more than
35 characters are input
#INVALID STREET ADDRESS – USE
FIRST 35 CHARS#
Address City
EXAMPLES, ERRORS or
REFERENCE
Name
Field Length
Character Set
Purpose
Acceptable
Format(s)
Address City Field
35
Alpha Characters and spaces
This is the field for the passenger’s
visiting city address or home city address.
Cities may be a single or multiple name.
Special
Instructions
Required

none


Yes - Address Type “D”estination
No - Address Type “R”esidence
Edits
City field is blank and Address Type
is “D”
Characters other than alphanumeric
or spaces
Limited to 35 characters. If more than
35 characters are input
September 23, 2005
Sabre Inc.
Example:
DALLAS
LAS VEGAS
#ADDRESS CITY REQUIRED#
#INVALID CITY ADDRESS – USE
ALPHA CHARS#
#INVALID CITY ADDRESS – USE
FIRST 35 CHARS#
39
APIS for Subscribers
2.3.4.6
State/Province
EXAMPLES, ERRORS or
REFERENCE
Name
Field Length
Character Set
Purpose
Acceptable
Format(s)
Special
Instructions
Required
Edits
September 23, 2005
Sabre Inc.
State or Province Input Field
35
Alpha Characters and spaces
This is the field for the passenger’s
visiting US state address or home
state/province address.
States or Provinces may be a single or
multiple name.


Example
TEXAS
NEW JERSEY
ONTARIO
NOVA SCOTIA
Yes - Address Type “D”estination
No - Address Type “R”esidence
State/Province field is blank and
Address Type is “D”
#STATE/PROV ADDRESS
REQUIRED#
Characters other than alphanumeric
or spaces
#INVALID STATE/PROVINCE
ADDRESS – NO SPCL CHARS
ALLOWED#
Limited to 35 characters. If more than
35 characters are input
#INVALID STATE/PROVINCE
ADDRESS – USE FIRST 35 CHARS#
40
APIS for Subscribers
2.3.4.7
Zip/Postal Code
EXAMPLES, ERRORS or
REFERENCE
Name
Field Length
Character Set
Purpose
Acceptable
Format(s)
Special
Instructions
Required
Edits
Zip/Postal Code Input Field
17
Alpha/Numeric Characters and spaces
This is the field for the passenger’s
visiting US zip/postal code or home
zip/postal code
N/A

No
Characters other than alphanumeric
or spaces
Limited to 17 characters. If more than
17 characters are input
2.3.4.8
#INVALID ZIP/POSTAL CODE – NO
SPCL CHARS ALLOWED#
#INVALID ZIP/POSTAL CODE – USE
FIRST 17 CHARS#
Lap Child Field
EXAMPLES, ERRORS or
REFERENCE
Name
Max Field
Length
Character Set
Purpose
Acceptable
Format(s)
Special
Instructions
Required
Edits
September 23, 2005
Sabre Inc.
lap child indicator
1
Alpha character I only
Indicates address information is for a lap
child.
N/A
If input, no verification will be done to
see if an infant name (I/) exists or if
an INF OSI exists.


No
Any character other than I
#USE I FOR INFANT INDICATOR#
41
APIS for Subscribers
2.3.4.9
Name Association Field Separator
EXAMPLES, ERRORS or
REFERENCE
Name
Max Field
Length
Character Set
Purpose
Acceptable
Format(s)
Special
Instructions
Required
Edits
September 23, 2005
Sabre Inc.
Field Separator
1
Special Character “-” only.
This is the field separator following all
travel address information to indicate
which name field to attach the data.
N/A
N/A

Yes – Only when a name number is
input.

Any character other than “-”
#FORMAT#
42
APIS for Subscribers
2.3.4.10
Name Association Number
EXAMPLES, ERRORS or
REFERENCE
Name
Max Field
Length
Character Set
Purpose
Acceptable
Format(s)
Special
Instructions
Name Association Number
30 name items (5 chars max per name
item)
Numeric followed a ”.” and another
Numeric
The Name Association Number of the
passenger that the SSR data is being
input for.
N/A

Name Association not allowed for B/,
C/, I/, or Z/

No

Any character other than Numeric or
“.”

If the item is associated to more than
30 names
#MAXIMUM OF 30 NAMES
ALLOWED#

If the item name association number
belongs to an infant
#CANNOT ASSOCIATE TO INFANT
NAME#

If the item name association number
belongs to a group name
#CANNOT ASSOCIATE TO GROUP
NAME#

If the item name association number
belongs to a BSG name
Required
Edits
2.3.5
1.1 10.2 11.9 10.12
If DOCA is input without name
association, the item applies to all
passengers in the PNR
#FORMAT#
#CANNOT ASSOCIATE TO BSG
NAME#
DOCA Entry Examples
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
September 23, 2005
Sabre Inc.
43
APIS for Subscribers
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.1
4DOCA2/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
DOCA Notes
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.4
The Sabre internal country code table will be used to validate the country
code.
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
September 23, 2005
Sabre Inc.
44
APIS for Subscribers
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
DOCA Output Summary
2.3.7.1
Successful input will cause the standard passenger data field response: *.
2.3.7.2
Error Messages:
#MAXIMUM OF 30 NAMES ALLOWED#
If input more than 30 name associations
September 23, 2005
Sabre Inc.
45
APIS for Subscribers
#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
September 23, 2005
Sabre Inc.
46
APIS for Subscribers
3
3.1
Teletype Updates
Teletype Table Overview
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 table
KRAAT*2
Displays and sets the default for any following entries to the
Abacus airline agreement table
KRAAT*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
Display Airline Agreement Table,
specifically for new APIS SSR Option
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
Airline Agreement Table Update for the new
DOCx APIS SSR types
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/DO
Example:
KRAAT/ADD/BA/DO
September 23, 2005
Sabre Inc.
47
APIS for Subscribers
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/DO
Example:
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/DO
Example:
KRAAT/ADD/BA/DO
September 23, 2005
Sabre Inc.
48
APIS for Subscribers
4
Glossary
Term
APIS
DOCx
EPR
GDS
GDS
Participating
Airline
Definition
Advanced Passenger Information System
Refers to the various SSR codes utilized for APIS (DOCS, DOCA,
DOCO)
Employee Profile Record
Global Distribution System (e.g. Amadeus, Sabre, Worldspan)
An airline who has an agreement with a GDS to accept APIS SSR
items from the GDS member location
IATA
KRAAT
PNR
Sabre
Travel
Network
International Air Transport Association
Airline Agreement Table
Passenger Name Record
GDS hosted in Sabre. The GDS code is 1S.
SSR
PNR
U.S.
Special Service Request
Passenger Name Record
United States
September 23, 2005
Sabre Inc.
49