• 登录资讯平台
首页 > 深圳智慧工地课堂 > 深圳智慧工地标准

深圳市水务局工地监测与现场监管系统接口协议

作者：程象 添加时间：2023-08-02
对接深圳住建局智慧工地平台：深圳实名制人脸识别设备，深圳实名制通道，深圳工地扬尘环境监测设备等智慧工地系统对接深圳住建局监管平台。联系程象科技：陈工18923455298

深圳市水务局

工地监测与现场监管系统接口协议

（2.1版本）

二○二二年一月

修改控制表

序号

修改章节

修订

类型

版本

修改内容

修改人

修改日期

审批人

审批日期

1


首版

V1.0


陈自武

2020-6-1



2


修改

V1.1

工种接口返回值修改

陈自武

2020-6-4



3


修改

V1.2

1.修改了部分描述的错误。2.RegisterEmployee可以直接修改数据重新上传

陈自武

2020-6-12



4


修改

V1.2

/CWRService/RegisterEmployee接口中必须上传 id_validdate身份证有效期限

陈自武

2020-6-18



5


修改

V1.3

优化修改管理人员接口

陈自武

2020-7-11



6


修改

V1.4

新增施工废水监测接口2.6

调整测试环境接口地址

黄紫彤

2020-12-24



7


修改

V1.5

调整2.6.2接口device_no、device_installation_date参数格式，修改设备名称字段拼写

陈泽鑫

2020-12-28



8


修改

V1.6

新增AI视频监测接口2.8

陈泽鑫

2020-12-31



9


修改

V1.8

添加设备接口调用顺序说明，接口2.5、2.6、2.71接口说明

陈泽鑫

2021-05-13



10


修改

V1.9

接口3.2.5添加体温字段

陈泽鑫

2021-07-19



11


修改

V2.0

修改正式和测试接口路径说明

陈泽鑫

2021-07-19



12


修改

V2.1

增加核酸监测

黄紫彤

2022-03-08



注：“修订类型”为“首版”、“添加”、“删除”和“修改”四种类型。

目录

一、人员实名制管理PAGEREF _Toc84853566 \h7

1实名制集成业务流程PAGEREF _Toc84853567 \h7

1.1获取项目工程信息PAGEREF _Toc84853568 \h7

1.2完善参建单位信息PAGEREF _Toc84853569 \h7

1.3获取工种岗位、人员类别等数据字典信息PAGEREF _Toc84853570 \h7

1.4上报人员实名制信息PAGEREF _Toc84853571 \h7

1.5上传考勤信息PAGEREF _Toc84853572 \h8

1.6人员离场PAGEREF _Toc84853573 \h8

2实名制调用说明PAGEREF _Toc84853574 \h8

2.1集成方式PAGEREF _Toc84853575 \h8

2.2调用方式说明PAGEREF _Toc84853576 \h9

2.3调用参数PAGEREF _Toc84853577 \h9

2.4错误码一览表PAGEREF _Toc84853578 \h10

3实名制接口调用PAGEREF _Toc84853579 \h11

3.1实名制模块提供的服务(基础数据)PAGEREF _Toc84853580 \h11

3.2实名制模块提供的服务(数据调用)PAGEREF _Toc84853581 \h17

二、设备监测信息管理PAGEREF _Toc84853582 \h27

1设备监测调用说明PAGEREF _Toc84853583 \h27

1.1调用介绍PAGEREF _Toc84853584 \h27

1.2调用方式说明PAGEREF _Toc84853585 \h27

1.3调用参数PAGEREF _Toc84853586 \h28

1.3.1系统参数PAGEREF _Toc84853587 \h28

1.3.2注意事项PAGEREF _Toc84853588 \h28

1.3.3签名signaturePAGEREF _Toc84853589 \h29

1.4错误码一览表PAGEREF _Toc84853590 \h29

1.5注意事项PAGEREF _Toc84853591 \h31

2设备监测接口调用PAGEREF _Toc84853592 \h31

2.1配电箱PAGEREF _Toc84853593 \h31

2.1.1上报配电箱参数PAGEREF _Toc84853594 \h31

2.1.2上报配电箱状态PAGEREF _Toc84853595 \h34

2.2车辆管理PAGEREF _Toc84853596 \h37

2.2.1车辆进出场数据PAGEREF _Toc84853597 \h37

2.3塔式起重机PAGEREF _Toc84853598 \h40

2.3.1上报塔式起重机基本信息PAGEREF _Toc84853599 \h40

2.3.2上报塔式起重机参数信息PAGEREF _Toc84853600 \h43

2.3.3上报塔式起重机实时数据PAGEREF _Toc84853601 \h46

2.3.4上报塔机预警数据PAGEREF _Toc84853602 \h49

2.3.5上报塔机工作循环数据PAGEREF _Toc84853603 \h53

2.3.6上报塔机通电时间接口PAGEREF _Toc84853604 \h55

2.3.7上报塔机司机打卡记录信息PAGEREF _Toc84853605 \h57

2.4施工升降机PAGEREF _Toc84853606 \h59

2.4.1上报升降机基本信息PAGEREF _Toc84853607 \h59

2.4.2上报升降机参数信息PAGEREF _Toc84853608 \h62

2.4.3上报升降机实时数据PAGEREF _Toc84853609 \h64

2.4.4上报升降机操作记录PAGEREF _Toc84853610 \h68

2.4.5上报升降机通电时间接口PAGEREF _Toc84853611 \h70

2.5环境监测PAGEREF _Toc84853612 \h72

2.5.1环境监测实时数据PAGEREF _Toc84853613 \h72

2.5.2上报环境监测设备基本信息PAGEREF _Toc84853614 \h75

2.6施工废水监测PAGEREF _Toc84853615 \h77

2.6.1废水监测实时数据PAGEREF _Toc84853616 \h77

2.6.2上报水污染监测设备基本信息PAGEREF _Toc84853617 \h79

2.7图片文件上传PAGEREF _Toc84853618 \h81

2.7.1图片上传PAGEREF _Toc84853619 \h81

2.8AI视频监测PAGEREF _Toc84853620 \h84

2.8.1上传报警数据PAGEREF _Toc84853621 \h84

设备接口PAGEREF _Toc84853622 \h86

2.9设备拆除接口PAGEREF _Toc84853623 \h86

3设备监测数据字典PAGEREF _Toc84853624 \h88

3.1通行方式字典表PAGEREF _Toc84853625 \h88

3.2设备类型字典表PAGEREF _Toc84853626 \h89

3.3区域字典表PAGEREF _Toc84853627 \h89

3.4车辆类型字典表PAGEREF _Toc84853628 \h89

3.5单位描述PAGEREF _Toc84853629 \h89

三、对接说明PAGEREF _Toc84853630 \h91

1接口文档说明PAGEREF _Toc84853631 \h91

2联系方式PAGEREF _Toc84853632 \h92

3修改说明PAGEREF _Toc84853633 \h92

一、 人员实名制管理

1 实名制集成业务流程

深圳市水务局工地监测与现场监管系统（以下简称“工地监管系统”）是深圳市水务局推行工地监测与现场监管的总体信息平台，各项目自建系统(以下简称“项目级实名制系统”)通过与工地监管系统集成，获得工种、人员类别等数据字典信息；同时将项目级实名制系统中的项目、工程、单位信息，人员实名制信息、考勤信息上报到工地监管系统。

1.1获取项目工程信息

各项目从工地监管系统获取项目工程编码。

1.2完善参建单位信息

项目级实名制系统上传项目工程参建单位关系到工地监管系统。

1.3获取工种岗位、人员类别等数据字典信息

项目级实名制系统通过集成接口获得工种岗位、人员类别等数据字典信息，用于上报人员实名制信息。

1.4上报人员实名制信息

项目级实名制系统通过集成接口将本系统中的人员实名制信息上报到工地监管系统中。上报的实名制信息包括：项目编号、工程编号、身份证号码、身份证照片、员工姓名、手机号、身份证地址、民族、通行时段、现场采集人脸照片、所属单位、班组名称、人员类别、工种/岗位类别、工种名称、签发机关、有效期限、开户银行、银行账户等。

1.5上传考勤信息

项目级实名制系统通过集成接口将本系统中的考勤信息上报到本系统，采用实时上报的方式。上传的考勤信息包括：项目编号、工程编号、门禁设备号、人员身份证号、人员姓名、通行方向、通行方式以及现场采集的人脸照片等。

1.6人员离场

项目级实名制系统通过集成接口将本系统中的人员离场信息上传到本系统中。离场信息包括：项目编号、工程编号、企业统一社会信用代码、离场人员身份证号等。

2 实名制调用说明

2.1集成方式

采用Http请求方式，REST风格进行集成接口的访问。项目级实名制系统按照接口规范拼装一个正确的URL，通过HTTP请求到本系统实名制接口。调用原理示意图如下。

深圳市水务局工地监测与现场监管系统接口协议(图1) 

2.2调用方式说明

URL地址

http://{host}//yyyyService/APIfunction?api_key=x1&api_version=x2& client_serial =x3timestamp =x4&signature=x5

Encoding

UTF-8

Method

POST

Body

JSON数据

返回

JSON数据

2.3调用参数

调用API ，必须传入系统参数和应用参数。

系统参数

api_key

String

Y

授权帐号

api_version

String

Y

API协议版本，可选值:1.0

client_serial

String

Y

为了与之前的系统兼容而保留的字段。client_serial的值等于api_key的值

timestamp

String

Y

时间戳，格式为yyyy-MM-dd hh:mm:ss，例如：2016-06-06 13:52:03。服务端允许客户端请求时间误差为6分钟

signature

String

Y

对API输入参数进行MD5加密获得

应用参数

应用参数放在body数据区

签名signature

使用系统默认MD5加密，因为各语言语法不一致，以下实例只体现逻辑。为便于说明，假设 api_key、api_secret值均为 test。body区的数据项对应的json key为”body”，value为整个body原始字符串。

1）所有参数为：

       api_key=test

       api_version=1.0

       client_serial=facedevice_0613

       timestamp=2016-06-10 09:05:03

       body={client_version:1.1.0.0}

2）按照参数名称升序排列：

       api_sercert=tsert

       api_key=test

       api_version=1.0

       body={client_version:1.1.0.0}

       client_serial=facedevice_0613

       timestamp=2016-06-10 09:05:03

 3）连接字符串

       连接参数名与参数值,并在首尾加上api_secret，如下：

tsertapi_keytestapi_version1.0body{client_version:1.1.0.0}client_serialfacedevice_0613timestamp2016-06-10 09:05:03tsert

若无应用参数时body为{}如下：

tsertapi_keytestapi_version1.0body{}client_serialfacedevice_0613timestamp2016-06-10 09:05:03tsert

4）生成签名：

       32位大写MD5值-<XXXXXXXXXXXXXXXXXXXX

5）拼装HTTP请求

       将所有参数值转换为UTF-8编码，然后拼装，通过浏览器访问该地址，即成功调用一次接口。


注意事项

所有的请求和响应数据编码皆为utf-8格式，url里的所有参数值请做urlencode编码。

2.4错误码一览表

code

result

message

说明或解决方案

00

true

success

（接口调用成功）

11

false

error

(调用接口失败，具体信息见detail_message或result_data)

10

partial error

部分失败

具体的信息见result_data

99

false

请求数据异常

请查看详细错误信息

26

false

禁止访问接口

该用户没有权限访问，包括（1）根据API_KEY检测账号是否授权；（2）接收到的API_KEY与根据设备序号在后端查询到的API_KEY不一致时报此错误

40

false

缺少必要参数

请检查参数

41

false

非法的参数

请检查参数格式

47

false

ERROR:未找到数据

根据参数没有查询到数据，请检查参数值的正确性

48

false

数据重复

同一条数据重复发送

3 实名制接口调用

测试环境接口地址：http://szswj.thit.com.cn:9292/test-CWRService

