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

远程监控系统接口标准软件详细设计1.编制说明32.目的33.名词术语34.接口授权45.调用接口方式46.参数定义46.1.验证参数46.2.请求值56.3.返回值56.3.1.返回类型56.3.2.异常编码error_code定义67.数据标准67.1.项目申报基本交互单元信息67.2.工程项目基本信息77.3.单位工程基本信息87.4.远程监控安装信息97.5.远程监控设备安装接入数据信息97.6.远程监控设备与单位工程绑定信息107.7.远程监控维护信息117.8.远程监控暂停信息127.9.远程监控恢复信息137.10.远程监控拆除信息147.11.全景成像测量摄像机业务数据信息147.12.通用摄像机业务数据信息157.13.视频在线率统计汇总数据信息168.接口定义178.1.项目申报基本交互单元信息接口178.1.1.数据查询接口178.2.工程项目基本信息接口188.2.1.数据查询接口188.3.单位工程基本信息接口198.3.1.数据查询接口198.4.远程监控安装信息接口218.4.1.数据更新接口218.4.2.数据查询接口228.5.远程监控安装设备与单位工程信息接口238.5.1.数据新增接口238.5.2.数据更新接口248.5.3.数据删除接口258.5.4.数据获取接口268.5.5.数据查询接口278.6.远程监控维护信息接口288.6.1.数据更新接口288.6.2.数据查询接口298.7.远程监控暂停信息接口308.7.1.数据更新接口308.7.2.数据查询接口318.8.远程监控恢复信息接口328.8.1.数据更新接口328.8.2.数据查询接口338.9.远程监控拆除信息接口358.9.1.数据更新接口358.9.2.数据查询接口368.10.远程监控设备安装统一接入信息接口378.10.1.全景成像测量摄像机设备接入请求378.10.2.加工场摄像机、大门出入口摄像机、塔式起重机超视野摄像机等通用摄像机设备接入请求388.10.3.环境侦测预警联动设备接入请求398.10.4.吊装设备操作员智能识别设备接入请求408.11.远程监控设备远程监控维护信息接口418.11.1.远程监控设备报修请求418.11.2.远程监控设备移机请求428.12.全景成像测量摄像机业务信息接口428.12.1.获取全景图列表接口428.12.2.获取节点图接口438.12.3.获取测量图接口448.12.4.上传全景图接口448.12.5.上传节点图接口458.12.6.上传测量图接口458.13.通用摄像机业务接口标准（应用于加工场摄像机、大门出入口摄像机、塔式起重机超视野摄像机）468.13.1.按工程项目获取通用摄像机设备列表468.13.2.通用摄像机历史视频地址请求478.13.3.通用摄像机历史视频播放请求488.13.4.通用摄像机视频截图上传请求488.14.吊装设备操作员智能识别业务接口标准498.14.1.获取智能识别设备操作人员信息498.14.2.智能识别设备认证请求508.14.3.获取操作员账号状态请求518.14.4.根据管理员ID获取认证错误列表请求528.14.5.管理员审核538.14.6.获取人员的智能识别设备操作记录548.15.环境侦测预警联动系统接口标准548.15.1.环境侦测预警联动设备信息获取548.15.2.环境侦测预警联动设备实时数据上传请求558.15.3.环境侦测预警联动设备实时数据获取568.15.4.环境侦测预警联动设备历史数据获取578.15.5.环境侦测预警联动设备喷淋联动阈值设置588.16.钢筋质量见证取样系统接口标准598.16.1.创建见证取样任务接口598.16.2.远程视频监控测量仪抓拍图片上传接口608.16.3.手机抓拍图片上传接口618.16.4.检测机构检测员获取样品任务请求628.16.5.检测机构检测员手机拍照上传接口628.16.6.见证取样原图与送检试样图片比对认证请求638.17.视频在线率统计汇总信息接口648.17.1.福建省工程视频在线率统计汇总请求648.17.2.福建省“闽江杯”优质工程视频在线率统计汇总请求659.申报交互简述661. 编制说明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%3D6. 参数定义1.2.3.4.5.6.7.6.1. 验证参数接口调用时必须上传的权限验证参数，所以在接口定义的请求参数不再说明。名称说明数据类型appId互联互通中心颁发给源系统的唯一标识Stringtoken认证码=BASE64(SHA1(SHA1(appId+ timestamp+ secret)secret为SDIC颁发给BAS的密钥Stringtimestamp当前时间戳 String6.2. 请求值在业务数据新增、更新业务数据的时候，将请求参数格式话为json对象，json对象作为字符串提交。业务数据json标准：sourceId:xxxxxxcorpCode:xxxxxxcorpName : 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.jpg6.3.1.2. 异常返回数据标准result:false,error:错误描述,error_code:000006.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年至今的符合条件的项目数据（草稿、退回、提交（审核中）、待确认、已确认、竣工提交（审核中）、审核通过（在建）、暂停、完工、竣工）都补充上传到互联互通中心。字段名称字段代码字段类型字段长度小数位数约束条件备注项目名称prjNamevarchar2000M项目省代码provincePrjNumvarchar30M项目主键proIdvarchar64M建设单位机构代码corpCodevarchar25M建设单位机构名称corpNamevarchar200M项目创建日期createDateDate07.2. 工程项目基本信息该工程信息库在互联互通中心只包含工程项目状态为：审核通过在建、暂停、完工、竣工的项目信息。如果想获取除7.1信息外的其他字段信息可以通过查询8.2的接口获取7.2的工程项目基本信息（比如质量监督站名称，安全监督站名称等等）。字段名称字段代码字段类型字段长度小数位数约束条件备注项目编号prjNumvarchar20M详见编码规则项目编号（省编号）provincePrjNumvarchar20M工程所属地prjBelongAddrvarchar100工程所在地prjLocalAddrvarchar100项目名称prjNamevarchar200M建设单位名称buildCorpNamevarchar200M建设单位组织机构代码buildCorpCodevarchar15M建设单位负责人buildPersonNamevarchar20M建设单位负责人电话buildPersonPhonevarchar20O项目所在省provinceNumintM详见数据字典表TBXZQDMDIC项目所在地市cityNumintM详见数据字典表TBXZQDMDIC项目所在区县countyNumintM详见数据字典表TBXZQDMDIC当前工程状态prjStatusvarchar6M记录登记时间createDatedateM7.3. 单位工程基本信息字段名称字段代码字段类型字段长度小数位数约束条件备注项目编号prjNumvarchar20M详见编码规则项目编号（省编号）provincePrjNumvarchar20M项目IdproIdvarchar64M单位工程IditemIdVarchar64M单位工程名称singleProNamevarchar1000M单位工程类别singleProTypevarchar50建筑高度archHeightdecimal154建筑面积archAreadecimal 154市政长度muniLengthdecimal 154状态itemStatusvarchar60.000以上层数structUpfloorNumdecimal 1540.000以下层数structDwfloorNumdecimal 1547.4. 远程监控安装信息该信息由施工单位在“动态系统”进行申报，并上传到互联互通中心，远程监控系统在从互联互通中心通过8.3的查询接口进行下载获取。当服务运营商安装结束后，远程监控系统调用互联互通中心8.3的更新接口，把完成时间、备注等相关数据返回到互联互通中心。字段名称字段代码字段类型字段长度小数位数约束条件备注申报IddcPkvarchar64M项目名称prjNamevarchar2000M动态系统登记项目省代码provincePrjNumvarchar30M动态系统登记监管系统项目主键proIdvarchar64M动态系统登记远程监控系统项目主键detectProIdvarchar64动态系统登记服务运营商serviceOperatorvarchar20M动态系统登记电信、移动、联通申报时间declareDatedatetimeM动态系统登记申报备注declareRemarkvarchar2000M动态系统登记申报施工单位组织机构代码corpCodevarchar15M动态系统登记申报施工单位名称corpNamevarchar200M动态系统登记新增计划安装完成时间planInstallDatedatetime动态系统产生申报时间+30天实际安装完成时间actualInstallDatedatetime远程监控系统返回安装备注installRemarkvarchar2000远程监控系统返回7.5. 远程监控设备安装接入数据信息该信息由远程监控系统登记，远程监管系统调用8.10下的4个接口时，会自动生成这张表数据。字段名称字段代码字段类型字段长度小数位数约束条件备注项目省代码provincePrjNumvarchar30M项目主键proIdvarchar64M远程监控系统项目主键detectProIdvarchar64施工单位组织机构代码corpCodevarchar15M施工单位名称corpNamevarchar200M新增设备编号devIdvarchar64M设备名称devNamevarchar128M设备安装位置devInstalPlacevarchar128设备运行参数配置devPlayConfigvarchar100设备型号devUnitTypevarchar64设备类型devTypevarchar16M1:全景成像测距摄像机2:加工场摄像机3:大门出入口摄像机4:吊装设备操作员智能识别设备5:塔式起重机超视野摄像机6:环境侦测预警联动设备流程状态devFlowStatevarchar16开通时间devDateStartUsedatetime拆机时间devDateUninstalldatetime7.6. 远程监控设备与单位工程绑定信息该信息由远程监控系统登记，远程监管系统调用8.5下的接口来生成。字段名称字段代码字段类型字段长度小数位数约束条件备注项目省代码provincePrjNumvarchar30项目IdproIdvarchar64M远程监控系统项目主键detectProIdvarchar64设备编号devIdvarchar64M单位工程IditemIdvarchar64M7.7. 远程监控维护信息该信息由施工单位在“动态系统”进行申报，并上传到互联互通中心，远程监控系统在从互联互通中心通过8.6的查询接口进行下载获取。当服务运营商维护结束后，远程监控系统调用互联互通中心8.6的更新接口，把故障原因、实际维护完成时间、备注等相关数据返回到互联互通中心。字段名称字段代码字段类型字段长度小数位数约束条件备注项目名称prjNamevarchar2000M动态系统登记项目省代码provincePrjNumvarchar30M动态系统登记监管系统项目主键proIdvarchar64M动态系统登记远程监控系统项目主键detectProIdvarchar64动态系统登记服务运营商serviceOperatorvarchar20M动态系统登记电信、移动、联通施工单位组织机构代码corpCodevarchar15M动态系统登记施工单位名称corpNamevarchar200M动态系统登记设备编号devIdvarchar64M动态系统登记报修时间maintainDatedatetime6M动态系统登记报修备注maintainRemarkvarchar2000M动态系统登记计划维护完成时间planMaintainDatedatetime6动态系统登记实际维护完成时间actualMaintainDatedatetime6远程监控系统返回维护说明maintainDescribevarchar2000远程监控系统返回故障原因reasonvarchar100M远程监控系统返回字典，选项有：非设备故障、设备故障、断电、其他等。如果是设备故障，还要求输入实际维护完成时间7.8. 远程监控暂停信息该信息由施工单位在“动态系统”进行申报，并上传到互联互通中心，远程监控系统从互联互通中心通过8.7的查询接口进行下载获取。当服务运营商暂停设备运行后，远程监控系统调用互联互通中心提供的8.7的更新接口，把实际暂停时间、备注等相关数据返回到互联互通中心。字段名称字段代码字段类型字段长度小数位数约束条件备注项目名称prjNamevarchar2000M动态系统登记项目省代码provincePrjNumvarchar30M动态系统登记监管系统项目主键proIdvarchar64M动态系统登记远程监控系统项目主键detectProIdvarchar64动态系统登记服务运营商serviceOperatorvarchar20M动态系统登记电信、移动、联通施工单位组织机构代码corpCodevarchar15M动态系统登记施工单位名称corpNamevarchar200M动态系统登记设备编号devIdvarchar64M动态系统登记暂停申请时间pauseDeclareDatedatetimeM动态系统登记申请备注declareRemarkvarchar2000M动态系统登记审核通过时间passDatedatetime动态系统登记实际暂停时间actualPauseDatedatetime远程监控系统返回暂停备注pauseRemarkvarchar2000远程监控系统返回7.9. 远程监控恢复信息该信息由施工单位在“动态系统”进行申报，并上传到互联互通中心，远程监控系统从互联互通中心通过8.8的查询接口进行下载获取。当服务运营商恢复设备运行后，远程监控系统调用互联互通中心提供的8.8的更新接口，把实际恢复时间、备注等相关数据返回到互联互通中心。字段名称字段代码字段类型字段长度小数位数约束条件备注项目名称prjNamevarchar2000M动态系统登记项目省代码provincePrjNumvarchar30M动态系统登记监管系统项目主键proIdvarchar64M动态系统登记远程监控系统项目主键detectProIdvarchar64动态系统登记服务运营商serviceOperatorvarchar20M动态系统登记电信、移动、联通施工单位组织机构代码corpCodevarchar15M动态系统登记施工单位名称corpNamevarchar200M动态系统登记设备编号devIdvarchar64M动态系统登记恢复申请时间recoverDeclareDatedatetimeM动态系统登记恢复申请备注declareRemarkVarchar2000M动态系统登记实际恢复时间actualRecoverDatedatetimeM远程监控系统返回恢复备注recoverRemarkvarchar2000远程监控系统返回7.10. 远程监控拆除信息该信息由施工单位在“动态系统”进行申报，并上传到互联互通中心，远程监控系统从互联互通中心通过8.9的查询接口进行下载获取。当服务运营商拆除设备后，远程监控系统调用互联互通中心提供的8.9的更新接口，把实际拆除时间、备注等相关数据返回到互联互通中心。字段名称字段代码字段类型字段长度小数位数约束条件备注项目名称prjNamevarchar2000M动态系统登记项目省代码provincePrjNumvarchar30M动态系统登记监管系统项目主键proIdvarchar64M动态系统登记远程监控系统项目主键detectProIdvarchar64动态系统登记服务运营商serviceOperatorvarchar20M动态系统登记电信、移动、联通施工单位组织机构代码corpCodevarchar15M动态系统登记施工单位名称corpNamevarchar200M动态系统登记设备编号devIdvarchar64M动态系统登记拆除申报时间removeDeclareDatedatetimeM动态系统登记拆除备注removeRemarkvarchar2000M动态系统登记审核通过时间agreeRemoveDatedatetime动态系统登记计划拆除完成时间planRemoveDatedatetime动态系统登记审核通过时间+10天实际拆除完成时间actualRemoveDatedatetime远程监控系统返回拆除说明removeDescribevarchar2000远程监控系统返回7.11. 全景成像测量摄像机业务数据信息字段名称字段代码字段类型字段长度小数位数约束条件备注项目省代码provincePrjNumstring30M项目主键proIdstring64M远程监控系统项目主键detectProIdvarchar64设备编号DevIdstring64M单位工程名称DevInstalPlacestring128图片Url地址Urlstring256图片类型CapPicTypestring161:全景图 4:拼接图2:节点图 5:其他图3:测量图图片生成时间CapPicDatedatetime测量点激光距离(mm)Obdint测量点激光光强LaserIntensityfloat测量点经度(精度7位小数)lngTargetedfloat测量点纬度(精度7位小数)latTargetedfloat测量点标高(mm)HighTargetedint7.12. 通用摄像机业务数据信息字段名称字段代码字段类型字段长度小数位数约束条件备注项目省代码provincePrjNumstring30M项目主键proIdstring64M远程监控系统项目主键detectProIdvarchar64设备编号DevIdstring64M截图位置CapPicPlacestring128图片Url地址Urlstring256图片生成时间CapPicDatedatetime7.13. 视频在线率统计汇总数据信息字段名称字段代码字段类型字段长度小数位数约束条件备注项目省代码provincePrjNumstring30M项目主键proIdstring64M远程监控系统项目主键detectProIdstring64工程名称projnamestring512工程考核级别projgradeint0:普通工程1:闽江杯统计级别gradeTypeint1:省、2:市、3:区县监管部门superdepartmentstring128考核开始时间assessbegDatestring32考核结束时间assessendDatestring32缺勤开始时间absentebegDatestring32缺勤结束时间absenteendDatestring32满勤开始时间workfullbegDatestring32满勤结束时间workfullendDatestring32本月视频在线率crmonthOnlineRatefloat上月视频在线率lsOnlineRatefloat第一季度视频在线率firquartOnlineRatefloat第二季视频在线率secquartOnlineRatefloat第三季视频在线率thiquartOnlineRatefloat第四季视频在线率fouquartOnlineRatefloat本年度视频在线率yearOnlineRatefloat总视频在线率totalOnlineRatefloat8.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互联互通数据主键StringsourceId源系统数据主键StringupdateTime数据更新时间Stringstatus数据状态(1:新增，2:更新，4：删除)StringdataVersion数据版本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互联互通数据主键StringsourceId源系统数据主键StringupdateTime数据更新时间Stringstatus数据状态(1:新增，2:更新，4：删除)StringdataVersion数据版本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