API用户手册模板.doc

用户手册
第一章 序言
1.1 背景：
目前采取APIS基于US EDIFACT，不能包含全部UN EDIFACT要求数据元素，所以美国、加拿大要求航空企业于近日采取基于UN EDIFACT标准PAXLST。
和现在API信息相比，美国PAXLST增加信息有：居住国、美国地址（美国公民或持美国居住卡除外）、护照到期日期，加拿大PAXLST增加信息：居住国、护照到期日期。PAXLST通常全部只要求一个有效证件信息，最多不超出两种，首选护照信息，每个旅客包含婴儿全部必需持有最少一个有效证件。
1.2 现实状况：
目前订座系统有SSR PSPT内容，不包含DOCS、DOCO、DOCA，不能提供美国/加拿大PAXLST所需增加信息。
1.3 需求：
1. 增加三种SSR TYPE：DOCS、DOCO、DOCA
2. 许可用户经过DPS方法和手工输入SSR指令方法输入PAXLST信息
3. 接收处理TYPE-A、TYPE-BSSR DOCS/DOCO/DOCA报文
4. 对国航飞美国/加拿大航班进行出票限制，必需满足：
a) 飞往美国航班，出票之前PNR中必需输入SSR DOCS项和SSR DOCA R/（居住地址）和SSR DOCA D/（目标地地址）三项内容；
b) 美国出港航班和飞往加拿大航班，出票之前PNR中必需输入SSR DOCS信息。

第二章 指令说明
2.1 DPS输入
2.1.1 指令功效
DAPI是为了方便用户向PNR中添加API信息（即SSR DOCS，DOCO，和DOCA）而设计。它会自动将目前PNR中相关信息如姓名项等显示在DPS屏幕上，用户能够经过填写DPS中相关项中内容来完成API信息添加。现在DAPI指令不提供回显功效，提议用户使用手工方法进行修改。
2.1.2 指令格式
输入格式：
1 2 3 4
>DAPI:Pn,In
域
字符
可选
描述
1.
DAPI:
否
指令名称
2.
P1-3n
否
P旅客标识
3.
,I1n
是
I 婴儿标识

DPS屏幕：
更新DPS屏幕中内容，能够自动结构目前PNR中SSR (DOCS，DOCO，和DOCA)项。

34567890
1
>UAPI:Pn,In *** All Dates in DDMMMYY Format *** 
2
SSR DOCS – PRIMARY TRAVEL DOCUMENT INFORMATION
3
Surname: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa Gender(M/F/U): a Infant(Y/N): a
姓 性别 是否是婴儿
4
First Name: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa Date of Birth: DDMMMYY
名 出生日期
5
Middle Name: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa Nationality: aaa
中间名 国籍
6
Document Type: aa Document Number: xxxxxxxxxxxxxxx Issuing Country/State: aaa
证件类型 证件号码 证件签发国家或地域
7
Expiry Date: DDMMMYY Multi-Passenger Primary Passport Holder(Y/N): a
使用期限 否证件持有者
8

9
SSR DOCO – OTHER TRAVEL RELATED INFORMATION
10
Place of Birth: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
出生地
11
Document Type: a Document Number: xxxxxxxxxxxxxxx
类型（现在只有VISA,V） VISA卡号
12
Place of Issue: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa Issue Date: DDMMMYY
VISA卡签发地 签发日期
13
Country/State applies: aaa
VISA卡使用有效国家或地域代码
14

15
SSR DOCA – ADDRESS INFORMATION
16
Residence Address: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
居住具体地址
17
City: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa Postal Code: xxxxxxxxxxxxxxxxx
居住城市 邮编
18
State/Province/Country Sub: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx Country: aaa
所在省市（州）信息 居住国
19
Destination Address: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
目标地具体地址
20
City: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa Postal Code: xxxxxxxxxxxxxxxxx
目标地城市 邮编
21
State/Province/Country Sub: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx Country: aaa
目标地所在省市（州）信息 目标地国家代码
22

23
TRANSMIT FROM HERE _ F3 - CANCEL F4 - REFRESH
在此确定所作更新 F3键取消修改 F4键刷新
24

第1行
UAPI: 指令输入行。这行是不能够修改。
1 2 3 5
-UAPI:Pn,In *** All Dates in DDMMMYY Format ***
域
字符
可选
描述
1.
UAPI:
保护
指令名称
2.
P1-3n
保护
P旅客标识
3.
,I1n
保护
I 婴儿标识
4.

保护
全部日期均按DDMMMYY 这种格式
第2行
1
SSR DOCS – PRIMARY TRAVEL DOCUMENT INFORMATION
域
字符
可选
描述
1.

保护
SSR DOCS – 首要信息
第3行
1 2 3
Surname: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa Gender(M/F/U): a Infant(Y/N): a
域
字符
可选
描述
1.

保护
姓:

1-30a
否
姓会自动按用户指定旅客序号从目前PNR中取得。
假如PNR中姓名和证件姓名不一样，需以证件姓名为准。
2.

保护
性别(M/F/U):

1a
否
正当性别：
M 男 F 女 U unspecified
3.

