1. 环境监测主页

根据项目id获取环境监测设备列表数据

注意

  • 如果接口需要提供auth-token,你需要通过轻筑开放平台创建应用来获取appid和secret,然后通过appid和secret来获取接口访问凭证auth-token。
  • 如果需要获取当前用户的使用信息,授权确保你能获取到qzcode,然后通过网页授权接口获取相关信息。

1.1. 基本信息

概况 内容
接口地址 /api/device/environment/home
请求方法 GET
请求数据类型 URL参数
响应数据类型 JSON

1.2. 请求数据

1.2.1. 请求头(request-header)

请求头除了默认的参数还需要添加如下请求头参数:

字段 描述
auth-token 接口访问凭据,你可以通过平台下发的appid和secret获取凭据

1.2.2. 请求参数(request-parameter)

字段 是否必传 描述
projectId 项目ID

参数请求示例:

http://api.example.com/xxx?key=value

1.3. 响应数据

响应数据中 code, message, data 为默认字段,所有字段如下表所示:

字段 类型 是否必填 描述
code number 响应码
message string 响应消息
data array 响应数据
deviceId string 设备id
projectId string 项目id
deviceCode string 设备编码
deviceName string 环境监测设备名称
state number 设备状态 0=离线 1=在线 2=异常
remarks string 备注

响应数据结构如下所示:

{
    "code": 0,
    "message": null,
    "data": [
        {
           "deviceId":"xxxxxxxxxxxx",
           "projectId": "xxxxxxxxxxxx",
           "deviceCode": "TEST",
           "deviceName": "环境监测设备名称",
           "state": 1,
           "remarks": "备注"
        }
    ]
}

1.4. 错误码

当返回数据中的 code 不为 0 时,为错误返回。其中errCode为详细的错误码。

© All Rights Reserved            updated 2024-08-23 10:14:55

results matching ""

    No results matching ""