API用户手册.docx

1、API用户手册API用户手册第一章 前言1.1 背景：当前采用的APIS基于US EDIFACT，不能包含所有的UN EDIFACT要求的数据元素，因而美国要求航空公司于2005年10月4日采用基于UN EDIFACT标准的PAXLST，加拿大是2005年11月1日。和目前的API信息相比，美国PAXLST增加的信息有：居住国、美国地址（美国公民或持美国居住卡的除外）、护照到期日期，加拿大PAXLST增加的信息：居住国、护照到期日期。PAXLST通常都只要求一种有效证件信息，最多不超过两种，首选护照信息，每个旅客包括婴儿都必须持有至少一种有效证件。1.2 现状：当前订座系统的有SSR PSPT

2、内容，不包括DOCS、DOCO、DOCA，不能提供美国/加拿大PAXLST所需增加的信息。1.3 需求：1.增加三种SSR TYPE：DOCS、DOCO、DOCA2.允许用户通过DPS方式以及手工输入SSR指令方式输入PAXLST信息3.接收处理TYPE-A、TYPE-B的SSR DOCS/DOCO/DOCA报文4.对国航飞美国/加拿大的航班进行出票限制，必须满足：a)飞往美国的航班，出票之前PNR中必须输入SSR DOCS项以及SSR DOCA R/（居住地址）和SSR DOCA D/（目的地地址）三项内容；b)美国出港的航班以及飞往加拿大的航班，出票之前PNR中必须输入SSR DOCS信息

3、。第二章 指令说明2.1 DPS输入省略2.2 SSR 指令输入2.2.1 指令功能SSR DOCS：输入旅客的护照等证件信息SSR DOCA：输入旅客的居住地以及目的地地址信息SSR DOCO：输入旅客的其他相关信息，如VISA卡信息等2.2.2 SSR DOCS/DOCO/DOCA指令输入格式：所有输入，如果有缺失的可选项，必须输入“/”表示该项缺失，如果该项位于输入的最后，可以不输入“/”，系统会自动将“/”补上。以下分别对DOCS/DOCO/DOCA的格式进行说明：有下划线的部分为必输项，其余为可选项。注：本格式说明参照AIRIMP制定，具体的必输或选输项请参照相关标准及离港要求。2.

4、2.2.1 DOCS1.指令格式：SSR DOCS 航空公司代码 Action-Code 1 证件类型/发证国家/证件号码/国籍/出生日期/性别/证件有效期限/SURNAME(姓)/FIRST-NAME(名)/MID-NAME(中间名)/持有人标识H/P12.说明：类型说明exampleSSR3A指令标识SSRDOCS4ASSR Service Type，用于输入证件信息DOCS航空公司代码2AN或3A航空公司代码CAAction-Code2AAction Code，这里，只能允许输入“HK”这一种Action Code HK11nNumber in party，只能输11证件类型1-2A包括

5、：F Approved non-standard identity documents used for travel (as defined by the issuing Country/State)AC Crew Member CertificateA, C, I Identity Card (as defined by the issuing Country/State)IP Passport CardP Passenger PassportP发证国家1-3A证件签发的国家或地区代码USA证件号码1-15AN证件的号码P1*国籍1-3A旅客的国籍，代码USA出生日期7AN DDMMMYY

6、格式10MAY79性别 1-2AF - Female女M - Male男 FI - Female Infant 婴儿，女MI - Male Infant 婴儿，男U - Undisclosed Gender 未知说明：必须先有XN:输入婴儿信息之后才能输入FI/MIM证件有效期限7AN DDMMMYY格式10MAY10Surname1-30A姓，需要与护照上的一致，（有扫描区的以扫描区为准）STEVENSONFirst given name1-30A名字，需要与护照上的一致，（有扫描区的以扫描区为准）JOHNSecond given name1-30A需要与护照上的一致，（有扫描区的以扫描区为

7、准），可选（如果没有，不填）RICHARDH1AMuti-passenger passport, 护照持有者标识，可选HPSGR-IDPn旅客标识，用P1,P2等表示。说明：对单人PNR，可以不输入PSGR-ID，系统会自动为其添加/P1如果是多人PNR，必须输入PSGR-ID，并且一名旅客只能对应一个DOCS，一个SSR DOCS element也只能对应一个PSGR-ID。P13.实例：例1、旅客张大龙，护照： 照片PCHN7姓 名 Name in full 张 大 龙 ZHANG DALONG性 别 Sex 男 M身 份 Profession企 业 管 理 人 员 MANAGER婚姻状况

