接口规范及填写说明
《中医重点专科住院病案首页监测直报系统》
接口规范文档（适用于新版4-1）
序号字段名字段含义部分字段说明
1 USERNAME 机构名称
2 YLFKFS 医疗付款方式《医疗付款方式字典》
3 JKKH 健康卡号
4 ZYCS 住院次数
5 BAH 病案号
6 XM 姓名
7 XB 性别《性别字典》
8 CSRQ 出生日期
9 NL 年龄
10 GJ 国籍《国籍字典》
11 BZYZSNL (年龄不足1周岁的)年龄(月)
12 XSECSTZ 新生儿出生体重(克)
13 XSERYTZ 新生儿入院体重(克）
14 CSD 出生地
15 GG 籍贯
16 MZ 民族《民族字典》
17 SFZH 身份证号
18 ZY 职业《职业字典》
19 HY 婚姻《婚姻字典》
20 XZZ 现住址
21 DH 电话
22 YB1 邮编
23 HKDZ 户口地址
24 YB2 邮编
25 GZDWJDZ 工作单位及地址
26 DWDH 单位电话
27 YB3 邮编
28 LXRXM 联系人姓名
29 GX 关系《联系人关系字典》
30 DZ 地址
31 DH2 电话
32 RYTJ 入院途径《入院途径字典》
33 RYSJ 入院时间
34 RYSJS 时
35 RYKB 入院科别《科室字典》
36 RYBF 入院病房
37 ZKKB 转科科别《科室字典》
38 CYSJ 出院时间
39 CYSJS 时
40 CYKB 出院科别《科室字典》
41 CYBF 出院病房
42 SJZYTS 实际住院(天)
43 MZZD 门(急)诊诊断
44 JBBM 疾病编码
45 ZYZD 主要诊断
46 JBDM 疾病编码
47 RYBQ 入院病情《入院病情字典》
48 QTZD8 其他诊断
49 JBDM8 疾病编码
50 RYBQ8 入院病情《入院病情字典》
51 QTZD1 其他诊断
52 JBDM1 疾病编码
53 RYBQ1 入院病情《入院病情字典》
54 QTZD9 其他诊断
55 JBDM9 疾病编码
56 RYBQ9 入院病情《入院病情字典》
57 QTZD2 其他诊断
58 JBDM2 疾病编码
59 RYBQ2 入院病情《入院病情字典》
60 QTZD10 其他诊断
61 JBDM10 疾病编码
62 RYBQ10 入院病情《入院病情字典》
63 QTZD3 其他诊断
64 JBDM3 疾病编码
65 RYBQ3 入院病情《入院病情字典》
66 QTZD11 其他诊断
67 JBDM11 疾病编码
68 RYBQ11 入院病情《入院病情字典》
69 QTZD4 其他诊断
70 JBDM4 疾病编码
71 RYBQ4 入院病情《入院病情字典》
72 QTZD12 其他诊断
73 JBDM12 疾病编码
74 RYBQ12 入院病情《入院病情字典》
75 QTZD5 其他诊断
76 JBDM5 疾病编码
77 RYBQ5 入院病情《入院病情字典》
78 QTZD13 其他诊断
79 JBDM13 疾病编码
80 RYBQ13 入院病情《入院病情字典》
81 QTZD6 其他诊断
82 JBDM6 疾病编码
83 RYBQ6 入院病情《入院病情字典》
84 QTZD14 其他诊断
85 JBDM14 疾病编码
86 RYBQ14 入院病情《入院病情字典》
87 QTZD7 其他诊断
88 JBDM7 疾病编码
89 RYBQ7 入院病情《入院病情字典》
90 QTZD15 其他诊断
91 JBDM15 疾病编码
92 RYBQ15 入院病情《入院病情字典》
93 WBYY 中毒的外部原因
94 H23 疾病编码
95 BLZD 病理诊断出
96 JBMM 疾病编码
97 BLH 病理号
98 YWGM 药物过敏《有无字典》
99 GMYW 过敏药物疾病
100 SWHZSJ 死亡患者尸检《是否字典》
101 XX 血型《血型字典》
102 RH Rh 《RH字典》
103 KZR 科主任
104 ZRYS 主任（副主任）医师
105 ZZYS 主治医师病理号死亡患者尸检
106 ZYYS 住院医师出院情况入院病情
107 ZRHS 责任护士
108 JXYS 进修医师住
109 SXYS 实习医师
110 BMY 编码员
111 BAZL 病案质量
112 ZKYS 质控医师
113 ZKHS 质控护士
114 ZKRQ 质控日期
115 SSJCZBM1 手术及操作编码
116 SSJCZRQ1 手术及操作日期
117 SSJB1 手术级别《手术级别字典》
118 SSJCZMC1 手术及操作名称
119 SZ1 术者
120 YZ1 I助
121 EZ1 II助
122 QKDJ1 切口等级《切口等级字典》
123 QKYHLB1 切口愈合类别《切口愈合类别字典》124 MZFS1 麻醉方式《麻醉方式字典》
125 MZYS1 麻醉医师
126 SSJCZBM2 手术及操作编码
127 SSJCZRQ2 手术及操作日期
128 SSJB2 手术级别《手术级别字典》
129 SSJCZMC2 手术及操作名称
130 SZ2 术者
131 YZ2 I助
132 EZ2 II助
133 QKDJ2 切口等级《切口等级字典》
134 QKYHLB2 切口愈合类别《切口愈合类别字典》135 MZFS2 麻醉方式《麻醉方式字典》
136 MZYS2 麻醉医师
137 SSJCZBM3 手术及操作编码
138 SSJCZRQ3 手术及操作日期
139 SSJB3 手术级别《手术级别字典》
140 SSJCZMC3 手术及操作名称
141 SZ3 术者
142 YZ3 I助
143 EZ3 II助
144 QKDJ3 切口等级《切口等级字典》
145 QKYHLB3 切口愈合类别《切口愈合类别字典》146 MZFS3 麻醉方式《麻醉方式字典》
147 MZYS3 麻醉医师
148 SSJCZBM4 手术及操作编码
149 SSJCZRQ4 手术及操作日期
150 SSJB4 手术级别《手术级别字典》
151 SSJCZMC4 手术及操作名称
152 SZ4 术者
153 YZ4 I助
154 EZ4 II助
155 QKDJ4 切口等级《切口等级字典》
156 QKYHLB4 切口愈合类别《切口愈合类别字典》157 MZFS4 麻醉方式《麻醉方式字典》
158 MZYS4 情况麻醉医师
159 SSJCZBM5 手术及操作编码
160 SSJCZRQ5 手术及操作日期
161 SSJB5 手术级别《手术级别字典》
162 SSJCZMC5 手术及操作名称
163 SZ5 术者
164 YZ5 I助
165 EZ5 II助
166 QKDJ5 切口等级《切口等级字典》
167 QKYHLB5 切口愈合类别《切口愈合类别字典》168 MZFS5 麻醉方式《麻醉方式字典》
169 MZYS5 麻醉医师
170 SSJCZBM6 手术及操作编码
171 SSJCZRQ6 手术及操作日期
172 SSJB6 手术级别《手术级别字典》
173 SSJCZMC6 手术及操作名称
174 SZ6 术者
175 YZ6 I助
176 EZ6 II助
177 QKDJ6 切口等级《切口等级字典》
178 QKYHLB6 切口愈合类别《切口愈合类别字典》179 MZFS6 麻醉方式《麻醉方式字典》
180 MZYS6 麻醉医师
181 SSJCZBM7 手术及操作编码
182 SSJCZRQ7 手术及操作日期
183 SSJB7 手术级别《手术级别字典》
184 SSJCZMC7 手术及操作名称
185 SZ7 术者
186 YZ7 I助
187 EZ7 II助
188 QKDJ7 切口等级《切口等级字典》
189 QKYHLB7 切口愈合类别《切口愈合类别字典》
190 MZFS7 麻醉方式《麻醉方式字典》191 MZYS7 麻醉医师
192 LYFS 离院方式《离院方式字典》193 YZZY_YLJG 医嘱转院，拟接收医疗机构名称
194 WSY_YLJG 医嘱转社区卫生服务机构/乡镇卫生院，拟接收医疗机构名称
195 SFZZYJH 是否有出院31天内再住院计划手术情
况
《是否字典》
196 MD 目的
197 RYQ_T 颅脑损伤患者昏迷入院前时间
198 RYQ_XS 天
199 RYQ_F 小时
200 RYH_T 颅脑损伤患者昏迷入院后时间
201 RYH_XS 天
202 RYH_F 小时
203 ZFY 住院费用(元)：总费用
204 ZFJE 自付金额
205 YLFUF 综合医疗服务类：(1)一般医疗服务费206 ZLCZF 一般治疗操作费
207 HLF 护理费住院费
208 QTFY 其他费用
209 BLZDF 诊断类：(5)病理诊断费
210 SYSZDF 实验室诊断费
211 YXXZDF 影像学诊断费
212 LCZDXMF 临床诊断项目费
213 FSSZLXMF 治疗类：(9)非手术治疗项目费
214 WLZLF 临床物理治疗费
215 SSZLF 手术治疗费
216 MAF 麻醉费
217 SSF 手术费
218 KFF 康复类：(11)康复费
219 ZYZLF 中医类:(12)中医治疗费
220 XYF 西药类:(13)西药费
221 KJYWF 抗菌药物费
222 ZCYF 中药类:(14)中成药费
223 ZCYF1 中草药费
224 XF 血液和血液制品类:(16)血费
225 BDBLZPF 白蛋白类制品费
226 QDBLZPF 球蛋白类制品费
227 NXYZLZPF 凝血因子类制品费
228 XBYZLZPF 细胞因子类制品费
229 HCYYCLF 耗材类:(21)检查用一次性医用材料费
230 YYCLF 23治疗用一次性医用材料费
231 YCXYYCLF 手术用一次性医用材料费
232 QTF 其他类：(24)其他费
部分字段填写说明:
（一）“医疗机构”指患者住院诊疗所在的医疗机构名称，按照《医疗机构执业许可证》登记的机构名称填写。由系统所登陆用户自动设置。
（二）健康卡号：在已统一发放“中华人民共和国居民健康卡”的地区填写健康卡号码，尚未发放“健康卡”的地区填写“就医卡号”等患者识别码或暂不填写。
（三）“第N次住院”指患者在本医疗机构住院诊治的次数。
（四）病案号：指本医疗机构为患者住院病案设置的唯一性编码。原则上，同一患者在同一医疗机构多次住院应当使用同一病案号。
（五）年龄：指患者的实足年龄，为患者出生后按照日历计算的历法年龄。年龄满1周岁的，以实足年龄的相应整数填写；年龄不足1周岁的，按照实足年龄的月龄填写，以分数形式表示：分数的整数部分代表实足月龄，分数部分分母为30，分子为不足1个月的天数，如“15/30”代表患儿实足年龄为15天。
（六）从出生到28天为新生儿期。出生日为第0天。产妇病历应当填写“新生儿出生体重”；新生儿期住院的患儿应当填写“新生儿出生体重”、“新生儿入院体重”。新生儿出生体重指患儿出生后第一小时内第
一次称得的重量，要求精确到10克；新生儿入院体重指患儿入院时称得的重量，要求精确到10克。例如：4560g，直接填报4560。
（七）出生地：指患者出生时所在地点。
（八）籍贯：指患者祖居地或原籍。
（九）身份证号：除无身份证号或因其他特殊原因无法采集者外，住院患者入院时要如实填写18位身份证号。
（十）现住址：指患者来院前近期的常住地址。
（十一）户口地址：指患者户籍登记所在地址，按户口所在地填写。
（十二）工作单位及地址：指患者在就诊前的工作单位及地址。
（十三）入院途径：指患者收治入院治疗的来源，经由本院急诊、门诊诊疗后入院，或经由其他医疗机构诊治后转诊入院，或其他途径入院。
（十四）转科科别：下拉选择。
（十五）实际住院天数：入院日与出院日只计算一天，例如：2011年6月12日入院，2011年6月15日出院，计住院天数为3天。
（十六）门（急）诊诊断：指患者在住院前，由门（急）诊接诊医师在住院证上填写的门（急）诊诊断。
（十七）出院诊断：指患者出院时，临床医师根据患者所做的各项检查、治疗、转归以及门急诊诊断、手术情况、病理诊断等综合分析得出的最终诊断。
1.主要诊断：指患者出院过程中对身体健康危害最大，花费医疗资源最多，住院时间最长的疾病诊断。外科的主要诊断指患者住院接受手术进行治疗的疾病；产科的主要诊断指产科的主要并发症或伴随疾病。
2.其他诊断：除主要诊断及医院感染名称（诊断）外的其他诊断，包括并发症和合并症。
（十八）入院病情：指对患者入院时病情评估情况。将“出院诊断”与入院病情进行比较，按照“出院诊断”在患者入院时是否已具有，分为：1.有；2.临床未确定；3.情况不明；4.无。根据患者具体情况，在每一出院诊断后填写相应的阿拉伯数字。
1.有：对应本出院诊断在入院时就已明确。例如，患者因“乳腺癌”入院治疗，入院前已经钼靶、针吸细胞学检查明确诊断为“乳腺癌”，术后经病理亦诊断为乳腺癌。
2.临床未确定：对应本出院诊断在入院时临床未确定，或入院时该诊断为可疑诊断。例如：患者因“乳腺恶性肿瘤不除外”、“乳腺癌？”或“乳腺肿物”入院治疗，因确少病理结果，肿物性质未确定，出院时有病理诊断明确为乳腺癌或乳腺纤维瘤。
3.情况不明：对应本出院诊断在入院时情况不明。例如：乙型病毒性肝炎的窗口期、社区获得性肺炎的潜伏期，因患者入院时处于窗口期或潜伏期，故入院时未能考虑此诊断或主观上未能明确此诊断。
4.无：在住院期间新发生的，入院时明确无对应本出院诊断的诊断条目。例如：患者出现围术期心肌梗死。
（十九）损伤、中毒的外部原因：指造成损伤的外部原因及引起中毒的物质，如：意外触电、房屋着火、公路上汽车翻车、误服农药。不可以笼统填写车祸、外伤等。应当填写损伤、中毒的标准编码。
（二十）病理诊断：指各种活检、细胞学检查及尸检的诊断，包括术
中冰冻的病理结果。病理号：填写病理标本编号。
（二十一）药物过敏：指患者在本次住院治疗以及既往就诊过程中，明确的药物过敏史，并填写引发过敏反应的具体药物，如：青霉素。
（二十二）死亡患者尸检：指对死亡患者的机体进行剖验，以明确死亡原因。非死亡患者应当在“□”内填写“-”。
（二十三）血型：指在本次住院期间进行血型检查明确，或既往病历资料能够明确的患者血型。根据患者实际情况填写相应的阿拉伯数字：1.A；2.B；3.O；4.AB；5.不详；6.未查。如果患者无既往血型资料，本次住院也未进行血型检查，则按照“6.未查”填写。“Rh”根据患者血型检查结果填写。
（二十四）签名。
1.医师签名要能体现三级医师负责制。三级医师指住院医师、主治医师和具有副主任医师以上专业技术职务任职资格的医师。在三级医院中，病案首页中“科主任”栏签名可以由病区负责医师代签，其他级别的医院必须由科主任亲自签名，如有特殊情况，可以指定主管病区的负责医师代签。
2.责任护士：指在已开展责任制护理的科室，负责本患者整体护理的责任护士。
3.编码员：指负责病案编目的分类人员。
4.质控医师：指对病案终末质量进行检查的医师。
5.质控护士：指对病案终末质量进行检查的护士。
6.质控日期：由质控医师填写。
（二十九）手术及操作编码：目前按照全国统一的ICD-9-CM-3编码执行。表格中第一行应当填写本次住院的主要手术和操作编码。
（三十）手术级别：指按照《医疗技术临床应用管理办法》（卫医政发…2009?18号）要求，建立手术分级管理制度。根据风险性和难易程度不同，手术分为四级，填写相应手术级别对应的阿拉伯数字：
1.一级手术（代码为1）：指风险较低、过程简单、技术难度低的普通手术；
2.二级手术（代码为2）：指有一定风险、过程复杂程度一般、有一定技术难度的手术；
3.三级手术（代码为3）：指风险较高、过程较复杂、难度较大的手术；
4.四级手术（代码为4）：指风险高、过程复杂、难度大的重大手术。
（二十五）手术及操作名称：指手术及非手术操作（包括诊断及治疗性操作，如介入操作）名称。表格中第一行应当填写本次住院的主要手术和操作名称。
（二十六）切口愈合等级，按以下要求填写：
切口分组切口等级/愈合类别内涵
0类切口有手术，但体表无切口或腔镜手术切口
Ⅰ类切口Ⅰ/甲无菌切口/切口愈合良好
Ⅰ/乙无菌切口/切口愈合欠佳
Ⅰ/丙无菌切口/切口化脓
Ⅰ/其他无菌切口/出院时切口愈合情况不确定
Ⅱ类切口Ⅱ/甲沾染切口/切口愈合良好Ⅱ/乙沾染切口/切口愈合欠佳
1.0类切口：指经人体
自然腔道进行的手术以及经皮腔镜手术，如经胃腹腔镜手术、经脐单孔腹腔镜手术等。
2.愈合等级“其他”：指出院时切口未达到拆线时间，切口未拆线或无需拆线，愈合情况尚未明确的状态。
（二十七）麻醉方式：指为患者进行手术、操作时使用的麻醉方法，如全麻、局麻、硬膜外麻等。
（二十八）离院方式：指患者本次住院出院的方式，填写相应的阿拉伯数字。主要包括：
1.医嘱离院（代码为1）：指患者本次治疗结束后，按照医嘱要求出院，回到住地进一步康复等情况。
2.医嘱转院（代码为2）：指医疗机构根据诊疗需要，将患者转往相应医疗机构进一步诊治，用于统计“双向转诊”开展情况。如果接收患者的医疗机构明确，需要填写转入医疗机构的名称。
3.医嘱转社区卫生服务机构/乡镇卫生院（代码为3）：指医疗机构根据患者诊疗情况，将患者转往相应社区卫生服务机构进一步诊疗、康复，用于统计“双向转诊”开展情况。如果接收患者的社区卫生服务机构明确，需要填写社区卫生服务机构/乡镇卫生院名称。
4.非医嘱离院（代码为4）：指患者未按照医嘱要求而自动离院，如：
Ⅱ/丙 沾染切口/切口化脓 Ⅱ/其他 沾染切口/出院时切口愈合情况不确定
Ⅲ类切口
Ⅲ/甲 感染切口/切口愈合良好
Ⅲ/乙
感染切口/切口欠佳 Ⅲ/丙 感染切口/切口化脓
Ⅲ/其他 感染切口/出院时切口愈合情况不确定
患者疾病需要住院治疗，但患者出于个人原因要求出院，此种出院并非由医务人员根据患者病情决定，属于非医嘱离院。
5.死亡（代码为5）。指患者在住院期间死亡。
6.其他（代码为9）：指除上述5种出院去向之外的其他情况。
（二十九）是否有出院31天内再住院计划：指患者本次住院出院后31天内是否有诊疗需要的再住院安排。如果有再住院计划，则需要填写目的，如：进行二次手术。
（三十）颅脑损伤患者昏迷时间：指颅脑损伤的患者昏迷的时间合计，按照入院前、入院后分别统计，间断昏迷的填写各段昏迷时间的总和。只有颅脑损伤的患者需要填写昏迷时间。
（三十一）住院费用：总费用指患者住院期间发生的与诊疗有关的所有费用之和，凡可由医院信息系统提供住院费用清单的，住院病案首页中可不填写。已实现城镇职工、城镇居民基本医疗保险或新农合即时结报的地区，应当填写“自付金额”。
住院费用共包括以下10个费用类型：
1.综合医疗服务类：各科室共同使用的医疗服务项目发生的费用。
（1）一般医疗服务费：包括诊查费、床位费、会诊费、营养咨询等费用。
（2）一般治疗操作费：包括注射、清创、换药、导尿、吸氧、抢救、重症监护等费用。
（3）护理费：患者住院期间等级护理费用及专项护理费用。
（4）其他费用：病房取暖费、病房空调费、救护车使用费、尸体料
理费等。
2.诊断类：用于诊断的医疗服务项目发生的费用
（1）病理诊断费：患者住院期间进行病理学有关检查项目费用。
（2）实验室诊断费：患者住院期间进行各项实验室检验费用。
（3）影像学诊断费：患者住院期间进行透视、造影、CT、磁共振检查、B超检查、核素扫描、PET等影像学检查费用。
（4）临床诊断项目费：临床科室开展的其他用于诊断的各种检查项目费用。包括有关内镜检查、肛门指诊、视力检测等项目费用。
3.治疗类：
（1）非手术治疗项目费：临床利用无创手段进行治疗的项目产生的费用。包括高压氧舱、血液净化、精神治疗、临床物理治疗等。临床物理治疗指临床利用光、电、热等外界物理因素进行治疗的项目产生的费用，如放射治疗、放射性核素治疗、聚焦超声治疗等项目产生的费用。
（2）手术治疗费：临床利用有创手段进行治疗的项目产生的费用。包括麻醉费及各种介入、孕产、手术治疗等费用。
4.康复类：对患者进行康复治疗产生的费用。包括康复评定和治疗。
5.中医类：利用中医手段进行治疗产生的费用。
6.西药类：包括有机化学药品、无机化学药品和生物制品费用。
（1）西药费：患者住院期间使用西药所产生的费用。
（2）抗菌药物费用：患者住院期间使用抗菌药物所产生的费用，包含于“西药费”中。
7.中药类：包括中成药和中草药费用。
（1）中成药费：患者住院期间使用中成药所产生的费用。中成药是以中草药为原料，经制剂加工制成各种不同剂型的中药制品。
（2）中草药费：患者住院期间使用中草药所产生的费用。中草药主要由植物药（根、茎、叶、果）、动物药（内脏、皮、骨、器官等）和矿物药组成。
8.血液和血液制品类：
（1）血费：患者住院期间使用临床用血所产生的费用，包括输注全血、红细胞、血小板、白细胞、血浆的费用。医疗机构对患者临床用血的收费包括血站供应价格、配血费和储血费。
（2）白蛋白类制品费：患者住院期间使用白蛋白的费用。
（3）球蛋白类制品费：患者住院期间使用球蛋白的费用。
（4）凝血因子类制品费：患者住院期间使用凝血因子的费用。
（5）细胞因子类制品费：患者住院期间使用细胞因子的费用。
9.耗材类：当地卫生、物价管理部门允许单独收费的耗材。按照医疗服务项目所属类别对一次性医用耗材进行分类。“诊断类”操作项目中使用的耗材均归入“检查用一次性医用材料费”；除“手术治疗”外的其他治疗和康复项目（包括“非手术治疗”、“临床物理治疗”、“康复”、“中医治疗”）中使用的耗材均列入“治疗用一次性医用材料费”；“手术治疗”操作项目中使用的耗材均归入“手术用一次性医用材料费”。
（1）检查用一次性医用材料费：患者住院期间检查检验所使用的一次性医用材料费用。
（2）治疗用一次性医用材料费：患者住院期间治疗所使用的一次性
医用材料费用。
（3）手术用一次性医用材料费：患者住院期间进行手术、介入操作时所使用的一次性医用材料费用。
10.其他类：
其他费：患者住院期间未能归入以上各类的费用总和。
新版字典:
医疗付款方式字典
代码名称
01 城镇职工基本医疗保险
02 城镇居民基本医疗保险
03 新型农村合作医疗
04 贫困救助
05 商业医疗保险
06 全公费
07 全自费
08 其他社会保险
99 其他
性别字典
代码名称
0 未知的性别
1 男
2 女
9 未说明的性别
国籍字典
代码名称
ABW 阿鲁巴
AFG 阿富汗
AGO 安哥拉
AIA 安圭拉
ALB 阿尔巴尼亚
AND 安道尔
ANT 荷属安的列斯
ARE 阿联酋
ARG 阿根廷
ARM 亚美尼亚
ASM 美属萨摩亚
ATA 南极洲
ATF 法属南部领土
ATG 安提瓜和巴布达
AUS 澳大利亚
AUT 奥地利
AZE 阿塞拜疆
BDI 布隆迪
BEL 比利时
BEN 贝宁
BFA 布基纳法索
BGD 孟加拉国
BGR 保加利亚
BHR 巴林
BHS 巴哈马
BIH 波斯尼亚和黑塞哥维那BLR 白俄罗斯
BLZ 伯利兹
BMU 百幕大
BOL 玻利维亚
BRA 巴西
BRB 巴巴多斯
BRN 文莱
BTN 不丹
BVT 布维岛
BWA 博茨瓦纳
CAF 中非
CAN 加拿大
CCK 科科斯群岛
CHE 瑞士
CHL 智利
CHN 中国
CIV 科特迪瓦
CMR 喀麦隆
COD 刚果民主共和国COG 刚果
COK 库克群岛
COL 哥伦比亚
COM 科摩罗
CPV 佛得角
CRI 哥斯达黎加CUB 古巴
CXR 圣诞岛
CYM 开曼群岛
CYP 塞浦路斯
CZE 捷克
DEU 德国
DJI 吉布提
DMA 多米尼加
DNK 丹麦
DOM 多米尼家共和国DZA 阿尔及利亚ECU 厄瓜多尔
EGY 埃及
ERI 厄立特里亚ESH 西撒哈拉
ESP 西班牙
EST 爱沙尼亚
ETH 埃塞俄比亚
FIN 芬兰
FJI 斐济
FLK 马尔维纳斯群岛
FRA 法国
FRO 法罗群岛
FSM 密克罗尼西亚
GAB 加蓬
GBD 英国（独立领土公民、出国不用）GBN 英国（海外国民，出国不用）GBO 英国（海外公民，出国不用）GBP 英国（保护公民，出国不用）GBR 英国
GBS 英国（隶属，出国不用）
GEO 格鲁吉亚
GHA 加纳
GIB 直布罗陀
GIN 几内亚
GLP 瓜德罗普
GMB 冈比亚
GNB 几内亚比绍
GNQ 赤道几内亚
GRC 希腊
GRD 格林纳达
GRL 格陵兰
GTM 危地马拉
GUF 法属圭亚那
GUM 关岛
GUY 圭亚那
HKG 香港
HMD 赫德岛和麦克唐纳岛
HND 洪都拉斯
HRV 克罗地亚
HTI 海地
HUN 匈牙利
IDN 印度尼西亚
IND 印度
IOT 英属印度洋领土IRL 爱尔兰
IRN 伊朗
IRQ 伊拉克
ISL 冰岛
ISR 以色列
ITA 意大利
JAM 牙买加
JOR 约旦
JPN 日本
JTN 约翰斯顿岛KAZ 哈萨克斯坦KEN 肯尼亚
KGZ 吉尔吉斯斯坦KHM 柬埔寨
KIR 基里巴斯
KNA 圣基茨和尼维斯KOR 韩国（南朝鲜）KWT 科威特
LAO 老挝
LBN 黎巴嫩
LBR 利比里亚
LBY 利比亚
LCA 圣卢西亚
LIE 列支敦土登LKA 斯里兰卡
LSO 莱索托
LTU 立陶宛
LUX 卢森堡
LVA 拉脱维亚
MAC 澳门
MAR 摩洛哥
MCO 摩纳哥
接口设计规范V1.0 - 参考
服务端与手机平台 接口协议 BespRout 2014年11月
文档修改/审批记录
目录 1.概述 (4) 2.涉及接口 (4) 3.接口总体要求 (4) 3.1.系统间接口的原则 (4) 3.2.处理流程 (4) 3.3.接口实现方式 (5) 4.XXX服务端接口 (5) 4.1.XX模块-根据XX下载相关的配置文件 (5) 4.2.XX模块-生成指定XX的文件配置 (6) 4.3.APP启动-初使化参数 (7) 5.附件 (8) 5.1.备注说明 (8)
1. 概述 本文档提供接口给手机端使用，为手机端提供业务平台数据 2. 涉及接口 本文档涉及的外围系统接口包括：无 3. 接口总体要求 3.1.系统间接口的原则 接口设计遵循如下原则： ?安全可靠性原则：系统应提供良好的安全性和可靠性策略，支持多种安全而 可靠的技术手段，制定严格的安全可靠的管理措施； ?开放性原则：提供开放式标准接口，提供与其它系统的互联互通； ?灵活性原则：提供灵活的接口设计，便于接口的变动。 ?可扩展性原则：支持新业务的扩展以及接口容量与接口性能的提高； ?可管理性原则：提供良好的管理机制，保证在运行过程中提供给管理员方便 的管理方式以处理各种情况； ?统一性原则：应当保证系统的接口方式、接口形式、使用的协议等标准、统 一。 3.2.处理流程 接口处理流程
3.3. 接口实现方式 手机APP 应用 与服务端采用基于HTTP 的REST 协议完成，数据传输默认为JSON 4. XXX 服务端接口 测试地址前缀: http://192.168.3.208:8088/xxx/xxx 4.1. XX 模块-根据XX 下载相关的配置文件
信息技术之会计核算软件数据接口规范
国家标准《信息技术会计核算软件数据接口》（征求意见稿） 编制讲明 一、任务来源 国家标准化治理委员会2002年下达的国家标准项目打算中，列入了《信息技术会计核算软件数据》（编号为20020389—T—424 ）；2004年国家标准化治理委员会又下达《关于调整信息技术会计核算软件数据国家标准打算项目的复函》（标委办函[2004]6号），明确由中华人民共和国审计署、中华人民共和国财政部作为主管部门，组织《信息技术会计核算软件数据》的起草单位和相关单位，承担《信息技术会计核算软件数据接口》国家标准的制定。 二、要紧工作过程 2002年3月上海市技术监督局制定了《信息技术会计核算软件数据接口规范》，并作为地点标准。2002年依照国家标准项目打算中编号为20020398—T—424的国家标准打算项目《信息技术会计核算软件数据》，上海市技术监督局组织相关单位和专家进行该标准的起草工作，于2003年底提出了《信息技术会计核
算软件数据接口规范》国家标准草案文本。 审计署依照工作需要，自1999年以来开展了“会计核算软件数据接口”方面的研究和实践。经国家电子政务治理委员会、国务院信息化工作办公室批准，审计署于2002年2月开始组织研究编写《会计核算软件数据接口》国家标准，于2003年底提出标准草案文本。 2004年2月，依照国家标准化治理委员会“标委办函[2004]6号”—“关于调整《信息技术会计核算软件数据》国家标准打算项目的复函”的精神，审计署计算中心召集上海《信息技术会计核算软件数据》标准起草组成员，审计署南京特派员办事处、南京审计学院等相关专家与人员，在北京对上述两个标准草案文本进行了深入细致的分析研究，综合整理提出了《信息技术会计核算软件数据接口规范（企业、事业单位）（草案稿）》。 2004年3月，依照国家标准化治理委员会关于“要符合国家标准撰写格式及语言规范；要使用数据元素表示；会计核算软件数据输出文件要有文本和XML格式”的要求，组织审计署计算技术中心、财政部会计司、审计署南京特派员办事处、信息产业部电子标准化所、用友公司、金算盘公司、浪潮公司等相关人员共同研究，编制出《信息技术会计核算软件数据接口（征求意见
接口设计规范
目录 1接口类型 (2) 1.1人机接口 (2) 1.2软件-硬件接口 (2) 1.3软件接口 (2) 1.4通信接口 (2) 2接口设计规范 (2) 2.1基本内容 (2) 2.2规格说明 (3) 2.2.1人机接口 (3) 2.2.2软件-硬件接口 (3) 2.2.3软件接口 (3) 2.2.4通信接口 (3) 3接口设计文档提纲 (3)
1接口类型 1.1人机接口 人机接口是指计算机系统为完成人与机器之间互相传送信息而提供的功能的接口，包括硬件及程序。 1.2软件-硬件接口 软件-硬件接口是指软件系统中软件与硬件之间的接口。例如软件与接口设备之间的接口。 1.3软件接口 软件接口是软件系统中程序之间的接口。包括软件系统与其他系统或子系统之间的接口、程序模块之间的接口、程序单元之间的接口等。 1.4通信接口 通信接口是指处理机和标准通信子系统之间的接口。包括为实现数据通信用来完成接口功能的部件、装置及有关软件。 2接口设计规范 2.1基本内容 1、接口的名称标识 2、接口在该软件系统中的地位和作用 3、接口在该软件系统中与其他程序模块和接口之间的关系 4、接口的功能定义 5、接口的规格和技术要求，包括它们各自适用的标准、协议或约定 6、各个接口的数据特性 7、各个接口的资源要求，包括硬件支持、存储资源分配等 8、接口程序的数据处理要求
9、接口的特殊设计要求 10、接口对程序编制的要求 2.2规格说明 2.2.1人机接口 准确地说明人机接口的设计条件、设计特征、编程要求等技术内容。包括人机交互环境、人机接口部件、信息传输方式及传输特性、信息格式、数据处理、存储资源分配和程序编制要求等。 2.2.2软件-硬件接口 逐个描述每一个软件-硬件间接口的设计特性。包括接口硬件说明、接口功能说明、接口信息说明、接口处理方法、接口控制方式、接口时间特性、存储资源分配和程序编制要求等。 2.2.3软件接口 逐个说明本软件系统与其他软件系统间接口的设计特征。包括接口功能说明、接口约定、数据特性、数据处理方法、接口程序运行控制、接口时间特性、存储资源分配和程序编制要求等。 2.2.4通信接口 逐个描述各个通信接口的设计特性。包括硬件描述、接口功能说明、通信协议、报文处理、存储资源分配、程序接口设计和程序编制要求等。 3接口设计文档提纲 1概述........................................................................................................................................................... 错误！未定义书签。 1.1编写目的......................................................................................................................................... 错误！未定义书签。 1.2参考资料......................................................................................................................................... 错误！未定义书签。 1.3术语和缩写词................................................................................................................................ 错误！未定义书签。2软件系统综述......................................................................................................................................... 错误！未定义书签。3接口设计.................................................................................................................................................. 错误！未定义书签。 3.1接口框图......................................................................................................................................... 错误！未定义书签。 3.2接口一览表.................................................................................................................................... 错误！未定义书签。 3.3人机接口......................................................................................................................................... 错误！未定义书签。 3.4软件-硬件接口 .............................................................................................................................. 错误！未定义书签。
通用接口标准规范v1
接口标准规范 目录 接口标准规范 (1) 第1章概述 (3) 第2章基本要求 (4) 2.1信息通讯安全 (4) 2.1.1 安全评估 (4) 2.1.2 访问控制 (4) 2.1.3 防恶意代码 (4) 2.1.4 加密 (5) 2.2支持高并发 (6) 2.3可监控 (6) 2.3.1 日志全覆盖 (6) 2.4系统资源的动态扩展 (6) 2.5异常处理机制 (7) 2.6业务扩展 (7) 第3章接口通讯方式 (7) 3.1同步请求/应答方式 (7) 3.2异步请求/应答方式 (7) 3.3会话方式 (7) 3.4广播通知方式 (7) 3.5事件订阅方式 (7)
3.7可靠消息传输 (8) 第4章传输控制要求 (8) 4.1负载均衡 (8) 4.2伸缩性与动态配置管理 (8) 4.3网络调度 (9) 4.4充分理由 (9) 4.5单一职责 (9) 4.6高内聚低耦合 (9) 4.7状态及消息 (10) 4.8控制数据量 (10) 4.9禁止随意拓展参数 (10) 第5章接口技术 (10) 第6章接口规范 (11) 6.1域名规范 (11) 6.1.1 http接口 (11) 6.1.2 webservice接口 (11) 6.2 API路径规范 (11) 6.2.1 http接口 (11) 6.2.2 webservice接口 (11) 6.3版本控制规范 (12) 6.3.1 http接口 (12) 6.3.2 webservice接口 (12) 6.4 API命名规范 (12) 6.4.1 新增方法 (13) 6.4.2 删除方法 (13) 6.4.3 修改方法 (13) 6.4.4 获取方法 (13) 6.4.5 获取列表方法 (13)
数据交换接口规范
附件4：数据交换接口规范 一、概述 计量器具检定数据交换接口采用Web service作为数据传输机制，是自包含、自描述（WSDL）、模块化的应用，由省局发布、定位、各技术机构通过web方式调用。接口基于标准的互联网协议，支持超文本传输协议(HTTP)和XML。与省局交换的数据都封装成XML格式的文件，传输前以GZIP格式将文件压缩，然后设置BASE64编码，最后在接收端将其解压，解析读取数据。 二、软件准备 JDK1.6，tomcat6.0，Web service相关包以及数据库。三、数据交换示意图 四、服务端接收数据过程 1、用户合法性校验：服务端在接收数据时同样需要进行用户合法性 校验，并返回信息。
2、数据封装：为方便数据传输和解析，客户端通过Web service交 换的数据需要封装成可扩展标记语言XML的规范，并严格按照此规范。 3、数据压缩：为提高数据的传输效率和减小传输的数据量，客户端 在传输之前需将数据以GZIP格式进行压缩，并设置BASE64位编码，以便基于HTTP传输。 4、对上传文件进行规范性校验：服务端在接收数据之前，校验客户 端数据是否按照XML规范要求，并按GZIP格式进行压缩，设置BASE64编码，否则返回不合法文件格式。 5、返回结果：服务端进行完校验，解析成功并反馈给业务系统后， 会反馈成功信息给客户端，如不成功则返回不成功。 五、客户端接收数据过程（与服务端接收过程类似。） 六、术语说明
THANKS !!! 致力为企业和个人提供合同协议，策划案计划书，学习课件等等 打造全网一站式需求 欢迎您的下载，资料仅供参考
接口文档规范
XXX接口说明书(版本：V1.0)
修订记录
1简介 1.1文档目的 接口文档是前端与后端交互密不可分的环节，接口的规范性会直接影响双方对接过程中的效率和质量。本着快速高效开发的目的性，避免对接过程中的错误率。 1.2接口规范 (1) 遵循RESTful API设计风格 (2) 数据格式采用json格式 (3) 返回统一结构数据 例如： 结构：data（数据）、errorCode（状态码）、msg（提示信息） { data:{}, // 数据类型不一定为object类型 errorCode:10001, msg:'' } (4) 枚举型参数应列举参数所有值及说明 例如： gender：性别（男：1，女：2） userInfo:{ name:'张三', age:23, gender:1 }
(5) 具有嵌套关系的参数应指明嵌套关系及子级数据结构例如： billList: 账单列表(父级) billList:[ { id:'001', billName:'测试数据', billStauts:1, address:'雁塔区' } ] (6) 返回参数数据类型保持一致性 例如： billList: 账单列表（有数据） billList:[ { id:'001', billName:'测试数据', billStauts:1, address:'雁塔区' } ] billList: 账单列表（无数据） billList:[] 返回的参数数据类型都为：array (7) 下拉及选择型数据以键值对的形式返回 例如： orderOperate：订单操作 orderOperate:[
接口设计规范
目录 1 接口类型 (2) 1.1 人机接口 (2) 1.2 软件-硬件接口 (2) 1.3 软件接口 (2) 1.4 通信接口 (2) 2 接口设计规范 (2) 2.1 基本内容 (2) 2.2 规格说明 (3) 2.2.1 人机接口 (3) 2.2.2 软件-硬件接口 (3) 2.2.3 软件接口 (3) 2.2.4 通信接口 (3) 3 接口设计文档提纲 (3)
1接口类型 1.1人机接口 人机接口是指计算机系统为完成人与机器之间互相传送信息而提供的功能的接口，包括硬件及程序。 1.2软件-硬件接口 软件-硬件接口是指软件系统中软件与硬件之间的接口。例如软件与接口设备之间的接口。 1.3软件接口 软件接口是软件系统中程序之间的接口。包括软件系统与其他系统或子系统之间的接口、程序模块之间的接口、程序单元之间的接口等。 1.4通信接口 通信接口是指处理机和标准通信子系统之间的接口。包括为实现数据通信用来完成接口功能的部件、装置及有关软件。 2接口设计规范 2.1基本内容 1、接口的名称标识 2、接口在该软件系统中的地位和作用 3、接口在该软件系统中与其他程序模块和接口之间的关系
4、接口的功能定义 5、接口的规格和技术要求，包括它们各自适用的标准、协议或约定 6、各个接口的数据特性 7、各个接口的资源要求，包括硬件支持、存储资源分配等 8、接口程序的数据处理要求 9、接口的特殊设计要求 10、接口对程序编制的要求 2.2规格说明 2.2.1人机接口 准确地说明人机接口的设计条件、设计特征、编程要求等技术内容。包括人机交互环境、人机接口部件、信息传输方式及传输特性、信息格式、数据处理、存储资源分配和程序编制要求等。 2.2.2软件-硬件接口 逐个描述每一个软件-硬件间接口的设计特性。包括接口硬件说明、接口功能说明、接口信息说明、接口处理方法、接口控制方式、接口时间特性、存储资源分配和程序编制要求等。 2.2.3软件接口 逐个说明本软件系统与其他软件系统间接口的设计特征。包括接口功能说明、接口约定、数据特性、数据处理方法、接口程序运行控制、接口时间特性、存储资源分配和程序编制要求等。 2.2.4通信接口 逐个描述各个通信接口的设计特性。包括硬件描述、接口功能说明、通信协议、报文处理、存储资源分配、程序接口设计和程序编制要求等。 3接口设计文档提纲 1 概述 (2) 1.1 编写目的 (2) 1.2 参考资料 (2)
税控发票开票软件发票信息数据接口规范V4.0
税控发票开票软件发票信息 数据接口规范V4.0 1概述 为进一步优化纳税服务，满足纳税人内部管理信息系统与增值税发票税控开票软件的衔接需要，国家税务总局下发了税控发票开票软件发票信息数据接口规范V1.0、V2.0、V3.0版。随着增值税发票管理新系统的全国推广和营改增的全面实施，公布的接口已经不能满足需要，现对该接口进行更新升级，形成V4.0版。 本接口规范适用于是增值税发票税控开票软件（金税盘版）与增值税发票税控开票软件（税控盘版）的商品编码版本（以下统一简称为税控发票开票软件），配合手工导入开具、自动导入开具和发票明细导出功能使用。 2接口说明 2.1待开发票信息导入接口 通过税控发票开票软件中的手工导入开具和自动导入开具功能，将待开发票的信息批量导入到税控发票开票软件，完成发票开具。 选择手工导入开具时，首先选择要导入的XML文件，再对导入发票信息逐张开具并打印发票。
选择自动导入开具时，首先设置文件存储路径和轮询时间。自动导入开具功能开启后，系统自动轮询指定路径下的XML文件，自动完成发票开具，并将开具结果写入指定文件目录。 2.2已开发票信息导出接口 通过税控发票开票软件中的发票明细导出功能，实现已开发票信息的批量导出，生成EXCEL文件或XML文件。 3接口定义 本接口规范内容包括待开发票信息导入接口和已开发票信息导出接口，发票类型为增值税专用发票、增值税普通发票、货物运输业增值税专用发票、机动车销售统一发票和二手车销售统一发票。3.1增值税专用发票和增值税普通发票 3.1.1修改说明 单据新增了Version节点，增加商品编码功能后的版本为2.0； 单据新增了Spbmbbh节点，增加商品编码功能后为税局下载的商品编码表版本号； 单据新增了Hsbz节点，用于区分营改增新增的5%不含税税率和中外合作油气田（原海洋石油）5%税率、1.5%税率、差额税； 单据商品明细中新增了Spbm（商品编码）、Qyspbm（企业商品编码）、Syyhzcbz（享受优惠政策）、Lslbz（零税率标识）、Yhzcsm
数据接口规范
登记结算数据接口规范（上市公司版V2.9） 二零一五年一月
版本修订历史
目录 前言 (4) 一、概述 (4) 二、数据文件命名规则 (4) 三、基本数据说明 (4) 第一章发送数据接口规范 (7) 一、中国结算上海分公司向上市公司发送的数据清单 (7) 二、中国结算上海分公司向上市公司发送的数据明细说明 (8) 1)s1(上市公司月中/末大股东名册数据) (8) 2)s1c(上市公司月末大股东名册自助补发数据) (9) 3)s2d（上市公司前N名股东名册自助发送数据） (9) 4)s2e（上市公司权益日全体股东名册自动发送） (10) 5)s3(上市公司红利退款明细数据) (11) 6)s4(人工受理的A股全体股东名册) (12) 7)s5(融资融券和转融通担保证券账户的明细数据) (13) 8)s6(股息红利差异化计税补缴明细数据) (14) 9)s7(全体股票激励期权持有人数据) (16) 10)s8(股票激励期权持有变动明细数据) (16) 11)s9(股票激励期权基本信息数据) (17) 12)s10(A股合并普通账户和信用账户前N名名册) (18)
前言 一、概述 为了进一步规范中国证券登记结算有限责任公司上海分公司（以下简称中国结算上海分公司）与上市公司之间的登记结算数据接口，确保登记结算数据处理的正确性，特编写本登记结算数据接口规范文档。本文主要针对中国结算上海分公司发送和接收的上市公司的各类登记结算数据进行详细的说明。 二、数据文件命名规则 数据文件名: =：前缀 + 标识 + “.” + 后缀 前缀：=：s1|s1c|s2d|s2e|s3|s4|s5|…… 标识：=: 证券代码[yyyymmdd][其它]，其中[yyyymmdd]和[其它]为可选内容，参见各文件的数据库名说明。 后缀：=：mdd m：=：1，2，3，……，9，a，b，c dd：=：01，02，03，……，31 目前中国结算上海分公司发送和接收的数据文件，均采用FOXPRO2.5下的标准DBF格式。为了减少数据通讯量，中国结算上海分公司发送的数据文件都经过ZIP软件压缩后发送至PROP电子信箱中。 发送数据文件的命名规则为：“前缀” + “标识” + “.mdd”；其中mdd表示日期，其中m表示月，（m=1,2,3,…,9,a,b,c），dd表示日。例如2001年12月31日发送的600001上市公司的s1数据的数据名称为“s1600001.c31”。 三、基本数据说明 1、股票的数量单位为“股”、基金的数量单位为“份”；债券、融券数量单位为“一元”面 值数量；金额单位为“元”。 2、证券类别（ZQLB）意义如下： GZ 固定收益类 JJ 基金 PT 无限售流通股 PG 配股 PS 配售股
软件开发软件需求说明书编写规范
1 具体需求 功能需求 功能需求1 对于每一类功能或者有时对于每一个功能，需要具体描述其输入、加工和输出的需求。由四个部分组成： a．引言 描述的是功能要达到的目标、所彩的方法和技术，还应清楚说明功能意图的由来 和背景。 b．输入 1)详细描述该功能的所有输入数据，如：输入源、数量、度量单位、时间设定、 有效输入范围（包括精度和公差）； 2)操作员控制细节的需求。其中有名字、操作员活动的描述、控制台或操作员的 位置。例如：当打印检查时，要求操作员进行格式调整； 3)指明引用接口说明或接口控制文件的参考资料。 c．加工 定义输入数据、中间参数，以获得预期输出结果的全部操作。它包括如下的说明： 1)输入数据的有效性检查； 2)操作的顺序，包括事件的时间设定； 3)响应，例如，溢出、通信故障、错误处理等； 4)受操作影响的参数； 5)降级运行的要求； 6)用于把系统输入变换成相应输出的任何方法（方程式、数学算法、逻辑操作等）； 7)输出数据的有效性检查。 d．输出 1)详细描述该功能所有输出数据，例如：输出目的地、数量、度量单位、时间关
系、有效输出的范围（包括精度和公差）、非法值的处理、出错信息； 2)有关接口说明或接口控制文件的参考资料。 此外，对着重于输入输出行为的系统来说，需求说明应指定所有有意义的输入、 输出对及其序列。当一个系统要求记忆它的状态时，需要这个序列，使得它可以 根据本次输入和以前的状态作出响应。也就是说，这种情况犹如有限状态机。 功能需求2 ．．．．．． 功能需求n 外部接口需求 用户接口 提供用户使用软件产品时的接口需求。例如，如果系统的用户通过显示终端进行操作，就必须指定如下要求： a．对屏幕格式的要求； b．报表或菜单的页面打印格式和内容； c．输入输出的相对时间； d．程序功能键的可用性。 硬件接口 要指出软件产品和系统硬部件之间每一个接口的逻辑特点。还可能包括如下事宜：支撑什么样的设备，如何支撑这些设备，有何约定。
APP接口开发规范文档-V1.0
{ APP接口规文档}手机客户端接口文档
版本历史
目录 一、概述 (1) 1.1 有关接口 (1) 1.1.1接口是纯数据的交互 (1) 1.2 接口的分类 (1) 1.2.1查询类接口 (1) 1.2.2 操作类接口 (1) 1.2.3上传下载类接口 (1) 1.2.4推送类接口 (1) 二、查询类接口格式规 (1) 2.1获取单条对象信息 (1) 2.1.1 请求格式 (1) 2.1.2参数说明 (2) 2.1.3正常返回结果 (2) 2.2获取列表对象信息 (3) 2.2.1 请求格式 (3) 2.2.2参数说明 (3) 2.2.3正常返回结果 (3) 三、操作类接口 (4) 3.1 新增操作 (4) 3.1.1接口说明 (4) 3.1.2参数说明 (4) 3.1.3正常返回结果 (4) 3.1.4错误返回列表 (5) 3.2 修改操作 (5) 3.2.1接口说明 (5) 3.2.2参数说明 (5) 3.2.3正常返回结果 (5) 3.2.4错误返回列表 (5) 3.3 删除操作 (6) 3.3.1接口说明 (6) 3.3.2参数说明 (6) 3.3.3正常返回结果 (6) 3.3.4错误返回列表 (6) 四、上传下载类 (7) 4.1 上传文件 (7) 4.1.1接口说明 (7) 4.1.2参数说明 (7) 4.1.3正常返回结果 (7) 4.1.4错误返回列表 (7) 4.2 下载文件 (7) 4.2.1接口说明 (7)
4.2.2参数说明 (8) 4.2.3正常返回结果 (8) 4.2.4错误返回列表 (8) 五、推送类接口 (8) 5.1 推送消息 (8) 5.1.1接口说明 (8) 5.1.2参数说明 (8) 5.1.3正常返回结果 (9) 5.1.4错误返回列表 (9) 六、通用返回格式 (9) 6.1 正确返回 (9) 6.1.1接口说明 (9) 6.1.2参数说明 (9) 6.1.3正常返回结果 (9) 6.1.4错误返回列表 (10) 6.2 错误返回 (10) 6.2.1接口说明 (10) 6.2.2参数说明 (10) 6.2.3正常返回结果 (10) 6.2.4错误返回列表 (10) 七、附录 (11) 7.1 通用错误返回列表 (11) 7.2 URL地址信息 (11) 7.2.1 主机地址 (11) 7.2.2 URL列表 (11) 7.3 安全机制 (11) 7.3.1 验证签名机制 (11) 7.4 其他 (12) 7.2.1 列表数据为空的返回 (12)
swagger接口规范说明
1.bean对象中添加注解 1.1 class上添加注解@ApiModel 1.2 属性上添加注解@ApiModelProperty(value = "姓名", example = "name")，属性是属于 对象关联属性则不需要添加example。 事例： 2.controller中添加注解 2.1 class上添加注解@Api(description = " swagger事例")。Description可以描述这个 controller是用来做什么的，@ApiIgnore：在class上是过滤掉这个controller不让这个类下面的接口在前端显示，在方法上让这个接口不在前端显示 @RequestMapping(value = "/testObject",method = RequestMethod.POST) Method统一为RequestMethod.POST 2.2 方法上添加注解 2.2.1 @ApiOperation(value = "test",notes = "test",produces = "application/json") 说明： value：方法名 notes:方法描述 produces：相应格式（统一为application/json） 2.2.2 @ApiImplicitParams({ @ApiImplicitParam(name = "subcategoryId", value = "年级iD", required = true, paramType = "query", dataType = "string") }) 说明：参数传入每一个@ApiImplicitParam表示一个参数 name:参数名，通过request.getParameter("name").的名字 value:说明 required：是否必填，true:必填，false：不必填 paramType：参数获取类型（统一使用query） dataType：数据类型
中国财务软件数据接口标准(DOC7)
中国财务软件数据接口标准(DOC7) 编者按:标准应该是衡量事务的准则。标准的制定一样都由国际/国家有关标准机构或行业主管部门完成。但一些行业的生产厂商为了爱护用户的投资,促进行业有序进展,也按照本行业的特点,联合起来制定了一些大伙儿认可并共同遵守的规范,这种做法在国外已被广泛采纳。随着中国改革开放的深入,国内一些行业的厂家也开始进行这方面的探究,本期我们刊登的《中国财务软件数据接口标准》确实是由该财务软件行业的民间组织——中国软件行业协会财务及企业治理软件分会制定的,起草者为闻名财务软件厂商深圳金蝶公司。 一、背景 目前,国内财务软件众多,它们采纳的数据库平台和数据库结构各不相同,不同财务软件之间的数据交换,因为数据库平台和结构不同而产生许多困难,几乎任意两个不同软件之间要实现数据传递都会存在专门的数据转换咨询题。烦琐的数据转换工作白费了大量人力和物力,同时也阻碍了财务软件产业的健康进展。国内财务软件的商业化差不多比较成熟,各财务软件公司都有一批用户。由于各种缘故,一些用户期望从一个软件交叉升级为另一软件。由于用户在旧软件上已做了大量的工作,必定期望升级后原有数据能移植到新的软件中,然而有些软件的数据文件通过加密或数据库结构未公布,要从中直截了当读取数据几乎不可能。为了爱护用户已付出的劳动,各财务软件需要提供一个标准的数据输入输出接口。如此,建立一个公用的数据交换标准是专门必要的。 用户在使用财务软件时,有一些需求通过财务软件本身是难以实现的,如:用户期望把会计报表通过电子表格软件处理输出为各种专门形式;另一些高级用户,则期望在其它治理软件中能取到财务数据。这些数据交换工作都需要有一个标准的数据接口来规范。财务会计通过长期的进展已形成一定的理论,财务会计工作也有规范可循,国内财务软件是在这些理论和规范的基础上开发出来的,各软件储存财务数据的模式也大同小异。财务数据要紧按会计科目、凭证、余额及发生额、报表几个部分分块储备,它们之间既
接口文档规范
XXX接口说明书 (版本： 文档编号保密等级 作者最后修改日期 审核人最后审批日期 批准人最后批准日期
修订记录 日期版本修订说明修订人
1简介 1.1文档目的 接口文档是前端与后端交互密不可分的环节，接口的规范性会直接影响双方对接过程中的效率和质量。本着快速高效开发的目的性，避免对接过程中的错误率。 1.2接口规范 (1) 遵循RESTful API设计风格 (2) 数据格式采用json格式 (3) 返回统一结构数据 例如： 结构：data（数据）、errorCode（状态码）、msg（提示信息） { data:{}, .] 订单列表 orderList orderId string 否订单id orderName string 否订单名称
isStudent boolean 是false false 是否学生（是：true，否： false） 返回参数： 参数名类型示例值默认值描述 data array […]返回的数据 data id string 用户id gender number 1 1 用户性别（男：1，女：2）invoiceTitle string 抬头 address string 地址 billList array [...] 订单列表数据 billList id string 订单id billName string 订单名称 billStauts number 1 1 订单状态（待开票：1，回款： 2，核销：3） address string 客户地址 userInfo object {} 用户信息 userInfo name name 用户姓名 age number 用户年龄 gender string 1 1 用户性别（男：1，女：2）errorCode number 状态信息 msg string 信息提示 返回示例值: { data:[ { id:'1', gender:2, invoiceTitle:'帝国快运', address:'陕西省西安市雁塔区科技路24号', billList:[ { id:'001', billName:'测试数据', billStauts:1, address:'雁塔区' }, { id:'002', billName:'测试数据02',
主要用能单位上传数据接口规范
附件2 武汉市节能智慧管理系统 数据接口规范 武汉市发展和改革委员会 2013年12月
前言 为指导我市各级节能智慧管理系统建设，市发改委组织有关专家，以我国现行相关标准为依据，结合我市节能智慧管理系统建设、验收和运行管理要求，研究制定了本数据接口规范。 本规范包括主要用能单位上传数据接口标准规范和市区各级系统上传数据接口标准规范两部分，其中两部分包括了接口的标准应用范围、接口的实现、接口的要求、术语和定义和基本原则。 本规范由市发改委负责管理和解释。
目录 1. 主要用能单位上传数据接口规范 (5) 1.1标准应用范围 (5) 1.2术语和定义 (5) 1.3基本原则 (5) 1.4接口实现 (6) 1.4.1数据提供方 (6) 1.4.2数据接收方 (6) 1.4.3接口的实现方式 (7) 1.4.4传输方式 (7) 1.4.5传输协议 (7) 1.4.6传输过程 (7) 1.4.7编码原则 (8) 1.4.8接口的验证方式 (8) 1.4.9使用策略 (9) 1.5接口数据的要求及保障 (9) 2. 区分系统上传数据接口规范 (10) 2.1标准应用范围 (10) 2.2术语和定义 (10) 2.3基本原则 (10) 2.4接口实现 (11)
2.4.1数据提供方 (11) 2.4.2数据接收方 (12) 2.4.3接口的实现方式 (12) 2.4.4传输方式 (12) 2.4.5传输协议 (12) 2.4.6传输过程 (12) 2.4.7编码原则 (13) 2.4.8接口的验证方式 (13) 2.4.9使用策略 (14) 2.5接口数据的要求及保障 (14) 附录1 数据采集器身份认证过程和数据加密 (15) 附录2 数据采集器或子系统和市数据中心通信过程 (16) 附录3 数据传输的XML数据格式 (17)
接口设计规范
接口设计规范 Prepared on 24 November 2020
目录 1接口类型 1.1人机接口 人机接口是指计算机系统为完成人与机器之间互相传送信息而提供的功能的接口，包括硬件及程序。 1.2软件-硬件接口 软件-硬件接口是指软件系统中软件与硬件之间的接口。例如软件与接口设备之间的接口。 1.3软件接口 软件接口是软件系统中程序之间的接口。包括软件系统与其他系统或子系统之间的接口、程序模块之间的接口、程序单元之间的接口等。 1.4通信接口 通信接口是指处理机和标准通信子系统之间的接口。包括为实现数据通信用来完成接口功能的部件、装置及有关软件。
2接口设计规范 2.1基本内容 1、接口的名称标识 2、接口在该软件系统中的地位和作用 3、接口在该软件系统中与其他程序模块和接口之间的关系 4、接口的功能定义 5、接口的规格和技术要求，包括它们各自适用的标准、协议或约定 6、各个接口的数据特性 7、各个接口的资源要求，包括硬件支持、存储资源分配等 8、接口程序的数据处理要求 9、接口的特殊设计要求 10、接口对程序编制的要求 2.2规格说明 2.2.1人机接口 准确地说明人机接口的设计条件、设计特征、编程要求等技术内容。包括人机交互环境、人机接口部件、信息传输方式及传输特性、信息格式、数据处理、存储资源分配和程序编制要求等。 2.2.2软件-硬件接口 逐个描述每一个软件-硬件间接口的设计特性。包括接口硬件说明、接口功能说明、接口信息说明、接口处理方法、接口控制方式、接口时间特性、存储资源分配和程序编制要求等。 2.2.3软件接口 逐个说明本软件系统与其他软件系统间接口的设计特征。包括接口功能说明、接口约定、数据特性、数据处理方法、接口程序运行控制、接口时间特性、存储资源分配和程序编制要求等。
增值税发票税控开票软件数据接口规范v3.0概要
增值税发票税控开票软件 数据接口规范V3.0 1概述 为进一步优化纳税服务，满足纳税人内部管理信息系统与增值税发票税控开票软件（以下简称开票软件）的衔接需要，国家税务总局下发了开票软件数据接口规范V1.0和V2.0版。随着增值税发票管理新系统的全国推广和营改增的全面实施，公布的接口已经不能满足需要，现对该接口进行更新升级，形成V3.0版。 本接口规范适用于是开票软件（金税盘版）与开票软件（税控盘版）的商品编码版本，配合手工导入开具、自动导入开具和发票明细导出功能使用。 2接口说明 2.1待开发票信息导入接口 通过开票软件中的手工导入开具和自动导入开具功能，将待开发票的信息批量导入到税控发票开票软件，完成发票开具。 选择手工导入开具时，首先选择要导入的XML文件，再对导入发票信息逐张开具并打印发票。 选择自动导入开具时，首先设置文件存储路径和轮询时间。自动导入开具功能开启后，系统自动轮询指定路径下的XML文件，自
动完成发票开具，并将开具结果写入指定文件目录。 2.2已开发票信息导出接口 通过开票软件中的发票明细导出功能，实现已开发票信息的批量导出，生成EXCEL文件或XML文件。 3接口定义 本接口规范内容包括待开发票信息导入接口和已开发票信息导出接口，发票类型为增值税专用发票、增值税普通发票、货物运输业增值税专用发票和机动车销售统一发票。 3.1增值税专用发票和增值税普通发票 3.1.1修改说明 单据新增了Version节点，增加商品编码功能后的版本为2.0； 单据新增了Spbmbbh节点，增加商品编码功能后为税局下载的商品编码表版本号； 单据新增了Hsbz节点，用于区分营改增新增的5%不含税税率和中外合作油气田（原海洋石油）5%税率、1.5%税率、差额税； 单据商品明细中新增了Spbm（商品编码）、Qyspbm（企业商品编码）、Syyhzcbz（享受优惠政策）、Lslbz（零税率标识）、Yhzcsm （优惠政策说明），详细内容请查看接口规范中相关说明； 单据只允许对单行商品进行折扣，折扣行紧挨被折行之后，折
软件开发文档规范标准[详]
附2: 软件文档编写向导 文档分类 项目包括如下几类文档： 项目管理文档。包括：《软件项目计划》、《项目进度报告》、《项目开发总结报告》 软件开发文档。包括：《需求规格说明》、《概要设计说明》、《详细设计说明》、《测试计划》、《软件测试分析报告》。 产品文档。包括：《用户操作手册》《演示文件》。 软件项目计划 （Software Project Plan） 一．引言 1．编写目的（阐明编写软件计划的目的，指出读者对象。） 2．项目背景（可包括：（1）项目委托单位、开发单位和主管部门；（2）该软件系统与其他系统的关系。） 3．定义（列出本文档中用到的专门术语的定义和缩略词的原文。） 4．参考资料（可包括：文档所引用的资料、规范等；列出资料的作者、标题、编号、发表日期、出版单位或资料来源。） 二．项目概述 1. 工作内容（简要说明项目的各项主要工作,介绍所开发软件的功能性能等. 若不编写可行性研究报告,则应在本节给出较详细的介绍。) 2. 条件与限制（阐明为完成项目应具备的条件开发单位已具备的条件以及尚需创造的条件. 必要时还应说明用户及分合同承包者承担的工作完成期限及其它条件与限制。） 3. 产品 （1）程序（列出应交付的程序名称使用的语言及存储形式。） （2）文档（列出应交付的文档。） （3）运行环境（应包括硬件环境软件环境。） 4．服务（阐明开发单位可向用户提供的服务. 如人员培训安装保修维护和其他运行支持。）5．验收标准
三．实施计划 1．任务分解（任务的划分及各项任务的负责人。） 2．进度（按阶段完成的项目,用图表说明开始时间完成时间。） 3．预算 4．关键问题（说明可能影响项目的关键问题,如设备条件技术难点或其他风险因素,并说明对策。） 四．人员组织及分工 五．交付期限 六．专题计划要点（如测试计划等。） 项目开发进度报告 一．报告时间及所处的开发阶段 二．给出进度 1．本周的主要活动 2．实际进展与计划比较 三．所用工时（按不同层次人员分别计时。） 四．所有机时 五．工作遇到的问题及采取的对策 六．本周完成的成果 七．下周的工作计划 八．特殊问题 项目开发总结报告 一．引言 1．编写目的（阐明编写总结报告的目的,指明读者对象。） 2．项目背景（说明项目的来源、委托单位、开发单位及主管部门。） 3．定义（列出报告中用到的专门术语定义和缩写词的原意。） 4．参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：（1）项目开发计划；（2）需求规格说明书；（3）概要设计说明书；（4）详细设计说明书；（5）用户操作手册；（6）测试计划；（7）测试分析报告（8）本报告引用的其他资料、采用的开发标准或开发规范。）
(完整版)硬件设计文档规范-硬件模板
SUCHNESS 硬件设计文档 型号：GRC60定位终端 编号： 机密级别：绝密机密内部文件 部门：硬件组 拟制：XXXX年 XX月 XX日 审核：年月日 标准化：年月日 批准：年月日
文档修订历史记录
目录 1系统概述 (3) 2系统硬件设计 (3) 2.1硬件需求说明书 (3) 2.2硬件总体设计报告 (3) 2.3单板总体设计方案 (3) 2.4单板硬件详细设计 (3) 2.5单板硬件过程调试文档 (3) 2.6单板硬件测试文档 (4) 3系统软件设计 (4) 3.1单板软件详细设计 (4) 3.2单板软件过程调试报告 (4) 3.3单板系统联调报告 (4) 3.4单板软件归档详细文档 (4) 4硬件设计文档输出 (4) 4.1硬件总体方案归档详细文档 (4) 4.2硬件信息库 (5) 5需要解决的问题 (5) 6采购成本清单 (5)
1系统概述 2系统硬件设计 2.1、硬件说明书 硬件需求说明书是描写硬件开发目标，基本功能、基本配置，主要性能指标、运行环境，约束条件以及开发经费和进度等要求，它的要求依据是产品规格说明书和系统需求说明书。它是硬件总体设计和制订硬件开发计划的依据，具体编写的内容有：系统工程组网及使用说明、硬件整体系统的基本功能和主要性能指标、硬件分系统的基本功能和主要性能指标以及功能模块的划分等 2.2、硬件总体设计报告 硬件总体设计报告是根据需求说明书的要求进行总体设计后出的报告，它是硬件详细设计的依据。编写硬件总体设计报告应包含以下内容：系统总体结构及功能划分，系统逻辑框图、组成系统各功能模块的逻辑框图，电路结构图及单板组成，单板逻辑框图和电路结构图，以及可靠性、安全性、电磁兼容性讨论和硬件测试方案等 2.3、单板总体设计方案 在单板的总体设计方案确定后出此文档，单板总体设计方案应包含单板版本号，单板在整机中的位置、开发目的及主要功能，单板功能描述、单板逻辑框图及各功能模块说明，单板软件功能描述及功能模块划分、接口简单定义与相关板的关系，主要性能指标、功耗和采用标准 2.4、单板硬件详细设计 在单板硬件进入到详细设计阶段，应提交单板硬件详细设计报告。在单板硬件详细设计中应着重体现：单板逻辑框图及各功能模块详细说明，各功能模块实现方式、地址分配、控制方式、接口方式、存贮器空间、中断方式、接口管脚信号详细定义、时序说明、性能指标、指示灯说明、外接线定义、可编程器件图、功能模块说明、原理图、详细物料清单以及单板测试、调试计划。有时候一块单板的硬件和软件分别由两个开发人员开发，因此这时候单板硬件详细设计便为软件设计者提供了一个详细的指导，因此单板硬件详细设计报告至关重要。尤其是地址分配、控制方式、接口方式、中断方式是编制单板软件的基础，一定要详细写出。