文档

测试

网关信息接口

websocket测试

POST

http://data.ecsiot.com/api/v1/base/projectBoxes

接口描述

获取网关BOX相关信息

请求参数

参数名

类型

描述

注释

必填

token

string

示例：eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiJiZmZjMGI4MzNiMDY0MjFiOTRiMjQxMWVjY2YyMWVjYi0zMWQ2YTZmY2RhNjk0YjE2OGRhZDgzYTZkMjc5ZjVmYyIsImlhdCI6MTY0NDk5OTQxNywic3ViIjoic3ViamVjdDRhcGkiLCJpc3MiOiJjbG91ZC5lY3Npb3QuY29tIiwiZXhwIjoxNjQ1MDg1ODE3fQ.tA7g7lzysJp9A3IWqL3eYQhi2BO4qh2E-T2Wzogi0ms

1.请求令牌，通过token接口获得

必填

projectId

string

示例：DMbV9DdJqGg

2. 项目ID，通过项目信息接口获得

必填

响应参数

参数名

类型

描述

注释

必填

code

int

示例：30000

状态码

必填

success

boolean

示例：true

状态

必填

msg

string

示例：获取BOX成功

返回消息

必填

data

array

数据列表

数据集，状态success为true时返回，否则为空

必填

boxId

string

示例：4ceec674f51743659352c2f0f0909b49

BOXID

必填

name

string

示例：空气源热泵

BOX名称

必填

serlnum

string

示例：305006010218

序列号

必填

status

string

示例：0，代表离线；1，代表在线

状态

必填

projectType

string

示例：0

项目类型：0：自由项目，1：模板项目

必填

说明 / 示例

**如果项目ID为空，返回：** {'code': 30001, 'success': False, 'msg': '参数缺失[projectId]', 'data': None} **如果项目ID不存在，返回：** {'code': 30002, 'success': False, 'msg': '不支持获取该项目的BOX', 'data': None} **如果项目未绑定BOX，返回：** {'code': 30003, 'success': False, 'msg': '项目未绑定BOX', 'data': None} **如果项目正常绑定BOX，返回：** {'code': 30000, 'success': True, 'msg': '获取BOX成功', 'data': [{'boxId': '0380d77aa11545428a3c683ab938192d', 'name': '二次供水', 'serlnum': '305006012399', 'status': '1', 'projectType': '0'}]}

上一篇项目信息接口

nextDoc PLC信息接口