保护
婴儿(Y/N):

1a
否
标识该名旅客是否是婴儿。正当输入：
Y 该名旅客是婴儿
N 该名旅客不是婴儿;缺省

第4行
1 2
First Name: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa Date of Birth: DDMMMYY
域
字符
可选
描述
1.

保护
名:

1-30a
否
名会自动按用户制订旅客序号从目前PNR中取得。
假如PNR中姓名和证件姓名不一样，需以证件姓名为准。
2.

保护
出生日期:

DDYYYMM
否
出生日期
第5行
1 2
Middle Name: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa Nationality: xxx
域
字符
可选
描述
1.

保护
中间名:

1-30a
是
中间名
2.

保护
国籍:

1-3a
否
国家代码
第 6 行
1 2 3
Document Type: aa Document Number: xxxxxxxxxxxxxxx Issuing Country/State: aaa
域
字符
可选
描述
1

保护
证件类型:

1-2a
否
正当证件类型:
F Approved non-standard identity document for travel (defined by issuing Country/State)
AC Crew Member Certificate A Identity Card (defined by issuing Country/State) C Identity Card (defined by issuing Country/State) I Identity Card (defined by issuing Country/State) IP Passport Card P Passenger Passport

2.

保护
证件号码:

1-15x
否
证件号码。
3.

保护
签发国家:

1-3a
否
签发国家。
第 7 行
1 2
Expiry Date: YYMMDD Primary Passport Holder(Y/N): a
域
字符
可选
描述
1.

保护
过期日:

YYMMDD
否
证件过期日
2.

保护
多人护照主持有者 (Y/N):

1a
M
标识，正当输入有：
Y 为主持有者
N 非主持有者 (如婴儿)
第8行
空行
第9行
1
SSR DOCO – OTHER TRAVEL RELATED INFORMATION
域
字符
可选
描述
1.

保护
SSR DOCO – 其它旅行相关信息
第10行
1
Place of Birth: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
域
字符
可选
描述
1.

保护
出生地:

1-35a
是
出生地址
第 11 行
1 2
Document Type: a Document Number: xxxxxxxxxxxxxxx
域
字符
可选
描述
1.

保护
证件类型

1a
条件
证件类型
V 假如为VISA信息话，必需输入V
2.

保护
证件号码:

1-15x
条件
证件号码。 假如为VISA话，此项为必输项.
第 12 行
1 2
Place of Issue: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa Issue Date: DDMMMYY
1.

保护
签发地:

1-35a
选择
签发地. 假如为VISA话，此项为必输项。
2.

保护
签发日期:

DDMMMYY
选择
签发日期. 假如为VISA话，此项为必输项.

第 13 行
1
Country/State applies: aaa
域
字符
可选
描述
1.

保护
适用国:

1-3a
选择
适用国. 假如为VISA话，此项为必输项.
第14 行
空行
第15 行
1
SSR DOCA – ADDRESS INFORMATION
域
字符
可选
描述
1.

保护
SSR DOCA – 地址信息
第16行
1
Residence Address: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
域
字符
可选
描述
1.

保护
居住地址：

1-35x
是
居住街道具体信息
第17行
1 2
City: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa Postal Code: xxxxxxxxxxxxxxxxx
域
字符
可选
描述
1.

保护
城市:

1-35a
否
居住城市
2.

保护
邮编

1-17x
是
居住地邮政编码
第18行
1 2
State/Province/Country Sub: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa Country: aaa
域
字符
可选
描述
1.

保护
州/省/市/县:

1-35a
是
居住地所在州/省/市/县.
2.

保护
国家

1-3a
否
居住地国家代码.
第19行
1
Destination Address: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
域
字符
可选
描述
1.

保护
目标地

1-35x
是
目标地街道具体地址
第20行
1 2
City: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa Postal Code: xxxxxxxxxxxxxxxxx
域
字符
可选
描述
1.

保护
城市:

1-35a
M
目标地城市
2.

保护
邮编:

1-17x
是
邮政编码.
第21行
1 2
State/Province/Country Sub: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa Country: aaa
域
字符
可选
描述
1.

保护
州/省/市/县:

1-35a
是
目标地所在州/省/市/县.
2.

保护
国家

1-3a
否
目标地国家代码.
第 22 行
空行
第 23 行
1 2
TRANSMIT FROM HERE _ F3 - CANCEL F4 - REFRESH
域
字符
可选
描述
1.
[b] 
保护
条件
在此处回车
确定域. 将光标移至此处后，回车将确定修改。
2.

保护
F3 – 取消 F4 – 刷新
标准DPS屏幕功效键.
第 24 行
空行
2.1.3 实例:
旅客张大龙带着一名婴儿张小龙，持例以下护照旅行。旅客居住地址：中国北京东四西大街100号，邮编100027，带着一名婴儿。前往佐治亚州GEORGIA（GA）亚特兰大ATLANDA（ATL）No. 17, STREET2：
照片
P
CHN