正式环境接口地址：http://szswj.thit.com.cn:9292/CWRService

3.1实名制模块提供的服务(基础数据)

3.1.1调用API列表

API接口名称

API描述

/DictListJobName

工种名称数据字典

/GetCompanyType

单位类型数据字典

/GetTeamType

班组类型

/UploadImage

上传图片接口，返回图片的对应的值。在接口中图片文件是独立上传，然后根据返回值填到对应的接口中。

3.1.2获取工种/岗位名称数据字典  /DictListJobName

应用场景    

获取所有工种信息，如木工、混凝土工、机械操作工，等通过验证后获得系统所有班组名称及工种名称对应的工种编码；同时可以获取管理人员岗位名称。

系统中未匹配到此岗位，请更新系统工种岗位字典后，按照字典中工种岗位信息上传。不同参建单位类型的岗位对应于不同的企业类型人员入场时候的选择(针对的管理人员的入场)

输入参数

名称

类型

是否必须

描述

api_key

String

Y

授权帐号

api_version

String

Y

API协议版本，可选值:1.0

client_serial

String

Y

系统编号

timestamp

String

Y

时间戳，格式为yyyy-MM-dd hh:mm:ss，例如：2016-06-06 13:52:03。

signature

String

Y

对API输入参数进行MD5加密获得

POST的JSON数据

名称

类型

是否必须

描述

无




请求url示例

http://{host}/CWRService/DictListJobName?api_version=1.0×tamp=2017-05-16 18:14:14&client_serial=PL2C9528C3C8D84206AC5B324DBE9DF92C&signature=F467F7D16D16867264C511E3A643E4BC&api_key=DCD851F41C384EB3AE9326AD26EC667D

返回的JSON数据

名称

类型

是否必须

描述

result

String

Y

接口调用结果。true表示接口调用成功，false表示接口调用失败。

status

Integer

Y

http协议状态值

code

String

Y

应用程序错误码，详见错误码一览表

message

String

N

错误信息

detail_message

String

N

详细错误信息

result_data

Object

Y

返回结果集

成功返回的result_data结果集

名称

类型

是否必须

描述

dict_list

ObjectArray

Y

字典列表（下方三个属性为字典列表内容）

orders

String

Y

编码

value

String

Y

名称

workerPostType

String

Y

岗位类型

workerPostTypeName

String

Y

岗位类型名称

corpInfoType

String

Y

参建单位类型

corpInfoTypeName

String

Y

参建单位类型名称

失败返回的result_data结果集

名称

类型

是否必须

描述

无




返回示例

示例名称

示例说明

失败1


失败2


成功


返回状态码

状态码

返回状态码描述

解决方案




3.1.3获取单位（公司）类型数据字典  /GetCompanyType

应用场景    


获取所有单位类型，如监理单位、设计单位等，保存单位信息时获取的是单位类型的编码值。


输入参数


名称

类型

是否必须

描述


api_key

String

Y

授权帐号


api_version

String

Y

API协议版本，可选值:1.0


client_serial

String

Y

系统编号


timestamp

String

Y

时间戳，格式为yyyy-MM-dd hh:mm:ss，例如：2016-06-06 13:52:03。


signature

String

Y

对API输入参数进行MD5加密获得


POST的JSON数据


名称

类型

是否必须

描述


无





请求url示例


http://{host}/CWRService/GetCompanyType?api_version=1.0×tamp=2017-05-16 18:25:46&client_serial=PL2C9528C3C8D84206AC5B324DBE9DF92C&signature=36F8D3B2D5DF63C655ED0EE011082D5B&api_key=DCD851F41C384EB3AE9326AD26EC667D


返回的JSON数据


名称

类型

是否必须

描述


result

String

Y

接口调用结果。true表示接口调用成功，false表示接口调用失败。


status

Integer

Y

http协议状态值


code

String

Y

应用程序错误码，详见错误码一览表


message

String

N

错误信息


detail_message

String

N

详细错误信息


result_data

Object

Y

返回结果集


成功返回的result_data结果集


名称

类型

是否必须

描述


dict_list

ObjectArray

Y

字典列表（下方三个属性为字典列表内容）


orders

String

Y

编码


value

String

Y

名称


flag

String

Y

默认项标识。“Y”--默认项，”N”--非默认项

失败返回的result_data结果集

名称

类型

是否必须

描述

无




返回示例

示例名称

示例说明

失败1


失败2


失败3


成功


返回状态码

状态码

返回状态码描述

解决方案




3.1.4获取班组的类型  /GetTeamType

应用场景    


获取所有班组类型，如木工班、钢筋班、瓦工班等。


输入参数


名称

类型

是否必须

描述


api_key

String

Y

授权帐号


api_version

String

Y

API协议版本，可选值:1.0


client_serial

String

Y

系统编号


timestamp

String

Y

时间戳，格式为yyyy-MM-dd hh:mm:ss，例如：2016-06-06 13:52:03。


signature

String

Y

对API输入参数进行MD5加密获得


POST的JSON数据


名称

类型

是否必须

描述


无





请求url示例




返回的JSON数据


名称

类型

是否必须

描述


result

String

Y

接口调用结果。true表示接口调用成功，false表示接口调用失败。


status

Integer

Y

http协议状态值


code

String

Y

应用程序错误码，详见错误码一览表


message

String

N

错误信息


detail_message

String

N

详细错误信息


result_data

Object

Y

返回结果集


成功返回的result_data结果集


名称

类型

是否必须

描述


dict_list

ObjectArray

Y

字典列表（下方三个属性为字典列表内容）


orders

String

Y

编码


value

String

Y

类型名称


typeAttribute

String

Y

班组类型的值，00表示管建筑工人班组，01表示管理人员的班组类型


flag

String

Y

默认项标识。“Y”--默认项，”N”--非默认项

失败返回的result_data结果集

名称

类型

是否必须

描述

无




返回示例

示例名称

示例说明

失败1


失败2


失败3


成功


返回状态码

状态码

返回状态码描述

解决方案







3.1.5获取人员的类型/GetWorkerPersonnelType

应用场景    

和获取人员的类型的 名称和对应的值

输入参数

名称

类型

是否必须

描述

api_key

String

Y

授权帐号

api_version

String

Y

API协议版本，可选值:1.0

client_serial

String

Y

系统编号

timestamp

String

Y

时间戳，格式为yyyy-MM-dd hh:mm:ss，例如：2016-06-06 13:52:03。

signature

String

Y

对API输入参数进行MD5加密获得

POST的JSON数据

名称

类型

是否必须

描述

无




请求url示例


返回的JSON数据

名称

类型

是否必须

描述

result

String

Y

接口调用结果。true表示接口调用成功，false表示接口调用失败。

status

Integer

Y

http协议状态值

code

String

Y

应用程序错误码，详见错误码一览表

message

String

N

错误信息

detail_message

String

N

详细错误信息

result_data

Object

Y

返回结果集

成功返回的result_data结果集

名称

类型

是否必须

描述

dict_list

ObjectArray

Y

字典列表（下方三个属性为字典列表内容）

orders

String

Y

编码

value

String

Y

类型名称

3.1.6上传图片接口  /UploadImage

应用场景    

项目级实名制系统将图片文件上传到本系统，同时本系统返回对应本系统的图片ID,图片大小不超过500KB,通用接口。

输入参数

名称

类型

是否必须

描述

api_key

String

N

api_key

file

MultipartFile

Y

图片对象

POST的JSON数据

名称

类型

是否必须

描述





请求url示例

http://{host}/CWRService/UploadImage

POST的JSON数据示例


返回的JSON数据

名称

类型

是否必须

描述

result

String

Y

接口调用结果。true表示接口调用成功，false表示接口调用失败。

status

Integer

Y

http协议状态值

code

String

Y

应用程序错误码，详见错误码一览表

message

String

N

错误信息

detail_message

String

N

详细错误信息

result_data

String

Y

对应系统的图片id

成功返回的result_data结果集

名称

类型

是否必须

长度

描述











失败返回的result_data结果集

名称

类型

是否必须

描述

无




返回示例

示例名称

示例说明

失败1


失败2


失败3


成功


返回状态码

状态码

返回状态码描述

解决方案




3.2实名制模块提供的服务(数据调用)

3.2.1调用API列表

API接口名称

API描述

/AddCompany

添加工程参建单位关系

/AddTeam

新增班组

/RegisterEmployee

上报人员实名制信息

/UploadPassedLog

上传考勤信息

/userLeaveProject

人员离场  

/ProjectRemoveCompany

项目下移除单位

3.2.2添加工程参建单位关系信息  /AddCompany

应用场景    

用于添加工程参建单位关系信息

输入参数

名称

类型

是否必须

描述

api_key

String

Y

授权帐号

api_version

String

Y

API协议版本，可选值:1.0

client_serial

String

Y

系统编号

timestamp

String

Y

时间戳，格式为yyyy-MM-dd hh:mm:ss，例如：2016-06-06 13:52:03。服务端允许客户端请求时间误差为6分钟

signature

String

Y

对API输入参数进行MD5加密获得

POST的JSON数据

名称

类型

是否必须

描述

Project_ID

String

Y

工程编号

Company_Name

String

Y

企业名称

SUID

String

Y

社会统一信用代码（组织机构代码）

Legal_Person

String

Y

法定代表人

Type

String

Y

单位类型（取单位类型字典的编号，如监理单位 选择对应的编码07，建设单位选择13等）

entry_time

String

Y

入场时间:yyyy-MM-dd hh:mm:ss

请求url示例


POST的JSON数据示例


返回的JSON数据

名称

类型

是否必须

描述

result

String

Y

接口调用结果。true表示接口调用成功，false表示接口调用失败。

status

Integer

Y

http协议状态值

code

String

Y

应用程序错误码，详见错误码一览表

message

String

N

错误信息

detail_message

String

N

详细错误信息

result_data

Object

Y

返回结果集

成功返回的result_data结果集

名称

类型

是否必须

长度

描述

无





失败返回的result_data结果集

名称

类型

是否必须

描述

无




返回示例

示例名称

示例说明

失败1


失败2


失败3


成功


返回状态码

状态码

返回状态码描述

解决方案




3.2.3新增班组信息  /AddTeam

应用场景    

项目级实名制系统将班组信息上传到智慧工地平台

输入参数

名称

类型

是否必须

描述

api_key

String

Y

授权帐号

api_version

String

Y

API协议版本，可选值:1.0

client_serial

String

Y

系统编号

timestamp

String

Y

时间戳，格式为yyyy-MM-dd hh:mm:ss，例如：2016-06-06 13:52:03。服务端允许客户端请求时间误差为6分钟

signature

String

Y

对API输入参数进行MD5加密获得

POST的JSON数据

名称

类型

是否必须

描述

Project_ID

String

Y

工程编号

team_name

String

Y

班组的名称

team_type_order

String

Y

班组类型order，来自3.14接口

team_type_name

String

Y

班组类型名称，来自3.14接口

emp_company

String

Y

所属单位名称（填写单位的全称，以实名制系统录入的为准）。

SUID

String

Y

所属单位社会统一信用代码

team_personnel_type

String

Y

建筑工人班组：00

管理人员班组值为01

请求url示例


POST的JSON数据示例


返回的JSON数据

名称

类型

是否必须

描述

result

String

Y

接口调用结果。true表示接口调用成功，false表示接口调用失败。

status

Integer

Y

http协议状态值

code

String

Y

应用程序错误码，详见错误码一览表

message

String

N

错误信息

detail_message

String

N

详细错误信息

result_data

Object

Y

返回结果集

成功返回的result_data结果集

名称

类型

是否必须

长度

描述

team_id

String

Y

32

班组的系统唯一id

team_name

String

Y

32

班组名称

失败返回的result_data结果集

名称

类型

是否必须

描述

无




返回示例

示例名称

示例说明

失败1


失败2


失败3


成功


返回状态码

状态码

