远程监控系统接口标准.doc

远程监控系统接口标准

软件详细设计

1. 编制说明 3
2. 目的 3
3. 名词术语 3
4. 接口授权 4
5. 调用接口方式 4
6. 参数定义 4
6.1. 验证参数 4
6.2. 请求值 5
6.3. 返回值 5
6.3.1. 返回类型 5
6.3.2. 异常编码error_code定义 6
7. 数据标准 6
7.1. 项目申报基本交互单元信息 6
7.2. 工程项目基本信息 7
7.3. 单位工程基本信息 8
7.4. 远程监控安装信息 9
7.5. 远程监控设备安装接入数据信息 9
7.6. 远程监控设备与单位工程绑定信息 10
7.7. 远程监控维护信息 11
7.8. 远程监控暂停信息 12
7.9. 远程监控恢复信息 13
7.10. 远程监控拆除信息 14
7.11. 全景成像测量摄像机业务数据信息 14
7.12. 通用摄像机业务数据信息 15
7.13. 视频在线率统计汇总数据信息 16
8. 接口定义 17
8.1. 项目申报基本交互单元信息接口 17
8.1.1. 数据查询接口 17
8.2. 工程项目基本信息接口 18
8.2.1. 数据查询接口 18
8.3. 单位工程基本信息接口 19
8.3.1. 数据查询接口 19
8.4. 远程监控安装信息接口 21
8.4.1. 数据更新接口 21
8.4.2. 数据查询接口 22
8.5. 远程监控安装设备与单位工程信息接口 23
8.5.1. 数据新增接口 23
8.5.2. 数据更新接口 24
8.5.3. 数据删除接口 25
8.5.4. 数据获取接口 26
8.5.5. 数据查询接口 27
8.6. 远程监控维护信息接口 28
8.6.1. 数据更新接口 28
8.6.2. 数据查询接口 29
8.7. 远程监控暂停信息接口 30
8.7.1. 数据更新接口 30
8.7.2. 数据查询接口 31
8.8. 远程监控恢复信息接口 32
8.8.1. 数据更新接口 32
8.8.2. 数据查询接口 33
8.9. 远程监控拆除信息接口 35
8.9.1. 数据更新接口 35
8.9.2. 数据查询接口 36
8.10. 远程监控设备安装统一接入信息接口 37
8.10.1. 全景成像测量摄像机设备接入请求 37
8.10.2. 加工场摄像机、大门出入口摄像机、塔式起重机超视野摄像机等通用摄像机设备接入请求 38
8.10.3. 环境侦测预警联动设备接入请求 39
8.10.4. 吊装设备操作员智能识别设备接入请求 40
8.11. 远程监控设备远程监控维护信息接口 41
8.11.1. 远程监控设备报修请求 41
8.11.2. 远程监控设备移机请求 42
8.12. 全景成像测量摄像机业务信息接口 42
8.12.1. 获取全景图列表接口 42
8.12.2. 获取节点图接口 43
8.12.3. 获取测量图接口 44
8.12.4. 上传全景图接口 44
8.12.5. 上传节点图接口 45
8.12.6. 上传测量图接口 45
8.13. 通用摄像机业务接口标准（应用于加工场摄像机、大门出入口摄像机、塔式起重机超视野摄像机） 46
8.13.1. 按工程项目获取通用摄像机设备列表 46
8.13.2. 通用摄像机历史视频地址请求 47
8.13.3. 通用摄像机历史视频播放请求 48
8.13.4. 通用摄像机视频截图上传请求 48
8.14. 吊装设备操作员智能识别业务接口标准 49
8.14.1. 获取智能识别设备操作人员信息 49
8.14.2. 智能识别设备认证请求 50
8.14.3. 获取操作员账号状态请求 51
8.14.4. 根据管理员ID获取认证错误列表请求 52
8.14.5. 管理员审核 53
8.14.6. 获取人员的智能识别设备操作记录 54
8.15. 环境侦测预警联动系统接口标准 54
8.15.1. 环境侦测预警联动设备信息获取 54
8.15.2. 环境侦测预警联动设备实时数据上传请求 55
8.15.3. 环境侦测预警联动设备实时数据获取 56
8.15.4. 环境侦测预警联动设备历史数据获取 57
8.15.5. 环境侦测预警联动设备喷淋联动阈值设置 58
8.16. 钢筋质量见证取样系统接口标准 59
8.16.1. 创建见证取样任务接口 59
8.16.2. 远程视频监控测量仪抓拍图片上传接口 60
8.16.3. 手机抓拍图片上传接口 61
8.16.4. 检测机构检测员获取样品任务请求 62
8.16.5. 检测机构检测员手机拍照上传接口 62
8.16.6. 见证取样原图与送检试样图片比对认证请求 63
8.17. 视频在线率统计汇总信息接口 64
8.17.1. 福建省工程视频在线率统计汇总请求 64
8.17.2. 福建省“闽江杯”优质工程视频在线率统计汇总请求 65
9. 申报交互简述 66

