APIS for Subscribers
APIS for Subscribers
Prepared by Teresa Newell (Sabre)
September 23, 2005
Version 1.3
© 2019, 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.
DOCUMENT REVISION INFORMATION
The following information is to be included with all versions of the document.
Project Name / APIS for Subscribers / Project Number / JD271Prepared by / Ellen Moore / Teresa Newell / Date Prepared / September 15, 2005
Revised by / Teresa Newell / Date Revised / Sept. 23, 2005
Revision Reason / 1)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.
1APIS for Subscribers
Overview
GDS Role
Assumptions and Constraints
Quick Reference – Format Examples
2DOCx PNR SSR Items
2.1SSR DOCS entry and validation
2.1.1Overview
2.1.2Assumptions and Constraints
2.1.3DOCS Inputs
2.1.4 DOCS Element Breakdown:
2.1.5DOCS Entry Examples
2.1.6DOCS Notes
2.1.7DOCS Output Summary
2.2SSR DOCO entry and validation
2.2.1Overview
2.2.2Assumptions and Constraints
2.2.3DOCO Inputs
2.2.4DOCO Element Breakdown:
2.2.5DOCO Entry Examples
2.2.6DOCO Notes
2.2.7DOCO Output Summary
2.3SSR DOCA entry and validation
2.3.1Overview
2.3.2Assumptions and Constraints
2.3.3DOCA Inputs
2.3.4DOCA Element Breakdown:
2.3.5DOCA Entry Examples
2.3.6DOCA Notes
2.3.7DOCA Output Summary
3Teletype Updates
3.1Teletype Table Overview
3.2Display Airline Agreement Table, specifically for new APIS SSR Option
3.3Airline Agreement Table Update for the new DOCx APIS SSR types
4Glossary
1APIS 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.
TheUnited 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.
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.1The 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.2As today, the new SSR entries may be strung together with other PNR entries, using an end item.
1.3.3As 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.4The 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.5Multiple names in a PNR require name association in the entry.
1.3.6Single name PNR may assume the single passenger name number.
1.3.7Current Name Association rules apply for PNR DOCx items.
1.3.8The DOCx SSR entries will not be permitted for PNRs with an IK (infant) segment status.
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)
2DOCx PNR SSR Items
2.1SSR DOCS entry and validation
2.1.1Overview
DOCS is the new SSR code for entry of the passport, or other various document types and their associated data elements.
2.1.2Assumptions and Constraints
2.1.2.1Sabre 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.2Sabre 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.
2.1.3DOCS Inputs
2.1.3.1DOCS SSR
3DOCSn/dt/ic/dn/ncc/ddmmmyy/dg/ddmmmyy/last/first/middle/H-x.x
Where:
Component / Description / Mandatory Optional / Notes3 / Primary action code / M
DOCS / Secondary action code / M
n / Segment select / O / Number 1-99, or ‘A’ for all
*multiple allowed for GFAX and HFAX
dt / Document type / M
ic / Document country of issue / M / O for doc F
dn / Document number / M / O for doc F
ncc / Doc nationality country / M
ddmmmyy -or- ddmmmyyyy / Date of birth / M
dg / Gender / infant gender / M / M, F, U, MI, FI
ddmmmyy
-or-
ddmmmyyyy / Doc expiration date / M / O for doc types F, A, N, and V
last / Last name / M
First / First name / M
Middle / Middle name or initial / O
H / 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 DOCS Element Breakdown:
2.1.4.2 Segment Number Requested
EXAMPLES, ERRORS or REFERENCEName / Segment Number
Max Field Length / 2
Character Set / Numeric Characters 1-99
Purpose / Associate SSR to Flight Segment
Acceptable Format(s) / N/A
Special Instructions / Multiple segment numbers allowed for GFAX
Required /
- NO
Edits /
- 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
Same as above error
#SEGMENT NUMBER NOT VALID#
2.1.4.3 Document Type Field
EXAMPLES, ERRORS or REFERENCEName / Document Type
Max Field Length / 1
Character Set / 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 re-entry permit, U.S. Travel document
F=Facilitation document
M = Military
N = Naturalization Certificate
V = Border Crossing Card
Purpose / This is the travel document type field.
Acceptable Format(s) / N/A
Special Instructions
Required /
- Yes
Edits /
- User enters any other character except A, C, P, T, F, M, N, or V
- Document type field left blank
#DOCUMENT TYPE REQUIRED#
2.1.4.4 Document Issue Country Field
EXAMPLES, ERRORS or REFERENCEName / Document Issue Country
Max 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 = MX
UNITED KINGDOM = GB
United Kingdom 3-char = GRB
Special Instructions /
- 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)
Same as above error
# ISSUE COUNTRY REQUIRED#
2.1.4.5 Document Number Field
EXAMPLES, ERRORS or REFERENCEName / Document Number
Max Field Length / 15
Character Set / Alpha/Numeric only.
Purpose / This is the travel document number field.
Acceptable Format(s) / N/A
Special Instructions
Required /
- 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
#TRAVEL DOC NUMBER REQUIRED#
#VERIFY TVL DOCUMENT NUMBER – ENTER FIRST 15 CHARS#
2.1.4.6 Document Nationality Country Field
EXAMPLES, ERRORS or REFERENCEName / Document Nationality Country
Max Field Length / 3
Character Set / Alpha Characters only.
Purpose / This is the travel document nationality country field.
Acceptable Format(s) / The user must enter a valid 2 or 3 character country code. / Example:
MEXICO = MX
UNITED KINGDOM = GB
United Kingdom 3-char = GRB
Special Instructions /
- To be validated against the Sabre internal country code table
Required /
- Yes
Edits /
- Numeric or special characters present
- Country code entered is not a match in the Sabre internal country code table
- If nationality country field is blank
Same as above error
#NATIONALITY COUNTRY CODE REQUIRED#
2.1.4.7 Date of Birth Field
EXAMPLES, ERRORS or REFERENCEName / Date of Birth
Max Field Length / 9
Character Set / Alpha/Numeric Characters only.
Purpose / This is the passenger date of birth
Acceptable Format(s) / ddmmmyy –or- ddmmmyyyy / Examples:
09APR57
09APR1957
Special Instructions /
- none
Required /
- Yes
Edits /
- User enters invalid date data or invalid acceptable format
- Birth date left blank
#BIRTHDATE REQUIRED#
2.1.4.8 Gender Field
EXAMPLES, ERRORS or REFERENCEName / Gender
Max Field Length / 2
Character Set / 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
Purpose / This is the travel document gender field.
Acceptable Format(s)
Special Instructions
Required /
- Yes
Edits /
- Numeric, special characters or a character other than M, F, MI, FI, or U is present
- Gender field blank
#GENDER REQUIRED#
2.1.4.9 Document Expiration Date Field
EXAMPLES, ERRORS or REFERENCEName / Document expiration date
Max Field Length / 9
Character Set / Alpha/Numeric Characters only.
Purpose / This is the travel document expiration date field.
Acceptable Format(s) / ddmmmyy –or- ddmmmyyyy / Examples:
09APR57
09APR1957
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 /
- 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
#EXPIRATION DATE REQUIRED#
2.1.4.10 Last Name Field
EXAMPLES, ERRORS or REFERENCEName / Last Name
Max Field Length / 30
Character Set / Alpha Characters and space only.
Purpose / This is the travel document last name field.
Acceptable Format(s) /
- Names are not necessarily restricted to a single name. Multiple names will be accepted.
GARCIA
GARCIA MENDEZ
Special Instructions /
- 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.
#LAST NAME REQUIRED#
#VERIFY LAST NAME – INPUT FIRST 30 CHARS#
2.1.4.11 First Name Field
EXAMPLES, ERRORS or REFERENCEName / First Name
Max Field Length / 30
Character Set / Alpha Characters and space only.
Purpose / This is the travel document first name field.
Acceptable Format(s) /
- Alpha characters and spaces. A space can be included in the first name
MARY
MARY ELIZABETH
Special Instructions /
- 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
#FIRST NAME REQUIRED#
#VERFIFY FIRST NAME – INPUT FIRST 30 CHARS#
2.1.4.12 Middle Name Field
EXAMPLES, ERRORS or REFERENCEName / Middle or Second given name
Max 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
Special Instructions
Required /
- No
Edits /
- Any character other than an alpha or space is present.
- 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 REFERENCEName / Primary holder of multi name passport
Max Field Length / 1
Character Set / Alpha character H only
Purpose / Indicated primary holder of multi-name passport
Acceptable Format(s) / N/A
Special Instructions /
- only allowed if Document Type = ‘P’
Required /
- No
Edits /
- Any character other than H
- H indicator is present and Document Type is not ‘P’
#MULTI PSGR INDICATOR /H ONLY ALLOWED FOR DOCUMENT TYPE P#
2.1.4.15 Name Association Field Separator
EXAMPLES, ERRORS or REFERENCEName / Field Separator
Max 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 “-”
2.1.4.16 Name Association Number
EXAMPLES, ERRORS or REFERENCEName / Name Association Number
Max 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
Special Instructions /
- 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
- If the item name association number belongs to a group name
- If the item name association number belongs to a BSG name
#CAN ONLY ASSOCIATE TO ONE PSGR#
#CANNOT ASSOCIATE TO INFANT NAME#
#CANNOT ASSOCIATE TO GROUP NAME#
#CANNOT ASSOCIATE TO BSG NAME#
2.1.5DOCS Entry Examples
2.1.5.1Segment Select Example
3DOCS1/P/US/506435409090345/USA/06FEB1952/F/31FEB2008/PEREZ/MARIA/N-1.1
2.1.5.2Multiple Segment Select Example
3DOCS1,3/P/US/506435409090345/USA/06FEB1952/F/31FEB2008/PEREZ/MARIA/N-1.1
2.1.5.3Multi-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.6DOCS Notes
2.1.6.1Multiple 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.