返回状态码描述

解决方案




3.2.4上报人员实名制信息  /RegisterEmployee

应用场景    

项目级实名制系统将人员实名制信息上传到智慧工地平台，同一个身份证号码第一次上传为新增。系统中身份证号是唯一的标识，不能传错。

说明：如果上报人员实名制的数据有误，可以直接修改数据重新上传，系统会更新数据，即新增和修改接口一致。

输入参数

名称

类型

是否必须

描述

api_key

String

Y

授权帐号

api_version

String

Y

API协议版本，可选值:1.0

client_serial

String

Y

系统编号

timestamp

String

Y

时间戳，格式为yyyy-MM-dd hh:mm:ss，例如：2016-06-06 13:52:03。服务端允许客户端请求时间误差为6分钟

signature

String

Y

对API输入参数进行MD5加密获得

POST的JSON数据

名称

类型

是否必须

描述

Project_ID

String

Y

同步编号(工程编号)

id_code

String

Y

身份证号码

id_photo

String

Y

上传的图片ID，图片为身份证头像

emp_name

String

Y

员工姓名

emp_phone

String

Y

手机号

emp_nativeplace

String

Y

身份证地址

emp_nation

String

Y

民族(如：汉、苗、土家、维吾尔等)

pass_period

String

Y

入场时间：yyyy-MM-dd hh:mm:ss

match_flag

String

Y

匹配标识。’ Y’—人证匹配，’N’—不匹配，3次采集比对都没通过

facephoto

String

Y

上传的图片ID，图片为采集的人员照片

emp_company

String

Y

所属单位（填写单位的全称，以实名制系统录入的为准）。

SUID

String

Y

所属单位社会统一信用代码

team_id

String

Y

班组id

team_name

String

Y

班组的名称

emp_category

String

Y

人员类型 参考3.1.5中的返回值：orders

cwr_iskeypsn

String

N

重要人员。"1"--是，"0"--不是。

emp_dept

String

N

所属部门(人员所在单位下的部门名称)。

job_order

String

Y

工种编号参考工种数据字典3.1.2， 

job_name

String

Y

工种名称，参考工种数据字典3.1.2， 

contract_status

String

Y

人员和参加单位是否已经签合同。合同办理。"1"—是，"0"—否。

id_agency

String

Y

签发机关。

id_validdate

String

Y

身份证有效期限。按身份证上显示格式。案例：2014.04.03-2024.04.03

emp_bankname

String

N

开户行

emp_cardnum

String

N

银行账号

job_dept

String

N

现工作部门。(人员所在单位下的部门名称)。

请求url示例

http://{host}/CWRService/RegisterEmployee?api_version=1.0×tamp=2017-03-07 10:19:29&client_serial=PL2C9528C3C8D84206AC5B324DBE9DF92C&signature=88FD1C1DDA91ACEB6ECC17255BCBDCBA&api_key=DCD851F41C384EB3AE9326AD26EC667D

POST的JSON数据示例

{"Project_ID":"1000001","eng_code":"44444","id_code":"3708021992110112","id_photo":"/9j/4AAQSk","emp_name":"张三","emp_phone":"1888888888","emp_nativeplace":"陕西省石泉县城关镇东街片七组173号","emp_nation":"汉","pass_period":"2017-01-01:2018-01-01","match_flag":"Y","facephoto":"wxHvRXgZcqeKKOVCuz/9k=","emp_company":"中车信息技术有限公司","work_typename":"0","emp_category":"1","cwr_iskeypsn":"1","emp_dept":"技术部1","job_typename":"00","job_name":"EEF22645FEE411E68E5A089E016627F6","contract_status":"1","id_agency":"陕西省石泉县城关镇东街片七组173号","id_validdate":"2008.02.14-2028.02.14","emp_native_province":"陕西","emp_bankname":"建设银行","emp_cardnum":"6217002710000684874","job_dept":"技术部","idphoto_scan":"JAHGJ123","idphoto_scan2":"JAHGJ1JKK/1223"}

返回的JSON数据

名称

类型

是否必须

描述

result

String

Y

接口调用结果。true表示接口调用成功，false表示接口调用失败。

status

Integer

Y

http协议状态值

code

String

Y

应用程序错误码，详见错误码一览表

message

String

N

错误信息

detail_message

String

N

详细错误信息

result_data

Object

Y

返回结果集

成功返回的result_data结果集

名称

类型

是否必须

长度

描述

emp_id

String

Y

32

员工工号

pass_period

String

Y

32

通行时段，格式yyyy-MM-dd:yyyy-MM-dd

modify_time

String

Y

32

修改时间,”yyyy-MM-dd hh:mm:ss.zzz”

失败返回的result_data结果集

名称

类型

是否必须

描述

无




返回示例

示例名称

示例说明

失败1


失败2


失败3


成功


返回状态码

状态码

返回状态码描述

解决方案




3.2.5上传考勤信息 /UploadPassedLog

应用场景    

项目级实名制系统向智慧工地平台发送工人通行日志。按照深圳市实名制分账制规定实时上传考勤数据，实时误差范围(上传时间减去考勤通过时间)为1小时，工务工地监管系统考勤数据误差范围为30分钟。工程状态非“在建”，不允许上传。

输入参数

名称

类型

是否必须

描述

api_key

String

Y

授权帐号

api_version

String

Y

API协议版本，可选值:1.0

client_serial

String

Y

系统编号

timestamp

String

Y

时间戳，格式为yyyy-MM-dd hh:mm:ss，例如：2016-06-06 13:52:03。服务端允许客户端请求时间误差为6分钟

signature

String

Y

对API输入参数进行MD5加密获得

POST的JSON数据：

名称

类型

是否必须

描述

Project_ID

String

Y

工程编号

Device_ID

String

Y

门禁设备序列号

passedlog_list

Object Array

Y

通行日志数组(下方所有属性为通行日志数组内容)


data_id

String

Y

数据的唯一id,用于幂等校验(生成规则：api_key+32位的UUID)，如果data_id相同视为同一条数据，那么系统不会重复保存，只会保存第一条推送成功的数据。


person_type

String

N

通行人员类型。0—临时人员（访客），1—员工


person_id

String

Y

身份证号


person_name

String

Y

人员姓名


passed_time

String

Y

通过时间”yyyy-MM-dd hh:mm:ss”


direction

String

Y

通行方向  in—进，out—出


way

String

Y

通行方式 1—人脸识别 


site_photo

String

Y

图片id，图像底部带过闸时间水印，黑底白字


longitude

String

N

经度


latitude

String

N

纬度


address

String

N

位置（打考勤时所在的详细地址）


temperature

Number

N

体温

无




请求url示例

http://{host}/CWRService/UploadPassedLog?api_version=1.0×tamp=2017-03-07 10:21:32&client_serial=PL2C9528C3C8D84206AC5B324DBE9DF92C&signature=B6876A3560308EE8D3CF2B4469AA0C09&api_key=DCD851F41C384EB3AE9326AD26EC667D

POST的JSON数据示例

{"Project_ID":"440300201500303","Device_ID":"1","passedlog_list":[{"person_type":"1","person_id":"1","person_name":"fh","passed_time":"2017-03-29 12:12:12","direction":"in","way":"1","site_photo":"xVmxVbXVVaGN2emswdUJiT0QxU1dienArNFozVi9URn"},{"person_type":"1","person_id":"1","person_name":"fh","passed_time":"2017-03-29 16:12:12","direction":"out","way":"1","site_photo":"xVmxVbXVVaGN2emswdUJiT0QxU1dienArNFozVi9URn"}]}

返回的JSON数据

名称

类型

是否必须

描述

result

String

Y

接口调用结果。true表示接口调用成功，false表示接口调用失败。

status

Integer

Y

http协议状态值

code

String

Y

应用程序错误码，详见错误码一览表

message

String

N

错误信息

detail_message

String

N

详细错误信息

result_data

Object

Y

返回结果集

成功返回的result_data结果集

名称

类型

是否必须

描述

无




失败返回的result_data结果集

名称

类型

是否必须

描述

无




返回示例

示例名称

示例说明

失败1


失败2


失败3


成功


返回状态码

状态码

返回状态码描述

解决方案




3.2.6人员离场  /userLeaveProject

应用场景    

项目级实名制系统人员离场时需要同步修改智慧工地平台对应的人员状态。

输入参数

名称

类型

是否必须

描述

api_key

String

Y

授权帐号

api_version

String

Y

API协议版本，可选值:1.0

client_serial

String

Y

系统编号

timestamp

String

Y

时间戳，格式为yyyy-MM-dd hh:mm:ss，例如：2016-06-06 13:52:03。服务端允许客户端请求时间误差为6分钟

signature

String

Y

对API输入参数进行MD5加密获得

POST的JSON数据

名称

类型

是否必须

描述

Project_ID

String

Y

工程编号

userLeaveProject_list

Object Array

Y

用户离场数组(下方所有属性为人员数组内容)


id_code

String

Y

身份证号码


exit_time

String

Y

离场时间:yyyy-MM-dd hh:mm:ss

请求url示例

http://{host}/CWRService/ userLeaveProject?api_version=1.0×tamp=2017-03-07 10:19:29&client_serial=PL2C9528C3C8D84206AC5B324DBE9DF92C&signature=88FD1C1DDA91ACEB6ECC17255BCBDCBA&api_key=DCD851F41C384EB3AE9326AD26EC667D

POST的JSON数据示例

{"Project_ID":"440300201500303"," userLeaveProject_list ":[{"id_code":"420983199008266011"},{"id_code":"420983199008266011"}，{"SUID ":"420983ADE3"}]}

返回的JSON数据

名称

类型

是否必须

描述

result

String

Y

接口调用结果。true表示接口调用成功，false表示接口调用失败。

status

Integer

Y

http协议状态值

code

String

Y

应用程序错误码，详见错误码一览表

message

String

N

错误信息

detail_message

String

N

详细错误信息

result_data

Object

Y

返回结果集

成功返回的result_data结果集

名称

类型

是否必须

长度

描述

无





失败返回的result_data结果集

名称

类型

是否必须

描述

无




返回示例

示例名称

示例说明

失败1


失败2


失败3


成功


返回状态码

状态码

返回状态码描述

解决方案




3.2.7项目下移除企业信息  /ProjectRemoveCompany

应用场景    

用于在项目工程下移除注册的企业信息

输入参数

名称

类型

是否必须

描述

api_key

String

Y

授权帐号

api_version

String

Y

API协议版本，可选值:1.0

client_serial

String

Y

系统编号

timestamp

String

Y

时间戳，格式为yyyy-MM-dd hh:mm:ss，例如：2016-06-06 13:52:03。服务端允许客户端请求时间误差为6分钟

signature

String

Y

对API输入参数进行MD5加密获得

POST的JSON数据

名称

类型

是否必须

描述

Project_ID

String

Y

工程编号

Company_Name

String

Y

企业名称

SUID

String

Y

社会统一信用代码（组织机构代码）

exit_time

String

Y

离场时间:yyyy-MM-dd hh:mm:ss

请求url示例


POST的JSON数据示例


返回的JSON数据

名称

类型

是否必须

描述

result

String

Y

接口调用结果。true表示接口调用成功，false表示接口调用失败。

status

Integer

Y

http协议状态值

code

String

Y

应用程序错误码，详见错误码一览表

message

String

N

错误信息

detail_message

String

N

详细错误信息

result_data

Object

Y

返回结果集

成功返回的result_data结果集

名称

类型

是否必须

长度

描述

无





失败返回的result_data结果集

名称

类型

是否必须

描述

无




返回示例

示例名称

示例说明

失败1


失败2


失败3


成功


返回状态码

状态码

返回状态码描述

解决方案




二、 设备监测信息管理

1 设备监测调用说明

1.1 调用介绍