8、 Marital status未 婚SINGLE出生日期 Date of birth24 APR 1967出生地点 Place of birth北 京BEIJING有效期至 Date of expiry身份证号码 Identity card No.POCHNZHANGDALONG9CHN6704241M020423DOCS输入：说明：出生日期：24APR67 性别：M 证件有效期：23APR02姓： ZHANG 名：DALONG注：如果出现扫描区的信息与护照上其他信息冲突的时候一定以扫描区内容为准。例2、旅客张大龙带着一名儿童张小龙和一名婴儿张强，持例一中的护照旅行：DOCS输入：/H/P1/

9、MI/23APR02/ZHANG/QIANG/P1SSR DOCS C/P2说明：1)张大龙：护照持有者（输入H）出生日期：24APR67 性别：M 证件有效期：23APR02姓： ZHANG 名：DALONG2)张强：男婴（性别输入MI），护照信息与张大龙的一致，出生日期为2004年12月10日，不占座。3)张小龙：护照信息与张大龙的一致，男孩（性别输入M），出生日期为1999年9月20日，占座，P22.2.2.2 DOCO目前此项属于可选项。1.指令格式SSR DOCO 航空公司代码 HK1 出生地/类型V/VISA卡号码/发卡地区/发卡日期/卡有效国家或地区/婴儿标识I/P1说明：类型说

10、明exampleSSR3A指令标识SSRDOCO4ASSR Service Type，用于输入证件信息DOCO航空公司代码2AN或3A航空公司代码CAAction-Code2AAction Code，这里，只能允许输入“HK”这一种Action Code HK11nNumber in party，只能输11出生地1-35A旅客或机组成员的出生地AMBER HILL GBR类型V1ATravel Document Type，目前只有”v”，表示信用卡，如果出现这一项，接下来的卡号，发卡地区，发卡日期，卡有效国家或州等各项都必须输入。若不输入信用卡信息，直接输入：SSR DOCO CA HK1 B

11、irth-place/p1SSR DOCO CA HK1 Birth-place/I/p1(婴儿)VVISA卡号码1-15AN信用卡号码9891404发卡地区1-35ALONDON发卡日期7ANDDMMMYY格式10MAY04卡有效国家或地区1-3A信用卡有效使用的国家或地区国家或州）的代码USA婴儿标识I1A婴儿标识，可选，必须先有XN:输入婴儿信息之后才能输入婴儿标识IPSGR-IDPn旅客标识，用P1,P2等表示。说明：对单人PNR，可以不输入PSGR-ID，系统会自动为其添加/P1如果是多人PNR，必须输入PSGR-ID，并且一名旅客只能对应一个DOCO，一个SSR DOCO elem

12、ent也只能对应一个PSGR-ID。P12.实例：1)输全：SSR DOCO CA HK1 出生地/类型V/VISA卡号码/发卡地区/发卡日期/卡有效国家或州/婴儿标识I/P1如：SSR DOCOCA HK1 BIRTHPLACE/V/VISANUMBER/ISSUEPLACE/10MAY04/USA/I/P1输出：5.SSR DOCS CA HK1 P/USA/PASSPORTNUMBER/USA/10MAY79/M/10MAY10/SURNAME/ /FIRSENAME/MIDNAME/H/P1 2)省略出生的信息SSR DOCO CA HK1 /类型V/VISA卡号码/发卡地区/发卡日期

13、/卡有效国家或州/婴儿标识I/P1SSR DOCOCA HK1 /V/VISANUMBER/ISSUEPLACE/10MAY04/USA/I/P1 输出：5.SSR DOCO CA HK1 /V/VISANUMBER/ISSUEPLACE/10MAY04/USA/I/P13)省略VISA信息SSR DOCO CA HK1 出生地/婴儿标识I/P1如：输入：SSR DOCO CA HK1 BIRTHPLACE/I/P1输出：5.SSR DOCO CA HK1 BIRTHPLACE/I/P1 输入：SSR DOCO CA HK1 BIRTH ADDRESS/P1 输出：5.SSR DOCO CA

14、HK1 BIRTH ADDRESS/P14)省略 婴儿标识ISSR DOCO CA HK1 出生地/类型V/VISA卡号码/发卡地区/发卡日期/卡有效国家或州/P1如：输入：SSR DOCOCA HK1 BIRTHPLACE/V/VISANUMBER/ISSUEPLACE/10MAY04/USA/P1输出：5.SSR DOCO CA HK1 BIRTHPLACE/V/VISANUMBER/ISSUEPLACE/10MAY04/USA/P12.2.2.3 DOCA1.指令格式：SSR DOCA 航空公司代码 HK1 地址类型/国家/详细地址/城市/所在省市（州）信息/邮编/I婴儿标识/P1注意：

