中科图灵开放平台 / 智慧消防设备管理模块 / 分页查询消防主机信息

分页查询消防主机信息

接口描述: 分页查询消防主机信息

HTTP/HTTPS
请求协议
GET
请求方式
UTF-8
编码格式
JSON
返回格式
v1.0
版本号

接口参数

参数名字类型是否必须默认值其他说明
access_token字符串可选访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口
code字符串必须-消防主机编号 示例
address字符串必须-地址 示例
pageNum整型必须-当前页 示例
pageSize整型必须-每页显示数量 示例
apiRequestRaw字符串可选-
headerInfo字符串可选-[]

返回字段

返回结果类型说明
ret整型状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误
data对象或混合类型业务数据,由各自接口指定,通常为对象
data.code字符串
data.msg字符串
data.dataArray
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
    }
}
失败响应返回示例:

错误列表

错误状态码错误描述信息
400ret=400,客户端参数错误或非法请求
404表示接口服务不存在
406ret=406,access_token令牌校验不通过
407ret=407,app_key权限不足,或未知应用
408ret=408,当前用户禁止使用,或用户未登录
409ret=409,接口流量不足
500表示服务端内部错误

本文档生成时间:2024-05-14 07:20:03