中科图灵开放平台 / 智慧消防系统管理模块 / 分页查询

分页查询

接口描述: 分页查询

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

接口参数

参数名字类型是否必须默认值其他说明
access_token字符串可选访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口
name字符串可选-消防站名称 示例
pageNum字符串必须-当前页码 示例1
pageSize字符串必须-每页条数 示例10
deptId字符串必须-单位id过滤 示例6
apiRequestRaw字符串可选-
headerInfo字符串可选-[]

返回字段

返回结果类型说明
ret整型状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误
data对象或混合类型业务数据,由各自接口指定,通常为对象
data.code字符串
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>>deptId字符串所属单位id
data.data>>list>>name字符串微型消防站名称
data.data>>list>>address字符串地址
data.data>>list>>deptName字符串所属单位
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 可选
name 可选
pageNum 必须
pageSize 必须
deptId 必须
apiRequestRaw 可选
headerInfo 可选

客户端请求示例

成功响应返回示例:
{
  "code": 0,
  "data": {
    "pageNum": 1,
    "pageSize": 10,
    "size": 2,
    "startRow": 1,
    "endRow": 2,
    "total": 2,
    "pages": 1,
    "list": [
      {
        "id": 4,
        "deptId": 2,
        "name": "测试修改",
        "address": "测试修改",
        "deptName": "默认单位"
      },
      {
        "id": 5,
        "deptId": 1,
        "name": "哈哈哈",
        "address": "string"
      }
    ],
    "prePage": 0,
    "nextPage": 0,
    "isFirstPage": true,
    "isLastPage": true,
    "hasPreviousPage": false,
    "hasNextPage": false,
    "navigatePages": 8,
    "navigatepageNums": [
      1
    ],
    "navigateFirstPage": 1,
    "navigateLastPage": 1,
    "lastPage": 1,
    "firstPage": 1
  }
}
失败响应返回示例:

错误列表

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

本文档生成时间:2024-05-14 08:34:25