服务调用方按照接口规范拼装一个正确的URL，通过HTTP请求到服务提供方接口，就能够拿到自己需要的数据。调用原理示意图如下（注： API <接口>采用 REST 风格，只需将所需参数拼装成http请求，即可调用。支持 http 协议请求的程序语言，均可调用API）。

通过http发送数据时，数据采用UTF-8编码。

深圳市水务局工地监测与现场监管系统接口协议(图2) 

调用顺序：先调用上报基本信息接口，再调用上报数据接口

1.2 调用方式说明

uri：http://xxxxx.com/openapi/APIfunction

测试环境接口地址：http://szswj.thit.com.cn:9292/test-openapi

正式环境接口地址：http://szswj.thit.com.cn:9292/openapi

encodeing：UTF-8

method：POST

body：json数据

返回：json数据

1.3 调用参数

调用API ，必须传入系统参数和应用参数。

1.3.1 系统参数

api_key

String

Y

api请求key

project_code

String

Y

项目编码

eng_code

String

Y

工程编码

api_version

String

Y

API协议版本，可选值:1.0

timestamp

String

Y

时间戳，格式为yyyy-MM-dd hh:mm:ss，例如：2016-06-06 13:52:03。服务端允许客户端请求时间误差为6分钟

signature

String

Y

对API输入参数进行MD5加密获得

1.3.2 注意事项

所有的请求和响应数据编码皆为utf-8格式，url里的所有参数值请做urlencode编码。

实时监控状态数据(例如:环境实时监测)，要求上报的时间间隔是1分钟(开发过程中此参数是可配置，后期可能因为政策的改变而改变)，业务数据（例如：车辆的出入，升降机的上升与下降）实时上传，告警数据立即上传。

在新增设备的接口中。设备号可以自定义32位UUID，每个设备的唯一ID。同一个设备的信息，用同一个UUID做为表示。

1.3.3 签名signature

使用系统默认MD5加密，因为各语言语法不一致，以下实例只体现逻辑。为便于说明，假设 api_key为test、project_code为001、eng_code为002。body区的数据项对应的key为“body”，value为整个body的json字符串。

1）所有参数为：

       api_key=test

       api_version=1.0

       project_code=001

       eng_code=002

       timestamp=2018-06-10 09:05:03

       body={client_version:1.1.0.0}

2）按照参数名称升序排列：

       api_key=test

       api_version=1.0

       body={client_version:1.1.0.0}

       eng_code=002

       project_code=002

       timestamp=2018-06-10 09:05:03

 3）连接字符串

       连接参数名与参数值，如下：

api_keytest api_version1.0 body{client_version:1.1.0.0}eng_code=002project_code=002timestamp2016-06-10 09:05:03

4）生成签名：

       32位大写MD5值-<XXXXXXXXXXXXXXXXXXXX

5）拼装HTTP请求

       将所有参数值转换为UTF-8编码，然后拼装，通过浏览器访问该地址，即成功调用一次接口。

1.4 错误码一览表

错误码

错误描述-英文

错误描述-中文

解决方案

24

Missing Signature

缺少签名参数

传入的参数中必需包含signature字段

25

Invalid Signature

无效签名

签名必需根据正确的算法算出来的，详见调用参数签名章节

26

Forbidden Method

禁止访问接口

该用户没有权限访问

27

Invalid DataSigned

无效post对象

传入的POST对象签名无效

29

Invalid Api Key

无效的api_key参数

由服务器端分配给手机端

30

Missing Timestamp

缺少时间戳参数

传入的参数中必需包含timestamp参数

31

Invalid Timestamp

非法的时间戳参数

时间戳，格式为yyyy-MM-dd hh:mm:ss，例如：2008-01-25 20:23:30。API服务端允许客户端请求时间误差为10分钟

32

Missing Version

缺少版本参数

传入的参数中必需包含api_version字段

33

Invalid Version

非法的版本参数

用户传入的版本号格式错误，必需为数字格式

34

Unsupported Version

不支持的版本号

用户传入的版本号没有被提供

35

UnValid Remote IP

无效远程IP地址

联系管理员

40

Missing  Required Arguments

缺少必选参数

API文档中设置为必选的参数是必传的，请仔细核对文档

41

Invalid Arguments

非法的参数

参数类型不对，例如：需要传入的是数字类型的，却传入了字符类型的参数

43

Parameter Error

参数错误

一般是用户传入参数非法引起的，请仔细检查入参格式、范围是否一一对应

47

Invalid encoding

编码错误

一般是用户做http请求的时候没有用UTF-8编码请求造成的

50

Invalid Save

保存失败


51

Invalid Update

修改失败


52

Invalid Delete

删除失败


80

Exist Device

设备编码重复或已存在该设备


81

Not Found Device

设备不存在


00

success

成功


01


ERROR:请求超过响应时间

需检查调用方时间是否准确，必要时进行校时处理。

02


ERROR:必要条件检查失败

（特指的是客户端传入的数据有误）

02


ERROR:时间戳格式有误，请调整数值"

（特指的是客户端传入的数据有误）

02

…

…


03


无数据

ERROR:未找到数据

（特指的是服务端处理失败）

03

…

…


1.5 注意事项

l 使用数据接口的应用程序需要具备自动升级功能，以备接口后续对接口的进一步升级。

l 本接口未提出强安全和认证机制要求，应用程序应确保数据真实性和所使用的网络环境对数据传输安全性的保障。

2 设备监测接口调用

2.1 配电箱

2.1.1 上报配电箱参数 

接口信息

Method

/powerBox/addParams

Version

1.0

返回方式

响应体(JSON)

接口说明

上报配电箱参数 

输入参数

名称

类型

是否必需

备注

body

Object

    Y

配电箱参数

body对象字段

名称

类型

是否必需

备注

device_no

String

Y

设备编号

(设备号可以自定义32位UUID，每个设备的唯一ID)

type

int

Y

设备类型参考设备类型字典表

name

String

Y

设备名称:

整数#配电箱 例如：

3#配电箱

type_name

String

N

设备类型名称

install_company

String

Y

安装商

installadd_type

Int

Y

区域类型参考区域类型

install_address

String

N

安装地址

longitude

String

N

经度

latitude

String

N

纬度

photos

Array

N

设备照片

temp_limit

Double

Y

电缆温度限值(℃)

elec_limit

Int

Y

漏电流限值(mA)

around_temp

Double

Y

周围环境温度限值(℃)

photos数组内对象字段

名称

类型

是否必需

备注

photo

String

N

通过图片上传接口获得的返回值(图片路径)。

响应体字段

名称

类型

是否必需

备注

result

String

Y

接口调用结果。true表示接口调用成功，false表示接口调用失败。

code

String

Y

应用程序错误码，详见错误码一览表

message

String

N

错误信息

detail_message

String

N

详细错误信息

server_timestamp

String

Y

服务端时间，yyyy-MM-dd hh:mm:ss

result_data

Object

N

返回结果集

请求体格式示例

{

"api_key":"",

"project_code":"",

"eng_code":"",

"api_version":"",

"timestamp":"",

"signature":"",

"body":{

"device_no":"",

"type":,

"type_name":"",

"install_company":"",

"installadd_type":,

"install_address":"",

"longitude":,

"latitude":,

"photos":[

"photo1"，"photo2"

],

"temp_limit":,

"elec_limit":,

"around_temp":

}

}

响应体格式示例

{

 "result":"",

"code":,

"message":"",

"detail_message":"",

"server_timestamp":"",

"result_data":

}

2.1.2 上报配电箱状态

接口信息

Method

/powerBox/addRecord

Version

1.0

返回方式

响应体(JSON)

接口说明

暂定运行中每 60s 一次（持续报警只发送一条数据， 中断才算另一条） , 以住建局要求颁布后为准.

(以JSON数组方式多条记录传输，即使1条记录也用数组方式传输，但最多不超过20条

输入参数

名称

类型

是否必需

备注

body

Array

Y

配电箱状态列表

body数组内对象字段

名称

类型

是否必需

备注

device_no

String

Y

设备编号

operate_time

String

Y

格式yyyy-MM-dd hh:mm:ss

status

int

Y

0：正常

1：报警

2：未连接

4：故障

8：屏蔽流+温 感)

warn_type

Int

Y

0 表示无报警，1 表示漏电报警，

2 表示温度报警，3 表示两者都报警

warn_id

String

Y

WARN_TYPE 不等于 0 时此字段必填，唯一标识，同一次报警 ID 相同

cable_a_temp

Double

Y

线缆 a 温度(℃)

cable_b_temp

Double

Y

线缆b温度(℃)

cable_c_temp

Double

Y

线缆c温度(℃)

cable_n_temp

Double

N

线缆n温度(℃)

elec_limit

Double

Y

漏电流（毫安mA）

env_temp

Double

Y

周围环境温度(℃)

channels

Array

N

回路信息

channels数组内对象字段

名称

类型

是否必需

备注

channel_num

int

N

回路号

data_type

int

N

回路类型

0：无；

1：温度，单位摄氏度，有小数；

2：漏电流，单位毫安，无小数；

3：电流，单位为 A（A,B,C 相顺序上 传）

4：开关

channel_value

double

N

回路值

响应体字段

名称

类型

是否必需

备注

result

String

Y

接口调用结果。true表示接口调用成功，false表示接口调用失败。

code

String

Y

应用程序错误码，详见错误码一览表

message

String

N

错误信息

detail_message

String

N

详细错误信息

server_timestamp

String

Y

服务端时间，yyyy-MM-dd hh:mm:ss

result_data

Object

N

返回结果集

请求体格式示例

{

"api_key":"",

"project_code":"",

"eng_code":"",

"api_version":"",

"timestamp":"",

"signature":"",

"body":[

{

"device_no":"",

"operate_time":"",

"status": ,

"warn_type":,

"warn_id":"",

"cable_a_temp": ,

"cable_b_temp": ,

"cable_c_temp": ,

"cable_n_temp": ,

"elec_limit": ,

"env_temp": ,

"channels":[

{

"channel_num": ,

"channel_type": ,

"channel_value":

},

{

"channel_num": ,

"channel_type": ,

"channel_value":

}

]

}

]

}

响应体格式示例

{

 "result":"",

"code":,

"message":"",

"detail_message":"",

"server_timestamp":"",

"result_data":

}

2.2 车辆管理

2.2.1 车辆进出场数据

接口信息

Method

/vehicle/uploadData

Version

1.0

返回方式

响应体(JSON)

接口说明

车辆进出场数据:

就是先上传图片，然后返回路径，然后用这个路径去上传车辆的出入信息。

输入参数

名称

类型

是否必需

备注

body

Array

Y

车辆进出场列表

body数组内对象字段

名称

类型

是否必需

备注

type

Int

Y

车辆类型(车辆类型字典表)

plate_number

String

Y

车牌号

direction

int

Y

0.出 1.进

color

Int

N

车牌颜色：1-蓝，2-黄，3-黑，4-白，9-其他

gate_no

String

Y

闸机编号

region_no

String

Y

区域编号

region_type

int

Y

区域类型：1-工地，2-受纳场所

region_name

String

N

经区域名称

lift_type

int

N

抬杆方式：1-自动，2-手动

lift_time

String

Y

进出场时间

images

Array

Y

过闸照片

images数组内对象字段

名称

类型

是否必需

备注

img_type

Int

Y

图片类型：1-车头，2-车身

img_data

String

Y

通过图片上传接口获得的返回值(图片路径)。

响应体字段

名称

类型

是否必需

备注

result

String

Y

接口调用结果。true表示接口调用成功，false表示接口调用失败。

code

String

Y

应用程序错误码，详见错误码一览表

message

String

N

错误信息

detail_message

String

N

详细错误信息

server_timestamp

String

Y

服务端时间，yyyy-MM-dd hh:mm:ss

result_data

Object

N

返回结果集

请求体格式示例

