HTTP/HTTPS
请求协议
中科图灵开放平台 / 智慧消防设备管理模块 / 分页查询消防主机信息
分页查询消防主机信息
接口地址:https://api.iot.ink/api/app.php?s=Equipment.Device_FireMainEngine_GetlistFireMainEngine.Api
接口描述: 分页查询消防主机信息
接口参数
参数名字 | 类型 | 是否必须 | 默认值 | 其他 | 说明 |
---|---|---|---|---|---|
access_token | 字符串 | 可选 | 访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口 | ||
code | 字符串 | 必须 | - | 消防主机编号 示例 | |
address | 字符串 | 必须 | - | 地址 示例 | |
pageNum | 整型 | 必须 | - | 当前页 示例 | |
pageSize | 整型 | 必须 | - | 每页显示数量 示例 | |
apiRequestRaw | 字符串 | 可选 | - | ||
headerInfo | 字符串 | 可选 | - | [] |
返回字段
返回结果 | 类型 | 说明 |
---|---|---|
ret | 整型 | 状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误 |
data | 对象或混合类型 | 业务数据,由各自接口指定,通常为对象 |
data.code | 字符串 | |
data.msg | 字符串 | |
data.data | Array | |
data.data>>pageNum | 字符串 | 当前页 |
data.data>>pageSize | 字符串 | 每页大小 |
data.data>>size | 字符串 | |
data.data>>startRow | 字符串 | |
data.data>>endRow | 字符串 | |
data.data>>total | 字符串 | 总数量 |
data.data>>pages | 字符串 | 总页数 |
data.data>>list | 数组 | |
data.data>>list>>id | 字符串 | 消防主机id |
data.data>>list>>code | 字符串 | 主机编号 |
data.data>>list>>latitudeLongitude | 字符串 | 经纬度 |
data.data>>list>>address | 字符串 | 地址 |
data.data>>list>>deptId | 字符串 | 部门id |
data.data>>list>>tenantId | 字符串 | 站点id |
data.data>>list>>createTime | 字符串 | |
data.data>>list>>delFlag | 字符串 | |
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 | 字符串 | |
data.data>>lastPage | 字符串 | |
data.data>>firstPage | 字符串 | |
msg | 字符串 | 提示信息,失败时的错误提示 |
在线测试
参数 | 是否必须 | 值 |
---|---|---|
service | 必须 | |
access_token | 可选 | |
code | 必须 | |
address | 必须 | |
pageNum | 必须 | |
pageSize | 必须 | |
apiRequestRaw | 可选 | |
headerInfo | 可选 |
客户端请求示例
成功响应返回示例:
{
"code": 0,
"msg": null,
"data": {
"pageNum": 2,
"pageSize": 10,
"size": 1,
"startRow": 11,
"endRow": 11,
"total": 11,
"pages": 2,
"list": [
{
"id": 11,
"code": "91",
"latitudeLongitude": null,
"address": "光谷广场",
"deptId": null,
"tenantId": null,
"createTime": null,
"delFlag": null
}
],
"prePage": 1,
"nextPage": 0,
"isFirstPage": false,
"isLastPage": true,
"hasPreviousPage": true,
"hasNextPage": false,
"navigatePages": 8,
"navigatepageNums": [
1,
2
],
"navigateFirstPage": 1,
"navigateLastPage": 2,
"lastPage": 2,
"firstPage": 1
}
}
失败响应返回示例:
错误列表
错误状态码 | 错误描述信息 |
---|---|
400 | ret=400,客户端参数错误或非法请求 |
404 | 表示接口服务不存在 |
406 | ret=406,access_token令牌校验不通过 |
407 | ret=407,app_key权限不足,或未知应用 |
408 | ret=408,当前用户禁止使用,或用户未登录 |
409 | ret=409,接口流量不足 |
500 | 表示服务端内部错误 |
本文档生成时间:2024-05-14 07:20:03