1. 编制说明
2. 目的
为了指导源系统与福建省互联互通中心之间的数据交互，特制定本规范。本规范为福建省数据对象公司，规定了源系统与福建省互联互通系统之间的应用层接口协议。
3. 名词术语
REST
（英文：Representational State Transfer，简称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

设备名称
devName
varchar
128

M

设备安装位置
devInstalPlace
varchar
128

设备运行参数配置
devPlayConfig
varchar
100

设备型号
devUnitType
varchar
64

设备类型
devType
varchar
16

M
1:全景成像测距摄像机
2:加工场摄像机
3:大门出入口摄像机
4:吊装设备操作员智能识别设备
5:塔式起重机超视野摄像机
6:环境侦测预警联动设备
流程状态
devFlowState
varchar
16

开通时间
devDateStartUse
datetime

拆机时间
devDateUninstall
datetime

7.6. 远程监控设备与单位工程绑定信息
该信息由远程监控系统登记，远程监管系统调用8.5下的接口来生成。
字段名称
字段代码
字段
类型
字段
长度
小数
位数
约束
条件
备注
项目省代码
provincePrjNum
varchar
30

项目Id
proId
varchar
64

M

远程监控系统项目主键
detectProId
varchar
64

设备编号
devId
varchar
64

M

单位工程Id
itemId
varchar
64

M

7.7. 远程监控维护信息
该信息由施工单位在“动态系统”进行申报，并上传到互联互通中心，远程监控系统在从互联互通中心通过8.6的查询接口进行下载获取。当服务运营商维护结束后，远程监控系统调用互联互通中心8.6的更新接口，把故障原因、实际维护完成时间、备注等相关数据返回到互联互通中心。
字段名称
字段代码
字段
类型
字段
长度
小数
位数
约束条件
备注
项目名称
prjName
varchar
2000

M
动态系统登记
项目省代码
provincePrjNum
varchar
30

M
动态系统登记
监管系统项目主键
proId
varchar
64

M
动态系统登记
远程监控系统项目主键
detectProId
varchar
64

动态系统登记
服务运营商
serviceOperator
varchar
20

M
动态系统登记
电信、移动、联通
施工单位组织机构代码
corpCode
varchar
15

M
动态系统登记
施工单位名称
corpName
varchar
200

M
动态系统登记
设备编号
devId
varchar
64

M
动态系统登记
报修时间
maintainDate
datetime
6

M
动态系统登记
报修备注
maintainRemark
varchar
2000

M
动态系统登记
计划维护完成时间
planMaintainDate
datetime
6

动态系统登记
实际维护完成时间
actualMaintainDate
datetime
6

远程监控系统返回
维护说明
maintainDescribe
varchar
2000

远程监控系统返回
故障原因
reason
varchar
100

M
远程监控系统返回
字典，选项有：非设备故障、设备故障、断电、其他等。如果是设备故障，还要求输入实际维护完成时间
…

7.8. 远程监控暂停信息
该信息由施工单位在“动态系统”进行申报，并上传到互联互通中心，远程监控系统从互联互通中心通过8.7的查询接口进行下载获取。当服务运营商暂停设备运行后，远程监控系统调用互联互通中心提供的8.7的更新接口，把实际暂停时间、备注等相关数据返回到互联互通中心。
字段名称
字段代码
字段
类型
字段
长度
小数
位数
约束条件
备注
项目名称
prjName
varchar
2000

M
动态系统登记
项目省代码
provincePrjNum
varchar
30

M
动态系统登记
监管系统项目主键
proId
varchar
64

M
动态系统登记
远程监控系统项目主键
detectProId
varchar
64

动态系统登记
服务运营商
serviceOperator
varchar
20

M
动态系统登记
电信、移动、联通
施工单位组织机构代码
corpCode
varchar
15

M
动态系统登记
施工单位名称
corpName
varchar
200

