首页 OpenAPI 开放平台 文档 动态 商城
语言
简体中文 English
   

中科图灵开放平台 / 智慧消防设备管理模块 / 条件分页查询消火栓列表

条件分页查询消火栓列表

接口地址：https://api.iot.ink/api/app.php?s=Equipment.Device_FireHydrant_Getpage.Api

接口描述： 条件分页查询消火栓列表

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

接口参数

参数名字类型是否必须默认值其他说明
access_token字符串可选访问令牌，仅当开启签名验证时需要传递，生成令牌可使用App.Auth.ApplyToken接口
type字符串可选-消火栓类型（1=地下式，2=地上式，3=直埋伸缩） 示例1
outletType字符串可选-出水口（1=单口式，2=双口式，3=三出水口式） 示例1
pipelineType字符串可选-水管道(1=高压给水，2=临时高压给水，3=低压给水) 示例1
sign字符串可选-是否标记--经纬度 (是=1，否=0) 示例0
address字符串可选-详细地址 示例金融港
pageNum整型必须-所在页号 示例1
pageSize整型必须-每页大小 示例10
deptId字符串必须-部门id 示例14
IsDept字符串必须-0表示单位节点 1表示区域节点 示例0
regionId字符串可选-区域id 示例420000
name字符串可选-消火栓名称 示例消火栓
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>>name字符串名称
data.data>>list>>provinceCode字符串省code
data.data>>list>>cityCode字符串市code
data.data>>list>>areaCode字符串区域code
data.data>>list>>provinceName字符串省名称
data.data>>list>>cityName字符串市名称
data.data>>list>>areaName字符串区域名称
data.data>>list>>radius字符串保护半径
data.data>>list>>sign字符串sign 是否标记--经纬度 (是=1，否=0)
data.data>>list>>latLud字符串经纬度
data.data>>list>>type字符串消火栓类型（1=地下式，2=地上式，3=直埋伸缩）
data.data>>list>>outletType字符串出水口（1=单口式，2=双口式，3=三出水口式）
data.data>>list>>firstOutletType字符串第一出水口类型（1=外螺旋式，2=内扣式）
data.data>>list>>firstOutletRadius字符串第一出水口半径(单位：mm)
data.data>>list>>secondOutletType字符串第二出水口类型（1=外螺旋式，2=内扣式）
data.data>>list>>secondOutletRadius字符串第二出水口半径(单位：mm)
data.data>>list>>thirdOutletType字符串第三出水口类型（1=外螺旋式，2=内扣式）
data.data>>list>>thirdOutletRadius字符串第三出水口半径(单位：mm)
data.data>>list>>pipelineType字符串水管道(1=高压给水，2=临时高压给水，3=低压给水)
data.data>>list>>address字符串详细地址
data.data>>list>>deviceId字符串绑定设备id
data.data>>list>>tenantId字符串所属站点id
data.data>>list>>createTime字符串创建时间
data.data>>list>>updateTime字符串修改时间
data.data>>list>>delFlag字符串是否删除 0:正常 1已删除
data.data>>list>>deptId字符串所属单位id
data.data>>list>>deptName字符串所属单位名称
data.data>>list>>deviceCode字符串设备编号
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>>firstPage字符串
data.data>>lastPage字符串
msg字符串提示信息，失败时的错误提示

在线测试   

参数是否必须值
service 必须
access_token 可选
type 可选
outletType 可选
pipelineType 可选
sign 可选
address 可选
pageNum 必须
pageSize 必须
deptId 必须
IsDept 必须
regionId 可选
name 可选
apiRequestRaw 可选
headerInfo 可选

客户端请求示例

HTTP通用示例 
成功响应返回示例：
{
    "code": 0,
    "msg": null,
    "data": {
        "pageNum": 1,
        "pageSize": 10,
        "size": 3,
        "startRow": 1,
        "endRow": 3,
        "total": 3,
        "pages": 1,
        "list": [
            {
                "id": 2,
                "name": "消火栓02",
                "provinceCode": "420000",
                "cityCode": "420100",
                "areaCode": "420115",
                "provinceName": "湖北省",
                "cityName": "武汉市",
                "areaName": "江夏区",
                "radius": 100,
                "sign": "0",
                "latLud": null,
                "type": "2",
                "outletType": "2",
                "firstOutletType": "1",
                "firstOutletRadius": 20,
                "secondOutletType": "2",
                "secondOutletRadius": 30,
                "thirdOutletType": null,
                "thirdOutletRadius": null,
                "pipelineType": "2",
                "address": "金融港B512",
                "deviceId": 1,
                "tenantId": 1,
                "createTime": "2020-06-12 16:46:32",
                "updateTime": null,
                "delFlag": "0",
                "deptId": 14,
                "deptName": "一般单位1",
                "deviceCode": "xx00001"
            },
            {
                "id": 3,
                "name": "消火栓03",
                "provinceCode": "420000",
                "cityCode": "420100",
                "areaCode": "420115",
                "provinceName": "湖北省",
                "cityName": "武汉市",
                "areaName": "江夏区",
                "radius": 200,
                "sign": "1",
                "latLud": null,
                "type": "2",
                "outletType": "2",
                "firstOutletType": "1",
                "firstOutletRadius": 20,
                "secondOutletType": "2",
                "secondOutletRadius": 30,
                "thirdOutletType": "2",
                "thirdOutletRadius": 45,
                "pipelineType": "2",
                "address": "金融港B520",
                "deviceId": null,
                "tenantId": 1,
                "createTime": "2020-06-15 10:24:52",
                "updateTime": null,
                "delFlag": "0",
                "deptId": 14,
                "deptName": "一般单位1",
                "deviceCode": null
            },
            {
                "id": 4,
                "name": "消火栓04",
                "provinceCode": "420000",
                "cityCode": "420100",
                "areaCode": "420115",
                "provinceName": "湖北省",
                "cityName": "武汉市",
                "areaName": "江夏区",
                "radius": 13,
                "sign": "1",
                "latLud": null,
                "type": "2",
                "outletType": "2",
                "firstOutletType": "1",
                "firstOutletRadius": 20,
                "secondOutletType": "2",
                "secondOutletRadius": 30,
                "thirdOutletType": "2",
                "thirdOutletRadius": 45,
                "pipelineType": "2",
                "address": "金融港B521",
                "deviceId": null,
                "tenantId": 1,
                "createTime": "2020-06-15 10:26:46",
                "updateTime": null,
                "delFlag": "0",
                "deptId": 14,
                "deptName": "一般单位1",
                "deviceCode": null
            }
        ],
        "prePage": 0,
        "nextPage": 0,
        "isFirstPage": true,
        "isLastPage": true,
        "hasPreviousPage": false,
        "hasNextPage": false,
        "navigatePages": 8,
        "navigatepageNums": [
            1
        ],
        "navigateFirstPage": 1,
        "navigateLastPage": 1,
        "firstPage": 1,
        "lastPage": 1
    }
}
失败响应返回示例：

错误列表

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

本文档生成时间：2024-04-20 06:24:33