接口文档-202212281613

203.网关接口 v2.签名式

开关阀门:[DeviceValveManual]

基本信息

  • 接口地址：/gateway/api/v2sign/Device/DeviceValveManual

  • 请求方式：Post

  • 请求类型：application/json

请求参数(Body)

参数名称 参数类型 是否可为空 描述
apiID string False 系统分配的应用授权访问ID
timestamp int64 False UTC时间戳,到毫秒,必须 30秒内
requestId string False 请求id
deviceUid string False 设备唯一ID
dataSign string False 数据签名,签名md5 (ApiID + DeviceUid + RequestId + Timestamp + secretKey) 示例：32位大写
data object false 对象
-deviceSwitch int32 False 开关状态：0 关，1开
-runTimes int32 False 打开时长，仅对 DeviceSwitch = 1 有效， 0 表示不限制

请求示例

  1. {
  2.     "apiID": "string",
  3.     "timestamp": 0,
  4.     "requestId": "string",
  5.     "deviceUid": "string",
  6.     "dataSign": "string",
  7.     "data": {
  8.         "deviceSwitch": 0,
  9.         "runTimes": 0
  10.     }
  11. }

返回参数

参数名称 参数类型 是否可为空 描述
success boolean False 操作是否成功
message string True 消息
messageId int32 False 消息ID：1-成功，0-默认错误，其她为自定义错误

返回示例

  1. {
  2.     "success": false,
  3.     "message": "string",
  4.     "messageId": 0
  5. }


获取阀门状态列表:[DeviceValveStatusList]

基本信息

  • 接口地址：/gateway/api/v2sign/Device/DeviceValveStatusList

  • 请求方式：Post

  • 请求类型：application/json

请求参数(Body)

参数名称 参数类型 是否可为空 描述
apiID string False 系统分配的应用授权访问ID
dataSign string False 数据签名,签名md5 (ApiID + RequestId + Timestamp + secretKey) 示例：32位大写
timestamp int64 False UTC时间戳,到毫秒,必须 30秒内
requestId string False 请求id
deviceUidList System.Object[] False 设备唯一ID

请求示例

  1. {
  2.     "apiID": "string",
  3.     "dataSign": "string",
  4.     "timestamp": 0,
  5.     "requestId": "string",
  6.     "deviceUidList": [
  7.         null
  8.     ]
  9. }

返回参数

参数名称 参数类型 是否可为空 描述
success boolean False 操作是否成功
message string True 消息
messageId int32 False 消息ID：1-成功，0-默认错误，其她为自定义错误
data object[] false 对象
-collectTime string True 采集时间 yyyy-MM-dd HH:mm:ss
-flowSpeed float False 流速(m³/h)
-totalFlow float False 总累计流量(m³)
-pressure float False 压力(bar)
-openTime string True 开启UTC时间 (2022-11-02 13:51:40)
-switchStatus int32 False 开关状态 1-开 0-关
-passageway int32 False 通道
-deviceUid string True 设备uid
-onlineState int32 False 在线状态，1 在线，0 不在线

返回示例

  1. {
  2.     "success": false,
  3.     "message": "string",
  4.     "messageId": 0,
  5.     "data": [
  6.         {
  7.             "collectTime": "string",
  8.             "flowSpeed": 0,
  9.             "totalFlow": 0,
  10.             "pressure": 0,
  11.             "openTime": "string",
  12.             "switchStatus": 0,
  13.             "passageway": 0,
  14.             "deviceUid": "string",
  15.             "onlineState": 0
  16.         }
  17.     ]
  18. }


获取设备列表:[GetDeviceList]

基本信息

  • 接口地址：/gateway/api/v2sign/Device/GetDeviceList

  • 请求方式：Post

  • 请求类型：application/json

请求参数(Body)

参数名称 参数类型 是否可为空 描述
apiID string False 系统分配的应用授权访问ID
dataSign string False 数据签名,签名md5 (ApiID + RequestId + Timestamp + secretKey) 示例：32位大写
timestamp int64 False UTC时间戳,到毫秒,必须 30秒内
requestId string False 请求id
data object false 对象
-gatewayList System.Object[] False 网关列表

请求示例

  1. {
  2.     "apiID": "string",
  3.     "dataSign": "string",
  4.     "timestamp": 0,
  5.     "requestId": "string",
  6.     "data": {
  7.         "gatewayList": [
  8.             null
  9.         ]
  10.     }
  11. }

返回参数

参数名称 参数类型 是否可为空 描述
success boolean False 操作是否成功
message string True 消息
messageId int32 False 消息ID：1-成功，0-默认错误，其她为自定义错误
data object[] false 对象
-deviceUid string True 设备唯一UUID
-deviceName string True 设备名称
-deviceStatus int32 False 设备状态
-gatewayId int32 False 网关ID
-deviceId int32 False 设备ID
-opTime date-time False 操作时间
-deviceIndex int32 False 下位机设备索引
-gatewayType int32 False 网关类型
-onlineState int32 False 在线状态：1 在线， 0 离线
-longitude double False 经度
-latitude double False 纬度

返回示例

  1. {
  2.     "success": false,
  3.     "message": "string",
  4.     "messageId": 0,
  5.     "data": [
  6.         {
  7.             "deviceUid": "string",
  8.             "deviceName": "string",
  9.             "deviceStatus": 0,
  10.             "gatewayId": 0,
  11.             "deviceId": 0,
  12.             "opTime": "2022-12-28T16:13:53.1365206+08:00",
  13.             "deviceIndex": 0,
  14.             "gatewayType": 0,
  15.             "onlineState": 0,
  16.             "longitude": 0,
  17.             "latitude": 0
  18.         }
  19.     ]
  20. }


获取阀门状态:[GetDeviceValveStatus]

基本信息

  • 接口地址：/gateway/api/v2sign/Device/GetDeviceValveStatus

  • 请求方式：Post

  • 请求类型：application/json

请求参数(Body)

参数名称 参数类型 是否可为空 描述
apiID string False 系统分配的应用授权访问ID
timestamp int64 False UTC时间戳,到毫秒,必须 30秒内
requestId string False 请求id
deviceUid string False 设备唯一ID
dataSign string False 数据签名,签名md5 (ApiID + DeviceUid + RequestId + Timestamp + secretKey) 示例：32位大写

请求示例

  1. {
  2.     "apiID": "string",
  3.     "timestamp": 0,
  4.     "requestId": "string",
  5.     "deviceUid": "string",
  6.     "dataSign": "string"
  7. }

返回参数

参数名称 参数类型 是否可为空 描述
success boolean False 操作是否成功
message string True 消息
messageId int32 False 消息ID：1-成功，0-默认错误，其她为自定义错误
data object false 对象
-collectTime string True 采集时间 yyyy-MM-dd HH:mm:ss
-flowSpeed float False 流速(m³/h)
-totalFlow float False 总累计流量(m³)
-pressure float False 压力(bar)
-openTime string True 开启UTC时间 (2022-11-02 13:51:40)
-switchStatus int32 False 开关状态 1-开 0-关
-passageway int32 False 通道
-deviceUid string True 设备uid
-onlineState int32 False 在线状态，1 在线，0 不在线

返回示例

  1. {
  2.     "success": false,
  3.     "message": "string",
  4.     "messageId": 0,
  5.     "data": {
  6.         "collectTime": "string",
  7.         "flowSpeed": 0,
  8.         "totalFlow": 0,
  9.         "pressure": 0,
  10.         "openTime": "string",
  11.         "switchStatus": 0,
  12.         "passageway": 0,
  13.         "deviceUid": "string",
  14.         "onlineState": 0
  15.     }
  16. }