完整版远程监控系统接口标准.docx
《完整版远程监控系统接口标准.docx》由会员分享，可在线阅读，更多相关《完整版远程监控系统接口标准.docx（82页珍藏版）》请在冰豆网上搜索。
完整版远程监控系统接口标准
远程监控系统接口标准
1.编制说明
2.目的
为了指导源系统与福建省互联互通中心之间的数据交互，特制定本规范。
本规范为福建省数据对象公司，规定了源系统与福建省互联互通系统之间的应用层接口协议。
3.名词术语
REST
（英文：
RepresentationalStateTransfer，简称REST）描述了一个架构样式的网络系统，比如web 应用程序。
源系统
上传数据的应用系统。
4.接口授权
源系统访问互联互通中心的服务接口，必须由互联互通中心授权颁发。
互联互通中心将颁发给源系统全网唯一的appId和密钥secret，并为每个appId授权交互接口。
如果源系统访问的接口没有得到授权，互联互通中心将拒绝访问。
互联互通中心统一管理源系统接口的授权和取消。
5.调用接口方式
源系统调用接口采用HTTP请求的方式（GET/POST）。
请求的参数必须带有唯一标识appId、密钥secret加密后的token、时间戳timestamp。
URL示例：
http:
//localhost:
8080/webservice/demo/upload?
ak=APP00001&ts=1403593817968&token=wSzH0G5jKAxYILGo+5BOEd5g05g=
UrlEncode后的结果是：
http:
//localhost:
8080/webservice/demo/upload?
ak=APP00001&ts=1403593817968&token=wSzH0G5jKAxYILGo%2B5BOEd5g05g%3D
6.参数定义
1.
2.
3.
4.
5.
6.
7.
6.1.验证参数
接口调用时必须上传的权限验证参数，所以在接口定义的请求参数不再说明。
名称
说明
数据类型
appId
互联互通中心颁发给源系统的唯一标识
String
token
认证码=BASE64（SHA1（SHA1（appId+timestamp+secret）））secret为SDIC颁发给BAS的密钥
String
timestamp
当前时间戳
String
6.2.请求值
在业务数据新增、更新业务数据的时候，将请求参数格式话为json对象，json对象作为字符串提交。
业务数据json标准：
{
"sourceId":
"xxxxxx"
"corpCode":
"xxxxxx"
"corpName":
"xxxxxx",
"personName":
"xxxxxx",
"idCard":
"xxxxxx",
......
}
6.3.返回值
6.3.1.返回类型
接口调用的返回均采用json对象返回。
6.3.1.1.记录返回数据标准
{
"result":
true,
"data":
{
"dcPK":
"DC_4028e5d346d1b1690146d1b5c8f80001",
"corpCode":
"企业机构代码",
"corpName":
"企业名称",
"personName":
"人员名称",
......
......
"status":
"新增",
"dataVersion":
1,
"photo":
"http:
//192.168.102.5:
8093/attach/ATTACH_3/2014/11/27/x.jpg"
}
}
6.3.1.2.异常返回数据标准
{
"result":
false,
"error":
"错误描述",
"error_code":
"00000"
}
6.3.2.异常编码error_code定义
异常类型
异常编码
异常描述
请求错误
00000
请求错误
00001
请求参数错误
00002
请求格式错误
00003
请求超时
00004
请求的appId在系统中找不到
00005
授权错误
00006
没有访问权限
00007
文件上传的请求方式必须为post，MIME类型必须为multipart/form-data
系统错误
10001
系统错误
10002
上传文件发生错误
7.数据标准
7.1.项目申报基本交互单元信息
该信息由建设单位在“动态系统”进行申报，并上传到互联互通中心，远程监控系统在从互联互通中心通过8.1的查询接口进行下载获取。
该交互单元在草稿状态就已经上传，所以项目省代码是为空的（只有在项目审核通过的时候才会生成并上传到互联互通中心）。
目前该基本交互单元已经将“动态系统”从2011年至今的符合条件的项目数据（草稿、退回、提交（审核中）、待确认、已确认、竣工提交（审核中）、审核通过（在建）、暂停、完工、竣工）都补充上传到互联互通中心。
字段名称
字段代码
字段
类型
字段
长度
小数
位数
约束
条件
备注
项目名称
prjName
varchar
2000
M
项目省代码
provincePrjNum
varchar
30
M
项目主键
proId
varchar
64
M
建设单位机构代码
corpCode
varchar
25
M
建设单位机构名称
corpName
varchar
200
M
项目创建日期
createDate
Date
0
7.2.工程项目基本信息
该工程信息库在互联互通中心只包含工程项目状态为：
审核通过在建、暂停、完工、竣工的项目信息。
如果想获取除7.1信息外的其他字段信息可以通过查询8.2的接口获取7.2的工程项目基本信息（比如质量监督站名称，安全监督站名称等等）。
字段名称
字段代码
字段
类型
字段
长度
小数
位数
约束
条件
备注
项目编号
prjNum
varchar
20
M
详见编码规则
项目编号（省编号）
provincePrjNum
varchar
20
M
工程所属地
prjBelongAddr
varchar
100
工程所在地
prjLocalAddr
varchar
100
项目名称
prjName
varchar
200
M
建设单位名称
buildCorpName
varchar
200
M
建设单位组织机构代码
buildCorpCode
varchar
15
M
建设单位负责人
buildPersonName
varchar
20
M
建设单位负责人电话
buildPersonPhone
varchar
20
O
项目所在省
provinceNum
int
M
详见数据字典表TBXZQDMDIC
项目所在地市
cityNum
int
M
详见数据字典表TBXZQDMDIC
项目所在区县
countyNum
int
M
详见数据字典表TBXZQDMDIC
当前工程状态
prjStatus
varchar
6
M
记录登记时间
createDate
date
M
7.3.单位工程基本信息
字段名称
字段代码
字段
类型
字段
长度
小数
位数
约束
条件
备注
项目编号
prjNum
varchar
20
M
详见编码规则
项目编号（省编号）
provincePrjNum
varchar
20
M
项目Id
proId
varchar
64
M
单位工程Id
itemId
Varchar
64
M
单位工程名称
singleProName
varchar
1000
M
单位工程类别
singleProType
varchar
50
建筑高度
archHeight
decimal
15
4
建筑面积
archArea
decimal
15
4
市政长度
muniLength
decimal
15
4
状态
itemStatus
varchar
6
±0.000以上层数
structUpfloorNum
decimal
15
4
±0.000以下层数
structDwfloorNum
decimal
15
4
7.4.远程监控安装信息
该信息由施工单位在“动态系统”进行申报，并上传到互联互通中心，远程监控系统在从互联互通中心通过8.3的查询接口进行下载获取。
当服务运营商安装结束后，远程监控系统调用互联互通中心8.3的更新接口，把完成时间、备注等相关数据返回到互联互通中心。
字段名称
字段代码
字段
类型
字段
长度
小数
位数
约束条件
备注
申报Id
dcPk
varchar
64
M
项目名称
prjName
varchar
2000
M
动态系统登记
项目省代码
provincePrjNum
varchar
30
M
动态系统登记
监管系统项目主键
proId
varchar
64
M
动态系统登记
远程监控系统项目主键
detectProId
varchar
64
动态系统登记
服务运营商
serviceOperator
varchar
20
M
动态系统登记
电信、移动、联通
申报时间
declareDate
datetime
M
动态系统登记
申报备注
declareRemark
varchar
2000
M
动态系统登记
申报施工单位组织机构代码
corpCode
varchar
15
M
动态系统登记
申报施工单位名称
corpName
varchar
200
M
动态系统登记
计划安装完成时间
planInstallDate
datetime
动态系统产生
申报时间+30天
实际安装完成时间
actualInstallDate
datetime
远程监控系统返回
安装备注
installRemark
varchar
2000
远程监控系统返回
…
7.5.远程监控设备安装接入数据信息
该信息由远程监控系统登记，远程监管系统调用8.10下的4个接口时，会自动生成这张表数据。
字段名称
字段代码
字段
类型
字段
长度
小数
位数
约束
条件
备注
项目省代码
provincePrjNum
varchar
30
M
项目主键
proId
varchar
64
M
远程监控系统项目主键
detectProId
varchar
64
施工单位组织机构代码
corpCode
varchar
15
M
施工单位名称
corpName
varchar
200
M
设备编号
devId
varchar
64
M
升级会员 