姓 名 Name in full
张 大 龙
ZHANG DALONG
性 别 Sex
男
M
身 份 Profession
企 业 管 理 人 员
MANAGER
婚姻情况 Marital status
未 婚
SINGLE
出生日期 Date of birth
1976.04.24
24 APR 1967
出生地点 Place of birth
北 京
BEIJING
使用期至 Date of expiry
.04.23
身份证号码 Identity card No.
373
POCHNZHANG<<DALONG<<<<<<<<<<<<<<<<<<<<<<<<<<
CHN6704241M100<<<<<<06
注：假如出现扫描区信息和护照上其它信息冲突时候一定以扫描区内容为准。

PNR：
1.ZHANG/DALONG DNRT4
2. CA981 Y TU13SEP PEKJFK HK1 1300 1430
3. DL175 Y TU13SEP JFKATL HN1 1720
4.C
5.T
6.SSR OTHS CA TKTL ADV TKT NBR TO CA BY 11SEP05/1514/PEK TIM/OR NO ALL SG/BCS
CA 981 /Y/13SEP/PEKJFK
7.OSI YY 1INF ZHANG/XIAOLONG/P1
8.XN/IN/ZHANG/XIAOLONG(DEC04)/P1
9.PEK099

输入：
>DAPI:P1

UAPI: P1 *** All Dates in DDMMMYY Format ***
SSR DOCS - PRIMARY TRAVEL DOCUMENT INFORMATION
Surname:ZHANG_________________________ Gender(M/F/U):M Infant(Y/N): N
First Name:DALONG________________________ Date of Birth:24APR67
Middle Name:______________________________ Nationality:CHN
Document Type:P_ Document Number:______ Issuing Country/State:CHN
Expiry Date:23APR02 Multi-Passenger Primary Passport Holder(Y/N):Y

SSR DOCO - OTHER TRAVEL RELATED INFORMATION
Place of Birth:___________________________________
Document Type:_ Document Number:_______________
Place of Issue:___________________________________ Issue Date:_______
Country/State applies:___

SSR DOCA - ADDRESS INFORMATION
Residence Address:NO_100_DONGSI_WEST_STREET__________
City:BEIJING____________________________ Postal Code:100027___________
State/Province/Country Sub:___________________________________ Country:CHN
Destination Address:NO_17_STREET2____________________
City:ATLANDA____________________________ Postal Code:1234567__________
State/Province/Country Sub:GA_________________________________ Country:USA

TRANSMIT FROM HERE_ F3 - CANCEL F4 - REFRESH 
按上例填写完对应内容后，PNR 输出以下：
1.ZHANG/DALONG DNRT4
2. CA981 Y TU13SEP PEKJFK HK1 1300 1430
3. DL175 Y TU13SEP JFKATL HN1 1720
4.C
5.T
6.SSR OTHS CA TKTL ADV TKT NBR TO CA BY 11SEP05/1514/PEK TIM/OR NO ALL SG/BCS
CA 981 /Y/13SEP/PEKJFK
7.SSR DOCS CA HK1 P/CHN//CHN/24APR67/M/23APR02/ZHANG/DALONG//H/P1
8.SSR DOCA CA HK1 D/USA/NO 17 STREET2/ATLANDA/GA/1234567//P1
9.SSR DOCA CA HK1 R/CHN/NO 100 DONGSI WEST STREET/BEIJING//100027//P1
10.OSI YY 1INF ZHANG/XIAOLONG/P1
11.XN/IN/ZHANG/XIAOLONG(DEC04)/P1
12.PEK099
再次输入婴儿相关信息：
>DAPI:P1,I1

UAPI: P1,I1 *** All Dates in DDMMMYY Format ***
SSR DOCS - PRIMARY TRAVEL DOCUMENT INFORMATION
Surname:ZHANG_________________________ Gender(M/F/U):M Infant(Y/N): Y
First Name:XIAOLONG______________________ Date of Birth:10DEC04
Middle Name:______________________________ Nationality:CHN
Document Type:P_ Document Number:______ Issuing Country/State:CHN
Expiry Date:23APR02 Multi-Passenger Primary Passport Holder(Y/N):N

SSR DOCO - OTHER TRAVEL RELATED INFORMATION
Place of Birth:___________________________________
Document Type:_ Document Number:_______________
Place of Issue:___________________________________ Issue Date:_______
Country/State applies:___

SSR DOCA - ADDRESS INFORMATION
Residence Address:NO_100_DONGSI_WEST_STREET__________
City:BEIJING____________________________ Postal Code:100027___________
State/Province/Country Sub:___________________________________ Country:CHN
Destination Address:NO_17_STREET2______________________
City:ATLANDA____________________________ Postal Code:_________________
State/Province/Country Sub:GA_________________________________ Country:USA

TRANSMIT FROM HERE_ F3 - CANCEL F4 - REFRESH
按上例填写完对应内容后，PNR 输出以下：
1.ZHANG/DALONG DNRT4
2. CA981 Y TU13SEP PEKJFK HK1 1300 1430
3. DL175 Y TU13SEP JFKATL HN1 1720
4.C
5.T
6.SSR OTHS CA TKTL ADV TKT NBR TO CA BY 11SEP05/1514/PEK TIM/OR NO ALL SG/BCS
CA 981 /Y/13SEP/PEKJFK