M
动态系统登记
设备编号
devId
varchar
64

M
动态系统登记
暂停申请时间
pauseDeclareDate
datetime

M
动态系统登记
申请备注
declareRemark
varchar
2000

M
动态系统登记
审核通过时间
passDate
datetime

动态系统登记
实际暂停时间
actualPauseDate
datetime

远程监控系统返回
暂停备注
pauseRemark
varchar
2000

远程监控系统返回
…

7.9. 远程监控恢复信息
该信息由施工单位在“动态系统”进行申报，并上传到互联互通中心，远程监控系统从互联互通中心通过8.8的查询接口进行下载获取。当服务运营商恢复设备运行后，远程监控系统调用互联互通中心提供的8.8的更新接口，把实际恢复时间、备注等相关数据返回到互联互通中心。
字段名称
字段代码
字段
类型
字段
长度
小数
位数
约束条件
备注
项目名称
prjName
varchar
2000

M
动态系统登记
项目省代码
provincePrjNum
varchar
30

M
动态系统登记
监管系统项目主键
proId
varchar
64

M
动态系统登记
远程监控系统项目主键
detectProId
varchar
64

动态系统登记
服务运营商
serviceOperator
varchar
20

M
动态系统登记
电信、移动、联通
施工单位组织机构代码
corpCode
varchar
15

M
动态系统登记
施工单位名称
corpName
varchar
200

M
动态系统登记
设备编号
devId
varchar
64

M
动态系统登记
恢复申请时间
recoverDeclareDate
datetime

M
动态系统登记
恢复申请备注
declareRemark
Varchar
2000

M
动态系统登记
实际恢复时间
actualRecoverDate
datetime

M
远程监控系统返回
恢复备注
recoverRemark
varchar
2000

远程监控系统返回
…

7.10. 远程监控拆除信息
该信息由施工单位在“动态系统”进行申报，并上传到互联互通中心，远程监控系统从互联互通中心通过8.9的查询接口进行下载获取。当服务运营商拆除设备后，远程监控系统调用互联互通中心提供的8.9的更新接口，把实际拆除时间、备注等相关数据返回到互联互通中心。
字段名称
字段代码
字段
类型
字段
长度
小数
位数
约束条件
备注
项目名称
prjName
varchar
2000

M
动态系统登记
项目省代码
provincePrjNum
varchar
30

M
动态系统登记
监管系统项目主键
proId
varchar
64

M
动态系统登记
远程监控系统项目主键
detectProId
varchar
64

动态系统登记
服务运营商
serviceOperator
varchar
20

M
动态系统登记
电信、移动、联通
施工单位组织机构代码
corpCode
varchar
15

M
动态系统登记
施工单位名称
corpName
varchar
200

M
动态系统登记
设备编号
devId
varchar
64

M
动态系统登记
拆除申报时间
removeDeclareDate
datetime

M
动态系统登记
拆除备注
removeRemark
varchar
2000

M
动态系统登记
审核通过时间
agreeRemoveDate
datetime

动态系统登记
计划拆除完成时间
planRemoveDate
datetime

动态系统登记
审核通过时间+10天
实际拆除完成时间
actualRemoveDate
datetime

远程监控系统返回
拆除说明
removeDescribe
varchar
2000

远程监控系统返回
…

7.11. 全景成像测量摄像机业务数据信息
字段名称
字段代码
字段
类型
字段
长度
小数
位数
约束
条件
备注
项目省代码
provincePrjNum
string
30

M

项目主键
proId
string
64

M

远程监控系统项目主键
detectProId
varchar
64

设备编号
DevId
string
64

M

单位工程名称
DevInstalPlace
string
128

图片Url地址
Url
string
256

图片类型
CapPicType
string
16

1:全景图 4:拼接图
2:节点图 5:其他图
3:测量图
图片生成时间
CapPicDate
datetime

测量点激光距离(mm)
Obd
int

测量点激光光强
LaserIntensity
float

测量点经度(精度7位小数)
lngTargeted
float

测量点纬度(精度7位小数)
latTargeted
float

测量点标高(mm)
HighTargeted
int

7.12. 通用摄像机业务数据信息
字段名称
字段代码
字段
类型
字段
长度
小数
位数
约束
条件
备注
项目省代码
provincePrjNum
string
30

M

项目主键
proId
string
64

M

远程监控系统项目主键
detectProId
varchar
64

设备编号
DevId
string
64