{

"api_key":"",

"project_code":"",

"eng_code":"",

"api_version":"",

"timestamp":"",

"signature":"",

"body":[

{

"device_no":"" ,

"type": ,

" plate_number ":"",

"direction": ,

"color": ,

"gate_no":"",

"region_no":"",

"region_type": ,

"region_name":"" ,

"lift_type": ,

"lift_time":""

}

]

}

响应体格式示例

{

 "result":"",

"code":,

"message":"",

"detail_message":"",

"server_timestamp":"",

"result_data":

}

2.3 塔式起重机

2.3.1 上报塔式起重机基本信息  

接口信息

Method

/crane/addBasicInfo

Version

1.0

返回方式

响应体(JSON)

接口说明

上报塔式起重机基本信息

输入参数

名称

类型

是否必需

备注

body

Object

Y

塔式起重机基本信息

body对象字段

名称

类型

是否必需

备注

device_no

String

Y

设备编号

(设备号可以自定义32位UUID，每个设备的唯一ID)

model

String

N

设备型号

name

String

Y

设备名称:

整数#塔式起重机 例如：

13#塔式起重机

uid

String

N

设备用户名称(如:2号塔机)

license

String

N

设备证书日期

license_start_date

String

N

设备发证日期

license_end_date

String

N

设备有效日期

property_unit

String

N

设备产权单位

mnufacturer_business

String

N

设备制造商

mai_war_bus

String

N

设备维保商

testing_business

String

N

设备检测商

in_date

String

N

设备进场时间

out_date

String

N

设备出场时间

mon_device_man

String

Y

监测设备厂商

device_installation_date

String

N

监测设备安装日期

guangdong_install_num

String

Y

广东省统一安装告知编号（产权备案编号）例如：

粤BE-S03981

photos

Array

N

设备照片

photos数组内对象字段

名称

类型

是否必需

备注

photo

String

N

通过图片上传接口获得的返回值(图片路径)。

响应体字段

名称

类型

是否必需

备注

result

String

Y

接口调用结果。true表示接口调用成功，false表示接口调用失败。

code

String

Y

应用程序错误码，详见错误码一览表

message

String

N

错误信息

detail_message

String

N

详细错误信息

server_timestamp

String

Y

服务端时间，yyyy-MM-dd hh:mm:ss

result_data

Object

N

返回结果集

请求体格式示例

{

"api_key":"",

"project_code":"",

"eng_code":"",

"api_version":"",

"timestamp":"",

"signature":"",

"body":{

"device_no":"",

" model":"",

" name":"",

" uid":"",

"license":"",

"license_start_date":"",

"license_end_date":"",

"photos":"",

"property_unit":"",

" mnufacturer_business ":"",

"mai_war_bus":"",

"testing_business":"",

"in_date":"",

"out_date":"",

"mon_device_man":"",

" device_installation_date":"",

}

}

响应体格式示例

{

 "result":"",

"code":,

"message":"",

"detail_message":"",

"server_timestamp":"",

"result_data":

}

2.3.2 上报塔式起重机参数信息  

接口信息

Method

/crane/addParams

Version

1.0

返回方式

响应体(JSON)

接口说明

上报塔式起重机参数信息

输入参数

名称

类型

是否必需

备注

body

Object

Y

塔式起重机参数信息

body对象字段

名称

类型

是否必需

备注

device_no

String

Y

设备编号

model

String

N

设备型号

name

String

Y

设备名称

TC_MaxScope

Double

Y

最大幅度（M）

TC_SB_SpeedCut

Double

N

幅度前减速（M)

TC_SA_SpeedCut

Double

N

幅度后减速（M)

TC_MaxHeight

Double

Y

最大高度（M)

TC_MAX_XB_HEIGHT

Double

N

附着后最大悬臂高度

TC_MinHeight

Double

N

最小高度（M)

TC_HU_SpeedCut

Double

N

高度上减速(M)

TC_MinScope

Double

N

最小幅度（M）

TC_HB_SpeedCut

Double

N

高度下减速（M)

TC_LoadCapacity

Double

Y

最大载重（KG)

TC_MS_LoadCapacity

Double

N

最大幅度允许最大载重（KG)

TC_ML_MaxScope

Double

N

最大载重达到最大幅度（M)

TC_Multiple

Double

N

塔机倍率（M)

Tower_type

Int

N

塔机类型（0-平臂式，1-动臂式，2-其他）

load_moment

Double

Y

额定起重力矩（N·m）

响应体字段

名称

类型

是否必需

备注

result

String

Y

接口调用结果。true表示接口调用成功，false表示接口调用失败。

code

String

Y

应用程序错误码，详见错误码一览表

message

String

N

错误信息

detail_message

String

N

详细错误信息

server_timestamp

String

Y

服务端时间，yyyy-MM-dd hh:mm:ss

result_data

Object

N

返回结果集

请求体格式示例

{

"api_key":"",

"project_code":"",

"eng_code":"",

"api_version":"",

"timestamp":"",

"signature":"",

"body":{

"device_no":"",

"model":"",

"name":"",

"TC_MaxScope": ,

"TC_SB_SpeedCut": ,

"TC_SA_SpeedCut": ,

"TC_MaxHeight": ,

"TC_MAX_XB_HEIGHT": ,

"TC_MinHeight": ,

"TC_HU_SpeedCut": ,

"TC_MinScope": ,

"TC_HB_SpeedCut": ,

"TC_LoadCapacity": ,

"TC_MS_LoadCapacity": ,

"TC_ML_MaxScope": ,

"TC_Multiple": ,

"Tower_type":

}

}

响应体格式示例

{

 "result":"",

"code":,

"message":"",

"detail_message":"",

"server_timestamp":"",

"result_data":

}

2.3.3 上报塔式起重机实时数据  

接口信息

Method

/crane/addRecord

Version

1.0

返回方式

响应体(JSON)

接口说明

上报塔式起重机实时数据

暂定运行中每 20s 一次（持续报警只发送一条数据， 中断才算另一条），后期可修改

输入参数

名称

类型

是否必需

备注

body

Array

Y

塔式起重机实时数据

body数组内对象字段

名称

类型

是否必需

备注

device_no

String

Y

设备编号

runtime

String

Y

运行时,格式为yyyy-MM-dd hh:mm:ss，

load

Double

Y

载重（KG)

load_ratio

Double

Y

载重比(填小数,小于等于1，如0.8表示力矩比80%)

moment

Double

Y

力矩（KG)

moment_ratio

Double

Y

力矩比(填小数,小于等于1，如0.8表示力矩比80%)

slewing_speed

Double

Y

回转角度(°)

is_left_warning

Int

Y

是否左限位报警(0.否1.是)

is_right_warning

Int

Y

是否右限位报警(0.否1.是)

range

Double

Y

幅度（m)

is_forward_warning

Int

Y

是否前限位报警(0.否1.是)

is_backward_warning

Int

Y

是否后限位报警(0.否1.是)

height

Double

Y

吊钩限位（m) （塔吊吊钩装置顶部至小车架下端的距离）

is_up_warning

Int

Y

是否上限位报警(0.否1.是)

magnification

Double

N

倍率

work_environment

Double

N

塔机工作环境温度(℃)

real_time_flag

Int

N

实时标志(0历史数据,1实时数据)

installation_method

Int

N

安装方式

wind_speed

Double

Y

风速 m/s

collision_warn

Int

Y

防碰撞报警（0不报警，1-报警）

wind_warn

Int

Y

0/1 是否超风速作业报警（风速大于6级（大于13.8m/s） ，在连续两个工作循环工作，

发生报警）。（0不报警，1-报警）

rotation_warn

Int

Y

是否回转限位报警

（0不报警，1-报警）

card_num

String

Y

持卡卡号

operator_name

String

Y

持卡人姓名

响应体字段

名称

类型

是否必需

备注

result

String

Y

接口调用结果。true表示接口调用成功，false表示接口调用失败。

code

String

Y

应用程序错误码，详见错误码一览表

message

String

N

错误信息

detail_message

String

N

详细错误信息

server_timestamp

String

Y

服务端时间，yyyy-MM-dd hh:mm:ss

result_data

Object

N

返回结果集

请求体格式示例

{

"api_key":"",

"project_code":"",

"eng_code":"",

"api_version":"",

"timestamp":"",

"signature":"",

"body":[

{

"device_no":"",

"runtime":"",

"load":,

"load_ratio":,

"moment":,

"moment_ratio":,

"slewing_speed":,

"is_left_warning":,

"is_right_warning":,

"range":,

"is_forward_warning":,

"is_backward_warning":,

"height":,

"is_up_warning":,

"magnification":,

"work_environment":,

"real_time_flag":,

" installation_method ":,

"wind_speed":,

"card_num":"",

"operator_name":"",

}

]

}

响应体格式示例

{

 "result":"",

"code":,

"message":"",

"detail_message":"",

"server_timestamp":"",

"result_data":

}

2.3.4 上报塔机预警数据 

接口信息

Method

/crane/warning

Version

1.0

返回方式

响应体(JSON)

接口说明

上报塔机预警数据

输入参数

名称

类型

是否必需

备注

body

Array

Y

塔机预警数据

body数组内对象字段

名称

类型

是否必需

备注

device_no

String

Y

设备编号

runtime

String

Y

运行时,格式为yyyy-MM-dd hh:mm:ss，

load

Double

Y

载重（动臂式塔 机无载重，0）(单位KG)

load_ratio

Double

Y

载重比(填小数,小于等于1，如0.8表示力矩比80%)

moment

Double

Y

力矩(KG)

moment_ratio

Double

Y

力矩比(填小数,小于等于1，如0.8表示力矩比80%)

slewing_speed

Double

Y

回转角度(°)

height

Double

Y

