1. 设备基础信息

获取设备总览的基础信息(在线、离线、异常数量汇总)

注意

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

1.1. 基本信息

概况 内容
接口地址 /api/device/info
请求方法 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 响应数据
normal number 正常数量
offline number 离线数量
type number 设备类型(1-塔吊,2-升降机,3-卸料平台,4-环境监测,5-高支模,6-深基坑,7-隧道监测)
unnormal number 异常数量

响应数据结构如下所示:

{
  "code": 0,
  "message": null,
  "data": [
    {
      "normal": 5,
      "offline": 0,
      "type": 1,
      "unnormal": 0
    },
    {
      "normal": 0,
      "offline": 0,
      "type": 2,
      "unnormal": 1
    },
    {
      "normal": 2,
      "offline": 0,
      "type": 3,
      "unnormal": 1
    },
    {
      "normal": 1,
      "offline": 1,
      "type": 4,
      "unnormal": 0
    }
  ]
}

1.4. 错误码

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

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

results matching ""

    No results matching ""