15、前往美国旅行的旅客，目的地地址(SSR DOCA D/)的所有项必须输全（除了婴儿标识）;所在州必须输两字代码（如TX），请查阅相关代码表。2.说明：类型说明exampleSSR3A指令标识SSRDOCA4ASSR Service Type，用于输入证件信息DOCA航空公司代码2AN或3A航空公司代码CAAction-Code2AAction Code，这里，只能允许输入“HK”这一种Action Code HK11nNumber in party，只能输11地址类型1ADOCA的地址类型：R 居住的地址标识D 目的地地址标识R国家1-3A国家代码USA详细地址1-35AN详细地址1600 S

16、MITH STREET城市1-35A所在城市HOUSTON所在省市（州）信息1-35A所在省市（州）信息TX邮编1-17AN邮编77001婴儿标识I1A婴儿标识，可选，必须先有XN:输入婴儿信息之后才能输入婴儿标识IPSGR-IDPn旅客标识，用P1,P2等表示。说明：对单人PNR，可以不输入PSGR-ID，系统会自动为其添加/P1；如果是多人PNR，必须输入PSGR-ID；并且对于每一种DOCA地址类别（R/D），一名旅客只能对应一个DOCA，一个SSR DOCA element也只能对应一个PSGR-ID。P13.举例：SSR DOCA CA HK1 R或D标识/国家/详细地址/城市/所在

17、省市（州）信息/邮编/I婴儿标识/P1例1、旅客居住地址：美国佐治亚州Georgia（GA）亚特兰大Atlanta（ATL），详细地址为：No. 7, STREET1，邮编12345，带着一名婴儿。前往德克萨斯州TEXAS（TX）的奥斯汀AUSTIN（AUS）的No. 17, STREET2。如：SSR DOCA CA HK1 R/USA/No. 7, STREET1/ATLANTA/GA/12345/P1SSR DOCA CA HK1 R/USA/ No. 7, STREET1/ATLANTA/GA/12345/I/P1SSR DOCA CA HK1 D/USA/ No. 17, STREE

18、T2/AUSTIN/TX/12345/P1SSR DOCA CA HK1 D/USA/ No. 17, STREET2/AUSTIN/TX/12345/I/P1例2、居住地址项省略详细地址：SSR DOCA CA HK1 R或D标识/国家/ /城市/所在省市（州）信息/邮编/I婴儿标识/P1如：SSR DOCA CA HK1 R/USA/ ATLANTA /GA/77001/I/P1输出：16.SSR DOCA CA HK1 R/USA/ ATLANTA /GA/77001/I/P1例3、居住地址项省略多处OPTIONAL项（都在输入的最后）SSR DOCA CA HK1 R或D标识/国家/详

19、细地址/城市/所在省市（州）信息/邮编/I婴儿标识/P1如：SSR DOCA CA HK1 R/USA/16000 SMITH STREET/HOUSTON /P1输出：11.SSR DOCA CA HK1 R/USA/16000 SMITH STREET/HOUSTON/P1 例4、居住地址项省略所在省市、邮编但有婴儿标识I的输入方法SSR DOCA CA HK1 R或D标识/国家/详细地址/城市/所在省市（州）信息/邮编/I婴儿标识/P1如：省略邮编SSR DOCA CA HK1 R/USA/16000 SMITH STREET/HOUSTON/TX/I/P1注：需要输入/I，否则，会把“

20、I”当成邮编的自由文本输入输出：11.SSR DOCA CA HK1 R/USA/16000 SMITH STREET/HOUSTON/TX/I/P1 错误输入：SSR DOCA CA HK1 R/USA/16000 SMITH STREET/HOUSTON/TX/I/P111.SSR DOCA CA HK1 R/USA/16000 SMITH STREET/HOUSTON/TX/I/P1 同样的如果所在省市和邮编都省略，则需要输入/ISSR DOCA CA HK1 R/USA/16000 SMITH STREET/HOUSTON/I/P111.SSR DOCA CA HK1 R/USA/16

21、000 SMITH STREET/HOUSTON/I/P1 错误输入：SSR DOCA CA HK1 R/USA/16000 SMITH STREET/HOUSTON/TX/I/P111.SSR DOCA CA HK1 R/USA/16000 SMITH STREET/HOUSTON/TX/I/P1 说明：此时把“I”当成所在省市的自由文本处理。2.2.3 部分错误提示GENGER 性别输入错误，合法的性别为：F-女性M-男性 U-不确定NATIONALITY 请校验国家代码的正确性DOCUMENT TYPE证件类型错误，DOCS合法的证件类型为：F,A,C,AC,P,IP,I；DOCO合法的