高度(动臂式塔 机无高度,填0），单位m

range

Double

Y

幅度(°)

magnification

Int

N

倍率

sensor_status

Int

N

传感器状态（1-正常，2-停机）

normal_work_early_warn_state

Int

N

正常工作预警状态（1-正常，2-预警）

normal_work_warn_status

Int

N

正常工作报警状态（1-正常，2-预警）

region_limit_early_warn_status

Int

N

区域限制预警状态（1-无，2-预警（塔吊 进入限制区域））

region_limit_warn_status

Int

N

区域限制报警状态（1-无，2-预警（塔吊 进入限制区域））

group_tower_early_warn_status

Int

N

群塔预警状态（1-无，2-预警（交叉群塔 同时作业中））

group_tower_warn_status

Int

N

群塔报警状态（1-无，2-预警（交叉群塔 同时作业中））

wind_speed

Double

Y

风速m/s

响应体字段

名称

类型

是否必需

备注

result

String

Y

接口调用结果。true表示接口调用成功，false表示接口调用失败。

code

String

Y

应用程序错误码，详见错误码一览表

message

String

N

错误信息

detail_message

String

N

详细错误信息

server_timestamp

String

Y

服务端时间，yyyy-MM-dd hh:mm:ss

result_data

Object

N

返回结果集

请求体格式示例

{

"api_key":"",

"project_code":"",

"eng_code":"",

"api_version":"",

"timestamp":"",

"signature":"",

"body":[

{

"device_no":"",

"runtime":"",

"load":,

"load_ratio":,

"moment":,

"moment_ratio":,

"slewing_speed":,

"height":,

"range":,

"magnification":,

"sensor_status":,

"normal_work_early_warn_state":,

"normal_work_warn_status":,

"region_limit_early_warn_status":,

"region_limit_warn_status":,

"group_tower_early_warn_status":,

"group_tower_warn_status":,

"wind_speed":

}

]

}

响应体格式示例

{

 "result":"",

"code":,

"message":"",

"detail_message":"",

"server_timestamp":"",

"result_data":

}

2.3.5 上报塔机工作循环数据

接口信息

Method

/crane/workLoop

Version

1.0

返回方式

响应体(JSON)

接口说明

上报塔机工作循环数据

输入参数

名称

类型

是否必需

备注

body

Array

Y

工作循环数据

body数组内对象字段

名称

类型

是否必需

备注

device_no

String

Y

设备编号

start_time

String

Y

工作循环开始时刻

end_time

String

Y

工作循环结束时刻

max_moment_ratio

Double

Y

最高力矩比

0.8(表示载重比80%)

exceeding_num

Double

N

超力矩发生次数

max_wind_speed

Double

N

最大风速m/s

is_over_wind_speed

Int

N

是否发生超风速(0.否1.是)

max_range

Double

N

最大幅度

max_height

Double

N

最大幅度

响应体字段

名称

类型

是否必需

备注

result

String

Y

接口调用结果。true表示接口调用成功，false表示接口调用失败。

code

String

Y

应用程序错误码，详见错误码一览表

message

String

N

错误信息

detail_message

String

N

详细错误信息

server_timestamp

String

Y

服务端时间，yyyy-MM-dd hh:mm:ss

result_data

Object

N

返回结果集

请求体格式示例

{

"api_key":"",

"project_code":"",

"eng_code":"",

"api_version":"",

"timestamp":"",

"signature":"",

"body":[

{

"device_no":"",

"start_time":"",

"end_time":"",

"max_moment_ratio": ,

"exceeding_num": ,

"max_wind_speed": ,

"is_over_wind_speed": ,

"max_range": ,

"max_height":

}

]

}

响应体格式示例

{

 "result":"",

"code":,

"message":"",

"detail_message":"",

"server_timestamp":"",

"result_data":

}

2.3.6 上报塔机通电时间接口

接口信息

Method

/crane/electrify

Version

1.0

返回方式

响应体(JSON)

接口说明

上报塔机通电时间

输入参数

名称

类型

是否必需

备注

body

Array

Y

塔机通电时间

body数组内对象字段

名称

类型

是否必需

备注

device_no

String

Y

设备编号

runtime

String

Y

运行时刻

operation

Int

Y

事件类型（0 断电，1 通电）

响应体字段

名称

类型

是否必需

备注

result

String

Y

接口调用结果。true表示接口调用成功，false表示接口调用失败。

code

String

Y

应用程序错误码，详见错误码一览表

message

String

N

错误信息

detail_message

String

N

详细错误信息

server_timestamp

String

Y

服务端时间yyyy-MM-dd hh:mm:ss

result_data

Object

N

返回结果集

请求体格式示例

{

"api_key":"",

"project_code":"",

"eng_code":"",

"api_version":"",

"timestamp":"",

"signature":"",

"body":[

{

"device_no":"",

"runtime":"",

"operation":"",

}

]

}

响应体格式示例

{

 "result":"",

"code":,

"message":"",

"detail_message":"",

"server_timestamp":"",

"result_data":

}

2.3.7 上报塔机司机打卡记录信息

接口信息

Method

/crane/clockIn

Version

1.0

返回方式

响应体(JSON)

接口说明

上报塔机司机打卡记录信息

输入参数

名称

类型

是否必需

备注

body

Array

Y

塔机通电时间

body数组内对象字段

名称

类型

是否必需

备注

device_no

String

Y

设备编号

worker_name

String

Y

操作员(司机)姓名

start_time

String

Y

打卡(上机)时间 时间格式

end_time

String

Y

下班(关机机)时间 时间格式

响应体字段

名称

类型

是否必需

备注

result

String

Y

接口调用结果。true表示接口调用成功，false表示接口调用失败。

code

String

Y

应用程序错误码，详见错误码一览表

message

String

N

错误信息

detail_message

String

N

详细错误信息

server_timestamp

String

Y

服务端时间yyyy-MM-dd hh:mm:ss

result_data

Object

N

返回结果集

请求体格式示例

{

"api_key":"",

"project_code":"",

"eng_code":"",

"api_version":"",

"timestamp":"",

"signature":"",

"body":[

{

"device_no" : "11111111",

"worker_name":"司机01",

"start_time":"2019-04-24 19:13:16",

"end_time":"2019-04-24 22:13:16"

},

{

"device_no" : "11111",

"worker_name":"司机02",

"start_time":"2019-04-24 19:13:16",

"end_time":"2019-04-24 22:13:16"

}

]

}

响应体格式示例


2.4 施工升降机

2.4.1 上报升降机基本信息 

接口信息

Method

/elevator/addBasicInfo

Version

1.0

返回方式

响应体(JSON)

接口说明

上报升降机基本信息

输入参数

名称

类型

是否必需

备注

body

Object

Y

升降机基本信息

body对象字段

名称

类型

是否必需

备注

device_no

String

Y

设备编号

(设备号可以自定义32位UUID，每个设备的唯一ID)

model

String

N

设备型号

name

String

Y

设备名称

整数#升降机 例如：

13#升降机

uid

String

N

设备用户编号

license

String

N

设备证书日期

license_start_date

String

N

设备发证日期

license_end_date

String

N

设备有效日期

photos

String

N

设备照片

property_unit

String

N

设备产权单位

mnufacturer_business

String

N

设备制造商

mai_war_bus

String

N

设备维保商

testing_business

String

N

设备检测商

in_date

String

N

设备进场时间

out_date

String

N

设备出场时间

mon_device_man

String

Y

监测设备厂商

device_installation_date

String

N

监测设备安装日期

guangdong_install_num

String

Y

广东省统一安装告知编号（产权备案编号）例如：

粤BE-S03981

响应体字段

名称

类型

是否必需

备注

result

String

Y

接口调用结果。true表示接口调用成功，false表示接口调用失败。

code

String

Y

应用程序错误码，详见错误码一览表

message

String

N

错误信息

detail_message

String

N

详细错误信息

server_timestamp

String

Y

服务端时间，yyyy-MM-dd hh:mm:ss

result_data

Object

N

返回结果集

请求体格式示例

{

"api_key":"",

"project_code":"",

"eng_code":"",

"api_version":"",

"timestamp":"",

"signature":"",

"body":{

"device_no":"",

"model":"",

"name":"",

"uid":"",

"license":"",

"license_start_date":"",

"license_end_date":"",

"photos":"",

"property_unit":"",

" mnufacturer_business":"",

"mai_war_bus":"",

" testing_business":"",

"in_date":"",

"out_date":"",

"mon_device_man":"",

"device_installation_date":"",

}

}

响应体格式示例

{

 "result":"",

"code":,

"message":"",

"detail_message":"",

"server_timestamp":"",

"result_data":

}

2.4.2 上报升降机参数信息  

接口信息

Method

/elevator/addParams

Version

1.0

返回方式

响应体(JSON)

接口说明

上报升降机参数信息

输入参数

名称

类型

是否必需

备注

body

Object

Y

升降机参数信息

body对象字段

名称

类型

是否必需

备注

device_no

String

Y

设备编号

model

String

N

设备型号

name

String

N

设备名称

L_Load_Capacity

Double

Y

最大载重（KG)

L_Height

Double

Y

最大高度(m)

L_Height2

Double

N

最大自由高度(m)

L_UpCollect

Int

N

向上采集点输入方式

L_DownCollection

Int

N

向下采集点输入方式

L_GearModules

Int

N

齿轮模数(0-20)

L_LowLimit

Int

N

下限位输入方式

L_M_Contract

Int

N

主接触器输出方式

L_S_Contract

Int

N

副接触器输出方式

L_MonitorStyle

Int

N

监控控制方式

L_Sections

Int

N

升节节数

L_ControlStyle

Int

N

升降机控制方式

L_Limit_Capacity

Double

N

分时限载载重（KG)

响应体字段

名称

类型

是否必需

备注

result

String

Y

接口调用结果。true表示接口调用成功，false表示接口调用失败。

code

String

Y

应用程序错误码，详见错误码一览表

message

String

N

错误信息

detail_message

String

N

详细错误信息

server_timestamp

String

Y

服务端时间，yyyy-MM-dd hh:mm:ss

result_data

Object

N

返回结果集

请求体格式示例

{

"api_key":"",

"project_code":"",

"eng_code":"",

"api_version":"",

"timestamp":"",

"signature":"",

"body":{

"device_no":"",

" model":"",

" name":"",

"L_Load_Capacity":"",

"L_Height":"",

"L_Height2":"",

"L_UpCollect":"",

"L_DownCollection":"",

"L_GearModules":"",

"L_LowLimit":"",

"L_M_Contract":"",

"L_S_Contract":"",

"L_MonitorStyle":"",

"L_Sections":"",

"L_ControlStyle":"",

"L_Limit_Capacity":""

}

}

响应体格式示例

{

 "result":"",

"code":,

"message":"",

"detail_message":"",

"server_timestamp":"",

"result_data":

}

2.4.3 上报升降机实时数据

接口信息

Method

/elevator/addRecord

Version

1.0

返回方式

响应体(JSON)

接口说明

上报升降机实时数据

输入参数

名称

类型

是否必需

备注

body

Array

Y

升降机实时数据列表

body数组内对象字段

名称

类型

是否必需

备注

device_no

String

Y

设备编号

runtime

String

Y

运行时,格式为yyyy-MM-dd hh:mm:ss，

load

Double

Y

载重（kg）

load_ratio

Double

Y

载重比

0.8(表示载重比80%)

sign

Int

N

左右笼标记(0单笼,1左笼,2右笼)

loading_capacity

Int

N

载重人数

operator_name

String

Y

升降机司机名字

ic_num

int

N

IC卡号

direction

int

N

方向(0停止,1上行,2下行)

height

Double

Y

高度(m)

real_time_flag

int

N

实时标志(0历史数据,1实时数据)

status

int

Y

状态(0 正常状态

1 IC 卡无效

2 安全器故障

4 上高度预警

8 上高度报警

16 非本人操作

32 监理授权

64 加节模式

128 下限位报警)

braking_distance

Int

N

制动距离

is_up_warning

Int

Y

是否上限位报警（0-否，1-是，2-无上限位）

is_down_warning

int

Y