M

截图位置
CapPicPlace
string
128

图片Url地址
Url
string
256

图片生成时间
CapPicDate
datetime

7.13. 视频在线率统计汇总数据信息
字段名称
字段代码
字段
类型
字段
长度
小数
位数
约束
条件
备注
项目省代码
provincePrjNum
string
30

M

项目主键
proId
string
64

M

远程监控系统项目主键
detectProId
string
64

工程名称
projname
string
512

工程考核级别
projgrade
int

0:普通工程1:闽江杯
统计级别
gradeType
int

1:省、2:市、3:区县
监管部门
superdepartment
string
128

考核开始时间
assessbegDate
string
32

考核结束时间
assessendDate
string
32

缺勤开始时间
absentebegDate
string
32

缺勤结束时间
absenteendDate
string
32

满勤开始时间
workfullbegDate
string
32

满勤结束时间
workfullendDate
string
32

本月视频在线率
crmonthOnlineRate
float

上月视频在线率
lsOnlineRate
float

第一季度视频在线率
firquartOnlineRate
float

第二季视频在线率
secquartOnlineRate
float

第三季视频在线率
thiquartOnlineRate
float

第四季视频在线率
fouquartOnlineRate
float

本年度视频在线率
yearOnlineRate
float

总视频在线率
totalOnlineRate
float

8.
8. 接口定义
8.1. 项目申报基本交互单元信息接口
8.1.1. 数据查询接口
接口描述
接口名称
业务数据查询接口
接口描述
根据查询条件查询SDIC系统的业务数据。
接口协议
REST
接口方法
http://117.27.135.11/webservice/projectForSuper/search
请求类型
GET
备注
查询中string支持模糊查询，只需要在在参数值前后加%，如：corpName中间包含(corpName=%value%),左包含(corpName=value%)，右包含(corpName=%value);int,double,long,date的支持区间查询,直选在参数值中间加“,”（英文逗号），如：updateTime查询，between2014-10-10and2014-12-12为(updateTime=2014-10-10,2014-12-12),2014-10-10之后的为(updateTime=2014-10-10,)，2014-10-10之前为(updateTime=,2014-10-10)。分页参数为：page(页码)，pageSize(一页记录数)

请求参数
名称
说明
数据类型
监管系统项目申报信息字段
按照规范，原则上所以字段均可作为查询条件。一般根据需要设置即可

应答参数
名称
说明
数据类型
dcPK
互联互通数据主键
String
sourceId
源系统数据主键
String
updateTime
数据更新时间
String
status
数据状态(1:新增，2:更新，4：删除)
String
dataVersion
数据版本
Double
项目申报基本交互单位信息字段

8.2. 工程项目基本信息接口
8.2.1. 数据查询接口
接口描述
接口名称
业务数据查询接口
接口描述
根据查询条件查询SDIC系统的业务数据。
接口协议
REST
接口方法
http://117.27.135.11/webservice/project/video/search
请求类型
GET
备注
查询中string支持模糊查询，只需要在在参数值前后加%，如：prjName中间包含(prjName=%value%),左包含(prjName=value%)，右包含(prjName=%value);int,double,long,date的支持区间查询,直选在参数值中间加“,”（英文逗号），如：updateTime查询，between2014-10-10and2014-12-12为(updateTime=2014-10-10,2014-12-12),2014-10-10之后的为(updateTime=2014-10-10,)，2014-10-10之前为(updateTime=,2014-10-10)
请求参数
名称
说明
数据类型
工程项目数据标准
按照规范，原则上所以字段均可作为查询条件。一般根据需要设置即可(比如按照工程项目省编码：provincePrjNum查询工程项目信息)

应答参数
工程项目信息
名称
说明
数据类型
dcPK
互联互通数据主键
String
sourceId
源系统数据主键
String
updateTime
数据更新时间
String
status
数据状态(1:新增，2:更新，4：删除)
String
dataVersion
数据版本
Double
工程项目基本信息字段

8.3. 单位工程基本信息接口
8.3.1. 数据查询接口
接口描述
接口名称
业务数据查询接口
接口描述
根据查询条件查询SDIC系统的业务数据。
接口协议
REST
接口方法
http://117.27.135.11/webservice/item/video/search
请求类型
GET
备注
查询中string支持模糊查询，只需要在在参数值前后加%，如：prjName中间包含(prjName=%value%),左包含(prjName=value%)，右包含(prjName=%value