HTTP/HTTPS
请求协议
中科图灵开放平台 / 智慧消防监测概览模块 / 值班人员信息
值班人员信息
接口地址:https://api.iot.ink/api/app.php?s=Monitor.Device_Warning_GetgetPerson.Api
接口描述: 值班人员信息
接口参数
参数名字 | 类型 | 是否必须 | 默认值 | 其他 | 说明 |
---|---|---|---|---|---|
access_token | 字符串 | 可选 | 访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口 | ||
apiRequestRaw | 字符串 | 可选 | - | ||
headerInfo | 字符串 | 可选 | - | [] |
返回字段
返回结果 | 类型 | 说明 |
---|---|---|
ret | 整型 | 状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误 |
data | 对象或混合类型 | 业务数据,由各自接口指定,通常为对象 |
data.code | 字符串 | 接口返回码 |
data.msg | 字符串 | 接口返回信息 |
data.data | Array | 接口返回分页对象 |
data.data>>total | 字符串 | 总数 |
data.data>>list | 数组 | 列表对象 |
data.data>>list>>name | 字符串 | 名称 |
data.data>>list>>position | 字符串 | 职位 |
data.data>>list>>phone | 字符串 | 联系电话 |
data.data>>list>>status | 整型 | 状态 离线,1 在线 |
data.data>>list>>imagePath | 字符串 | 图片地址 |
data.data>>pageNum | 字符串 | 当前页数 |
data.data>>pageSize | 字符串 | 每页数量 |
data.data>>size | 字符串 | |
data.data>>startRow | 字符串 | |
data.data>>endRow | 字符串 | |
data.data>>pages | 字符串 | |
data.data>>prePage | 字符串 | |
data.data>>nextPage | 字符串 | |
data.data>>isFirstPage | 字符串 | |
data.data>>isLastPage | 字符串 | |
data.data>>hasPreviousPage | 字符串 | |
data.data>>hasNextPage | 字符串 | |
data.data>>navigatePages | 字符串 | |
data.data>>navigatepageNums | 数组 | |
data.data>>navigateFirstPage | 字符串 | |
data.data>>navigateLastPage | 字符串 | |
msg | 字符串 | 提示信息,失败时的错误提示 |
在线测试
参数 | 是否必须 | 值 |
---|---|---|
service | 必须 | |
access_token | 可选 | |
apiRequestRaw | 可选 | |
headerInfo | 可选 |
客户端请求示例
成功响应返回示例:
{
"code": 0,
"msg": null,
"data": {
"total": 3,
"list": [
{
"name": "张三",
"position": "保安队长",
"phone": "1325554562",
"status": "在岗",
"imagePath": ""
},
{
"name": "李四",
"position": "保安队长",
"phone": "1325554562",
"status": "在岗",
"imagePath": ""
},
{
"name": "王五",
"position": "保安队长",
"phone": "1325554562",
"status": "离岗",
"imagePath": ""
}
],
"pageNum": 1,
"pageSize": 3,
"size": 3,
"startRow": 0,
"endRow": 2,
"pages": 1,
"prePage": 0,
"nextPage": 0,
"isFirstPage": true,
"isLastPage": true,
"hasPreviousPage": false,
"hasNextPage": false,
"navigatePages": 8,
"navigatepageNums": [
1
],
"navigateFirstPage": 1,
"navigateLastPage": 1
}
}
失败响应返回示例:
错误列表
错误状态码 | 错误描述信息 |
---|---|
400 | ret=400,客户端参数错误或非法请求 |
404 | 表示接口服务不存在 |
406 | ret=406,access_token令牌校验不通过 |
407 | ret=407,app_key权限不足,或未知应用 |
408 | ret=408,当前用户禁止使用,或用户未登录 |
409 | ret=409,接口流量不足 |
500 | 表示服务端内部错误 |
本文档生成时间:2024-04-28 11:12:48