是否下限位报警( 0-否，1-是，2-无下限位）

is_safety_device_warn

int

Y

是否安全器报警(0.否1.是)

is_over_warning

int

Y

是否超重报警(0.否1.是)

is_forward_warning

int

Y

是否前限位报警(0.否1.是)

is_backward_warning

Int

Y

是否后限位报警(0.否1.是)

is_limit_warning

Int

Y

超限位报警(0.否1.是)

响应体字段

名称

类型

是否必需

备注

result

String

Y

接口调用结果。true表示接口调用成功，false表示接口调用失败。

code

String

Y

应用程序错误码，详见错误码一览表

message

String

N

错误信息

detail_message

String

N

详细错误信息

server_timestamp

String

Y

服务端时间，yyyy-MM-dd hh:mm:ss

result_data

Object

N

返回结果集

请求体格式示例

{

"api_key":"",

"project_code":"",

"eng_code":"",

"api_version":"",

"timestamp":"",

"signature":"",

"body":[

{

"device_no":"",

"runtime":"",

"laod":"",

"load_ratio":"",

"sign":"",

"loading_capacity":"",

"operator_name":"",

"ic_num":"",

"direction":"",

"height":"",

"real_time_flag":"",

"status":"",

"braking_distance":"",

"is_up_warning":"",

"is_down_warning":"",

"is_safety_device_warn":"",

"is_over_warning":"",

"is_forward_warning":"",

"is_backward_warning":""

}

]

}

响应体格式示例

{

 "result":"",

"code":,

"message":"",

"detail_message":"",

"server_timestamp":"",

"result_data":

}

2.4.4 上报升降机操作记录 

接口信息

Method

/elevator/operator

Version

1.0

返回方式

响应体(JSON)

接口说明

上报升降机操作记录

输入参数

名称

类型

是否必需

备注

body

Array

Y

升降机操作列表

body数组内对象字段

名称

类型

是否必需

备注

device_no

String

Y

设备编号

start_time

String

N

操作开始时间

end_time

String

N

操作结束时间

direction

Int

N

方向(1 上行,2 下行)

max_load_value

Double

N

最高承重值

is_over_load

Int

Y

是否发生超载(0.否1.是)

operator_name

String

N

持卡人姓名

isIllegal_operation

Int

Y

是否非持卡人操作(0.否1.是)

响应体字段

名称

类型

是否必需

备注

result

String

Y

接口调用结果。true表示接口调用成功，false表示接口调用失败。

code

String

Y

应用程序错误码，详见错误码一览表

message

String

N

错误信息

detail_message

String

N

详细错误信息

server_timestamp

String

Y

服务端时间，yyyy-MM-dd hh:mm:ss

result_data

Object

N

返回结果集

请求体格式示例

{

"api_key":"",

"project_code":"",

"eng_code":"",

"api_version":"",

"timestamp":"",

"signature":"",

"body":[

{

"device_no" :"",

"start_time" :"",

"end_time" :"",

"direction":,

"is_over_load" :,

"operator_name" :"",

"isIllegal_operation":  "",

}

]

}

响应体格式示例

{

 "result":"",

"code":,

"message":"",

"detail_message":"",

"server_timestamp":"",

"result_data":

}

2.4.5 上报升降机通电时间接口

接口信息

Method

/elevator /electrify

Version

1.0

返回方式

响应体(JSON)

接口说明

上报升降机通电时间接口

输入参数

名称

类型

是否必需

备注

body

Array

Y

升降机通电时间列表

body数组内对象字段

名称

类型

是否必需

备注

device_no

String

Y

设备编号

runtime

String

Y

运行时刻

operation

Int

Y

事件类型（0 断电，1 通电）

响应体字段

名称

类型

是否必需

备注

result

String

Y

接口调用结果。true表示接口调用成功，false表示接口调用失败。

code

String

Y

应用程序错误码，详见错误码一览表

message

String

N

错误信息

detail_message

String

N

详细错误信息

server_timestamp

String

Y

服务端时间，yyyy-MM-dd hh:mm:ss

result_data

Object

N

返回结果集

请求体格式示例

{

"api_key":"",

"project_code":"",

"eng_code":"",

"api_version":"",

"timestamp":"",

"signature":"",

"body":[

{

"device_no" :"",

"runtime" :"",

"operation" :"",

}

]

}

响应体格式示例

{

 "result":"",

"code":,

"message":"",

"detail_message":"",

"server_timestamp":"",

"result_data":

}

2.5 环境监测

2.5.1 环境监测实时数据 

Method

/envMonitoring/addRecord

Version

1.0

返回方式

响应体(JSON)

接口说明

环境监测实时数据，每次只能上传同一台设备的数据

暂定 60 秒 1 次,后期随着政策的变动而修改 

输入参数

名称

类型

是否必需

备注

body

Array

Y

环境监测实时数据列表

body数组内对象字段

名称

类型

是否必需

备注

device_no

String

Y

设备编号

(设备号可以自定义32位UUID，每个设备的唯一ID)

runtime

String

Y

运行时,格式为yyyy-MM-dd hh:mm:ss，

noise

Double

Y

噪声(db)

pm10

int

Y

PM10 单位：ug/m3

pm25

Int

Y

PM2.5 单位：ug/m3

wind_speed

double

Y

风速(m/s)

wind_direction

String

Y

风向(必须是一下的值):

北，西北，西，西南，南，东南，东,东北

temperature

double

Y

温度(℃)

humidity

double

Y

湿度(%)

pressure

Double

N

气压

voltage

double

N

电压

board_longitude

double

N

板载经度

board_latitude

double

N

板载纬度

board_temp

double

N

板载温度

board_humidity

double

N

板载湿度

tsp

int

Y

单位：ug/m3

响应体字段


名称

类型

是否必需

备注

result

String

Y

接口调用结果。true表示接口调用成功，false表示接口调用失败。

code

String

Y

应用程序错误码，详见错误码一览表

message

String

N

错误信息

detail_message

String

N

详细错误信息

server_timestamp

String

Y

服务端时间，yyyy-MM-dd hh:mm:ss

result_data

Object

N

返回结果集

请求体格式示例

{

"api_key":"",

"project_code":"",

"eng_code":"",

"api_version":"",

"timestamp":"",

"signature":"",

"body":[

{

"device_no":"",

"runtime":"",

"noise":"",

"pm10":"",

"pm25": "",

"wind_speed":"",

"wind_direction":"",

"temperature":"",

"humidity":"",

"pressure":"",

"voltage":"",

"board_longitude:":" ",

"board_latitude":"",

"board_temp":"",

"board_humidity":""

}

]

}

响应体格式示例

{

 "result":"",

"code":,

"message":"",

"detail_message":"",

"server_timestamp":"",

"result_data":

}

2.5.2 上报环境监测设备基本信息 

Method

/envMonitoring/addBasicInfo

Version

1.0

返回方式

响应体(JSON)

接口说明

上报环境监测设备基本信息

输入参数

名称

类型

是否必需

备注

body

Object

Y

环境监测设备基本信息

body对象字段

名称

类型

是否必需

备注

device_no

String

Y

设备编号

name

String

Y

设备名称:

整数#监测点 例如：

13#监测点

type

Int

Y

设备类型(1.环境)

me_option

String

N

监测项

install_address

String

Y

安装位置

install_company

String

Y

设备安装单位

device_installation_date

String

Y

设备安装日期

state

int

N

状态

响应体字段

名称

类型

是否必需

备注

result

String

Y

接口调用结果。true表示接口调用成功，false表示接口调用失败。

code

String

Y

应用程序错误码，详见错误码一览表

message

String

N

错误信息

detail_message

String

N

详细错误信息

server_timestamp

String

Y

服务端时间，yyyy-MM-dd hh:mm:ss

result_data

Object

N

返回结果集

请求体格式示例

{

"api_key":"",

"project_code":"",

"eng_code":"",

"api_version":"",

"timestamp":"",

"signature":"",

"body":{

"device_no":"",

"device_model":"",

"device_name":"",

"device_uid":"",

"type": "",

"inst_address":"",

"inst_company":"",

"dev_inst_date":"",

"state":"",

}

  响应体格式示例

{

 "result":"",

"code":,

"message":"",

"detail_message":"",

"server_timestamp":"",

"result_data":

}

2.6 施工废水监测

2.6.1 废水监测实时数据 

Method

/waterMonitoring/addRecord

Version

1.0

返回方式

响应体(JSON)

接口说明

废水监测实时数据

暂定 60 秒 1 次,后期随着政策的变动而修改

输入参数

名称

类型

是否必需

备注

body

Array

Y

废水监测实时数据列表

body数组内对象字段

名称

类型

是否必需

备注

uid

String

Y

设备编码

(设备号可以自定义32位UUID，每个设备的唯一ID)

time

String

Y

运行时间,格式为yyyy-MM-dd hh:mm:ss，

n

Array

Y

子数组

b

String

Y

电池电量单位:v

若无此项指标，传默认值3.7

f

String

Y

悬浮物 单位：mg/L

i

String

Y

节点下标号 1-24之间

s

String

Y

节点信号强度值  0-100之间

响应体字段


名称

类型

是否必需

备注

result

String

Y

接口调用结果。true表示接口调用成功，false表示接口调用失败。

code

String

Y

应用程序错误码，详见错误码一览表

message

String

N

错误信息

detail_message

String

N

详细错误信息

server_timestamp

String

Y

服务端时间，yyyy-MM-dd hh:mm:ss

result_data

Object

N

返回结果集

请求体格式示例

{

"api_key":"",

"project_code":"",

"eng_code":"",

"api_version":"",

"timestamp":"",

"signature":"",

"body":[

{ "time":"2020-04-15 15:17:00",

"uid":"DCD851F41C384EB3AE9326AD26EC667D",

"n":[

{"b":"0.0",

"f":"0",

"i":"1",

"s":"0"}

]

}

]

}

响应体格式示例

{

 "result":"",

"code":,

"message":"",

"detail_message":"",

"server_timestamp":"",

"result_data":

}

2.6.2 上报水污染监测设备基本信息 

Method

/waterMonitoring/addBasicInfo

Version

1.0

返回方式

响应体(JSON)

接口说明

上报环境监测设备基本信息，每次只能上传同一台设备的数据

输入参数

名称

类型

是否必需

备注

body

Object

Y

环境监测设备基本信息

body对象字段

名称

类型

是否必需

备注

device_no

String

Y

设备编号限制32位

uid

String

Y

设备编码(设备号可以自定义32位UUID，每个设备的唯一ID)

name

String

Y

设备名称:

整数#监测点 例如：

1#东门监测点

type

Int

Y

设备类型(6.水污染)

me_option

String

N

监测项

install_address

String

Y

安装位置

install_company

String

Y

设备安装单位

device_installation_date

String

Y

设备安装日期yyyy-MM-dd HH:mm:ss

state

int

N

状态

响应体字段

名称

类型

是否必需

备注

result

String

Y

接口调用结果。true表示接口调用成功，false表示接口调用失败。

code

String

Y

应用程序错误码，详见错误码一览表

message

String

N

错误信息

detail_message

String

N

详细错误信息

server_timestamp

String

Y

服务端时间，yyyy-MM-dd hh:mm:ss

result_data

Object

N

返回结果集

请求体格式示例

{

"api_key":"",

"project_code":"",

"eng_code":"",

"api_version":"",

"timestamp":"",

"signature":"",

"body":{

"device_no":"",

" me_option":"",

"device_name":"",

"uid":"",

"type": "",

"inst_address":"",

"inst_company":"",

" device_installation_date":"",

"state":"",

}

  响应体格式示例

{

 "result":"",

"code":,

"message":"",

"detail_message":"",

"server_timestamp":"",

"result_data":

}

2.7 图片文件上传

2.7.1 图片上传

接口信息

Endpoint

测试：http://{host}/test-uploadfile-openpai/uploadImage

正式：http://{host}/uploadfile-openpai/uploadImage

返回方式

响应体(JSON)

接口说明

图片上传，支持jpg,png 等通用的图片格式

图片大小：500KB

输入参数

名称

类型

是否必需

备注

api_key

String

N

api_key

file

MultipartFile

Y

图片对象

响应体字段

名称

类型

是否必需

备注

result

String

Y

接口调用结果。true表示接口调用成功，false表示接口调用失败。

code

String

Y

应用程序错误码，详见错误码一览表

message

String

N

错误信息

detail_message

String

N

详细错误信息

server_timestamp

String

Y

服务端时间，yyyy-MM-dd hh:mm:ss

result_data

Object

N

服务端的图片路径(用于业务提交)

请求体格式示例

HTML案例：

<!DOCTYPE html>

<html>

<head>

<meta charset="utf-8" />

<meta http-equiv="X-UA-Compatible" content="IE=edge">

<title>Page Title</title>

<meta name="viewport" content="width=device-width, initial-scale=1">

<link rel="stylesheet" type="text/css" media="screen" href="main.css" />

<script src="main.js"></script>

</head>

<body>

<form action="http://127.0.0.1:8089/uploadfile-openpai/upload" method="post" enctype="multipart/form-data">

<span>文件(file):

<input type="file" id="file" name="file">

</span>

<br/>

<span>api_key:

<input type="text" id="scene" name="api_key" value="api_key">

</span>

<br/>

<input type="submit" name="submit" value="upload">

</form>

</body>

</html>

Java 案例：

引入cn.hutool.http.HttpUtil

<!--http://mvnrepository.com/artifact/cn.hutool/hutool-all -->
<dependency>
    <groupId>cn.hutool</groupId>
    <artifactId>hutool-all</artifactId>
    <version>4.5.7</version>
</dependency>

@Test
public voidf3(){
    HashMap<String, Object> paramMap =newHashMap<>();
    //文件
    File file=newFile("D:\\dev\\001.jpg");
    paramMap.put("file", file);
    paramMap.put("api_key","001");
    String result= HttpUtil.post("http://127.0.0.1:8089/uploadfile-openpai/uploadImage", paramMap);
    System.out.println(result);
}

返回值案例：{

"result": "true",

"code": 0,

"message": "上传文件成功",

"serverTimestamp": "2019-05-24 15:07:05",

"resultData": "/group1/thit/02392ldsljfoelsijrl.jpg"

}

2.8 AI视频监测

2.8.1上传报警数据

Method

/aiMonitoring/addRecord

Version

1.0

返回方式

响应体(JSON)

接口说明

AI监测报警数据

输入参数

名称

类型

是否必需

备注

body

Array

Y

AI报警实时数据列表

body数组内对象字段

名称

类型

是否必需

备注

id

String

Y

自定义32位UUID，记录唯一ID

channel

Number

Y

通道

alarmEventType

Number

Y

1、 未佩戴安全帽

2、 火焰报警

3、 边界入侵

4、 其它

alarmRemark

String

N

备注

alarmTime

String

Y

报警时间,格式为yyyy-MM-dd hh:mm:ss

deviceId

String

N

设备ID（摄像头ID）

deviceNo

String

N

设备编号

deviceName

String

N

设备名称（摄像头名称）

deviceIp

String

Y

设备IP

ivasIp

String

N

分析服务器IP

photoId

String

Y

图片上传ID（图片上传接口返回）

imgWidth

Number

N

图片宽度

imgHeight

Number

N

图片高度

响应体字段


名称

类型

是否必需

备注

result

String

Y

接口调用结果。true表示接口调用成功，false表示接口调用失败。

code

String

Y

应用程序错误码，详见错误码一览表

message

String

N

错误信息

detail_message

String

N

详细错误信息

server_timestamp

String

Y

服务端时间，yyyy-MM-dd hh:mm:ss

result_data

Object

N

返回结果集

请求体格式示例

{

    "api_key": "",

    "project_code": "",

    "eng_code": "",

    "api_version": "",

    "timestamp": "",

    "signature": "",

    "body": [

        {

            "alarmEventType": 1,

            "alarmRemark": "未佩戴安全帽",

            "alarmState": 1,

            "alarmTime": "2020-12-30 00:00:00",

            "channelId": "test",

            "channelName": "摄像头1",

            "deviceIp": "xxx.xxx.x.x",

            "id": "1234567890qaz",

            "imgHeight": 234,

            "imgWidth": 343,

            "ivasIp": "xxx.xxx.x.x",

            "photoId": "test"

        }

    ]

}

响应体格式示例

{

 "result":"",

"code":,

"message":"",

"detail_message":"",

"server_timestamp":"",

"result_data":

}

2.9 疫情防控

2.9.1 上报健康码设备基本信息

Method

/corona-api/addBasicInfo

Version

1.0

返回方式

响应体(JSON)

接口说明

上报环境监测设备基本信息

输入参数

名称

类型

是否必需

备注

body

Json

Y

环境监测设备基本信息

body对象字段

名称

类型

是否必需

备注

device_no

String

Y

设备唯一序列号

name

String

Y

设备名称:

整数#监测点 例如：

13#监测点

type

Int

Y

设备类型()

me_option

String

N

监测项

install_address

String

Y

安装位置

install_company

String

Y

设备安装单位

device_installation_date

String

Y

设备安装日期

state

int

N

状态

响应体字段

名称

类型

是否必需

备注

result

String

Y

接口调用结果。true表示接口调用成功，false表示接口调用失败。

code

String

Y

应用程序错误码，详见错误码一览表

message

String

N

错误信息

detail_message

String

N

详细错误信息

server_timestamp

String

Y

服务端时间，yyyy-MM-dd hh:mm:ss

result_data

Object

N

返回结果集

请求体格式示例

{

"api_key":"",

"project_code":"",

"eng_code":"",

"api_version":"",

"timestamp":"",

"signature":"见1.3.3",

"body":{

"device_no":"设备序列号，同hardwareSn",

"device_model":"",

"device_name":"1#门1#健康码设备",

"device_uid":"厂商系统唯一码",

"type": "设备类型，可选",

"inst_address":"安装地址",

"inst_company":"厂商",

"dev_inst_date":"安装时间",

"state":"",

}

  响应体格式示例

{

 "result":"",

"code":,

"message":"",

"detail_message":"",

"server_timestamp":"",

"result_data":

}

2.9.2 上传健康码数据

Method

/corona-api/addRecord

Version

1.0

返回方式

响应体(JSON)

接口说明

进出人员健康码、体温监测数据批量上报

输入参数

名称

类型

是否必需

备注

body

Array

Y

批量

body数组内对象字段

字段名称

字段编码

数据类型

示例

备注

必填

设备序列号

hardwareSn

String

VSW123456


Y

通行时间

passTime

String

2022-01-25 14:59:53


Y

亮码时间

brightTime

String

2022-01-25 14:59:53



进出类型

direction

Int

1进，2出


Y

体温

temperature

float

36.5



体温状态

temperatureStatus

int

1正常，2异常



粤康码颜色

healthCode

int

1绿；2黄；3红；


Y

身份证号

personKey

String

base64加密字符串


Y

疫苗状态

vaccineStatus

int

数字0,1,2,3,4



核酸时间

nucleinTime

String

2022-01-25 14:59:53



核酸结果

nucleinResult

int

0无，1阴性, 2阳性



核酸有效期

nucleinPeriod

int

0,24,48,72,168,336





属性

类型

说明

必有

result

String

接口调用结果。true表示接口调用成功，false表示接口调用失败。

Y

code

String

应用程序错误码，详见错误码一览表

Y

message

String

错误信息

N

detail_message

String

详细错误信息

N

server_timestamp

String

服务端时间，yyyy-MM-dd hh:mm:ss

Y

result_data

Object

返回结果集

N

请求体格式示例

{

    "api_key": "",

    "project_code": "",

    "eng_code": "",

    "api_version": "",

    "timestamp": "",

    "signature": "见1.3.3签名算法",

    "body": [

        {

          "hardwareSn":""   

...     

}

    ]

}

响应体格式示例

{

 "result":"",

"code":,

"message":"",

"detail_message":"",

"server_timestamp":"",

"result_data":

}

设备接口

2.10 设备拆除接口

接口信息

Method

/device/leave

Version

1.0

返回方式

响应体(JSON)

接口说明

设备拆除接口

输入参数

名称

类型

是否必需

备注

body

Array

Y

设备拆除接口

body数组内对象字段

名称

类型

是否必需

备注

device_no

String

Y

设备编号

leave_time

String

Y

拆除时间

响应体字段

名称

类型

是否必需

备注

result

String

Y

接口调用结果。true表示接口调用成功，false表示接口调用失败。

code

String

Y

应用程序错误码，详见错误码一览表

message

String

N

错误信息

detail_message

String

N

详细错误信息

server_timestamp

String

Y

服务端时间yyyy-MM-dd hh:mm:ss

result_data

Object

N

返回结果集

请求体格式示例

{

"api_key":"",

"project_code":"",

"eng_code":"",

"api_version":"",

"timestamp":"",

"signature":"",

"body":[

{

"device_no" : "11111111",

"leave_time":"2019-04-24 19:13:16"

},

{

"device_no" : "11111",

"leave_time":"2019-04-24 19:13:16"

}

]

}

响应体格式示例


3 设备监测数据字典

3.1 通行方式字典表

1

人脸识别

2

虹膜识别

3

指纹识别

4

掌形识别

5

身份证识别

6

实名卡

7

异常清退（适用人员没有通过闸机系统出工地而导致人员状态不一致的情况）

8

一键开闸(需要与闸机交互)

9

应急通道（不需要与闸机交互）

10

二维码识别

11

其他方式

3.2 设备类型字典表

1

复合型漏电流探测器(漏电流+温 感)

2

三相电流表

3

空气开关

4

烟感探测器

5

防火门探测器

3.3 区域字典表

1

生活区

2

施工现场

3

配电房

3.4 车辆类型字典表

1

轿车

2

皮卡车

3

货车

4

卡车

5

其他

3.5 单位描述

1

环境监测

环境监测实时数据

pm25

PM2.5

μg/m³

pm10

PM10

μg/m³

tsp

TSP

μg/m³

noise

噪声

db

temperature

温度

°C

humidity

湿度

%

wind_speed

风速

m/s

2

施工升降机

上报升降机参数信息

L_Load_Capacity

最大载重

kg

L_Height

最大高度

m

L_Height2

最大自由高度

m

上报升降机实时数据

load

载重

m

load_ratio

载重比

小数

height

高度

m

3

配电箱

上报配电箱参数

temp_limit

电缆温度限值

°C

elec_limit

漏电流限值

mA

around_temp

周围环境温度限值

°C

上报配电箱状态

cable_a_temp

线缆a温度

°C

cable_b_temp

线缆b温度

°C

cable_c_temp

线缆c温度

°C

cable_n_temp

线缆n温度

°C

elec_limit

漏电流

mA

env_temp

周围环境温度

°C

4

塔式起重机

上报塔式起重机参数信息


回转角度

°

TC_MaxScope

最大幅度

m

TC_MaxHeight

最大高度

m

TC_MinHeight

最小高度

m

TC_MinScope

最小幅度

m

TC_LoadCapacity

最大载重

kg

load_moment

额定起重力矩

N·m

上报塔式起重机实时数据

load

载重

m

load_ratio

载重比

填小数，精确到一位小数点

moment

力矩

kg

slewing_speed

回转角度

°

range

幅度

m

height

高度

m

wind_speed

风速

m/s

上传塔机报警数据

参考实时数据



三、 对接说明

1 接口文档说明

由于深圳市住建局两制平台接口调用逻辑及业务与深圳市智慧建造平台接口存在很大差异，深圳市水务局工地监测与现场监管系统为了减轻项目端厂商对接工作量，故人员实名制管理的接口文档与设备监测信息的接口文档还是趋于和住建局平台保持一致，因此在本文档中分为两个章节，第一章为深圳市水务局工地监测与现场监管系统实名制信息上报接口，第二章为深圳市水务局工地监测与现场监管系统设备检查信息上报接口。两章在接口调用逻辑及业务处理方面均存在很大差异，请注意区分，如有疑问请联系联调负责人进行沟通交流。

2 联系方式

接口对接QQ群号：929152472

接口联调技术：周芝造  15902083280

接口联调运维：周芝造  15902083280

请先加入深圳市水务局工地监测与现场监管系统对接QQ群获取相关帮助。

3修改说明

1.起重机和升降机添加必填字段 ：guangdong_install_num

2.起重机参数接口添加字段：load_moment

3.起重机记录参数：载重比、力矩比改成必填

4.起重机报警：载重比、力矩比改成必填

5.起重机工作循环接口：工作循环开始时刻、工作循环结束时刻、工作循环中最高力矩比改成必填

6.升降机添加必填字段 ：guangdong_install_num

7.升降机实时数据接口载重比、状态 改成必填

8.升降机实时数据接口添加字段:超限位报警is_limit_warning

9.升降机操作记录接口操作开始时间、操作结束时间改成必填字段

10.新增设备拆除接口。

11.新增环境监测的tsp

12.起重机添加必须参数实时记录：

collision_warn,wind_wran,rotation_warn

13.新增了起重机和升降机的司机打卡接口

加入收藏
Tag: 深圳市 水务局 工地 监测 现场 监管 系统 接口 协议

部分内容由用户投稿或者来源于网络，如有侵权，请联系底部邮箱进行删除！非常感谢您的支持！

上一篇：智慧建筑评价与评价体系的区别
下一篇：深圳市智能建造技术目录，智慧建造技术目录标准
返回列表
立即下载

标签

芯片 定位技术 发文 故宫 国标HJ 212-2017 腾晖 数据接入 规格 监管子系统正式启用的通知 质量检测 江海区 NY-TZ1标 泰州段 宁盐高速 分级 详细 评定 构建 节能 全覆盖