22、证件类型为：VDOCUMENT NUMBER 证件号码不合法DOCS IS REQUIRED FOR DOCO 请在填写DOCO信息前，先填写DOCS信息CHECK INFANT 请检查指定旅客是否带有婴儿USA STATE CODE ERROR 美国州的两字代码错误ADDRESS TYPE:R FOR RESIDENCE;D FOR DESTINATION 地址类型错误，R指居住地；D指目的地DUP ID 目前指定旅客已存在相应的DOC信息第三章 出票限制对美国/加拿大航线的航班进行出票限制，必须满足：1.美国入港的航班，出票之前PNR中必须输入SSR DOCS项以及SSR DOCA R/（

23、居住地址）和SSR DOCA D/（目的地地址）三项内容；a)旅客必须按要求输入护照或其他证件信息：SSR DOCS婴儿也必须输入相应的SSR DOCS 项，否则不允许出票，提示：PLEASE INPUT SSR DOCS/SSR DOCA ELEMENT!b)旅客必须按要求输入居住地址信息：SSR DOCA R/ 婴儿也必须输入相应的SSR DOCA R/ 项，否则不允许出票，提示：PLEASE INPUT SSR DOCS/SSR DOCA ELEMENT!c)旅客必须按要求输入目的地址信息：SSR DOCA D/婴儿也必须输入相应的SSR DOCA D/ 项，否则不允许出票，提示：PLE

24、ASE INPUT SSR DOCS/SSR DOCA ELEMENT!2.美国出港的航班以及加拿大入港的航班，出票之前PNR中必须输入SSR DOCS信息。旅客必须按要求输入护照或其他证件信息：SSR DOCS婴儿也必须输入相应的SSR DOCS 项，否则不允许出票，提示：PLEASE INPUT SSR DOCS/SSR DOCA ELEMENT!【特别提示】对于无扫描区的护照，请务必严格按照护照中内容准确输入，避免给旅客在值机时带来不必要的麻烦，甚至导致航班的延误。附录1 国家代码列表国家名称二字代码三字代码ANDORRAADANDANGOLAAOAGOANTARTICAAQATAANT

25、IQUA / BARBUDAAGATGARMENIAAMARMARUBAAWABWAUSTRIAATAUTBAHAMASBSBHSBANGLADESHBDBGDBARBADOSBBBRBBELARUSBYBLRBELIZEBZBLZBENINBJBENBRUNI DARUSSALAMBNBRNBURUNDIBIBDICAPE VERDECVCPVCAYMAN ISLANDSKYCYMCENTRAL AFRICAN REPUBLICCFCAFCHADTDTCDCHILECLCHLCHINACNCHNCOMOROSKMCOMCONGOCGCOGCOOK ISLANDSCKCOKCZECH REPU

26、BLICCSCZEDENMARKDKDNKEL SALVADORSVSLVESTONIAEEESTEQUITORIAL GUINEAGQGNQFAROE ISLANDSFOFROFAULKLAND ISLANDSFKFLKFRENCH GUIANAGFGUFFRENCH POLYNESIAPFPYFGERMANYDEDEUGREENLANDGLGRLGRENADAGDGRDGUADELOUPEGPGLPGUINEAGNGINGUINEA-BISSAUGYGNBGUYANAGYGUYIRAQIQIRQIRELANDIEIRLISREALILISRJAMACIAJMJAMKAZAKHSTANKZK

27、AZKOREA DEMOCRATIC REPUBLICKPPRKKOREA REPUBLICKRKORLIBERIALRLBRLIBIALYLBYMACAUMOMACMADIGASCARMGMDGMALDIVESMVMDVMALTAMTMLTMARTINIQUEMQMTQMICRONESIAFMFSMMEXICOMXMEXMOLDAVIAMDMOAMOZAMBIQUEMZMOZNIUENUNIUNORTHERN MARIANA ISLANDMPMNPPAKISTANPKPAKPALAUPWPLWPAPUA NEW GUINEAPGPNGPARAGUAYPYPRYPOLANDPLPOLPORTU

28、GALPTPRTSENEGALSNSENSLOVAK REPUBLICSKSVKSLOVINIASISVNSOLOMON ISLANDSSBSLBST. PIERRE AND MIQUELONPMSPMSURINAMSRSURSWAZILZNDSZSWZSWEDENSESWESYCHELLESSCSYCTUNISIATNTUNTURKMENISTANTMTKMTURKEYTRTURTUVALUTVTUVUKRAINEUAUKRUNITED ARAB EMIRATESAEAREUNITED STATESUSUSAURUGUAYUYURYWALLIS/FORTUNA ISLANDSWFWLFDEMOCRATIC YEMENYDYMDZAIREZRZARCANADACACANTHAILANDTHTHA附录2 美国州名两字码州名二字代码AlabamaALAlaskaAKAriz