中科图灵开放平台 / 智慧消防系统管理模块 / 单位管理-分页列表

单位管理-分页列表

接口描述: 单位管理-分页列表

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

接口参数

参数名字类型是否必须默认值其他说明
access_token字符串可选访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口
pageNum字符串必须-当前页码,默认1 示例1
pageSize字符串必须-没有条数,默认10 示例10
name字符串必须-单位名称,模糊查询 示例
types字符串必须-单位类型 1运营单位, 2一般单位 示例1,2
tradeCode字符串必须-所属行业code,详见字典接口 示例A0141
companyCategoryId字符串必须-单位类别id,详见字典接口 示例19
superviseTypeCode字符串必须-监管类别code,详见字典接口 示例supervise_type_01
provinceCode字符串必须-所在区域省份code 示例420000
cityCode字符串必须-所在区域市code 示例420100
areaCode字符串必须-所在区域区code 示例420115
deptId字符串必须-右侧单位树,选中deptId筛选 示例14
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>>deptId字符串单位id
data.data>>list>>name字符串单位名称
data.data>>list>>sort字符串排序值
data.data>>list>>createTime字符串创建时间
data.data>>list>>updateTime字符串修改时间
data.data>>list>>parentId字符串上级id
data.data>>list>>delFlag字符串删除标记
data.data>>list>>tenantId字符串站点id
data.data>>list>>type字符串类型 1运营单位 2一般单位
data.data>>list>>provinceCode字符串所在省code
data.data>>list>>cityCode字符串所在市code
data.data>>list>>areaCode字符串所在区code
data.data>>list>>address字符串所在详细地址
data.data>>list>>provinceName字符串所在省名称
data.data>>list>>cityName字符串所在市名称
data.data>>list>>areaName字符串所在区名称
data.data>>list>>superviseTypeCode字符串监管类别code
data.data>>list>>superviseLevelCode字符串监管级别code
data.data>>list>>companyNatureCode字符串单位性质code
data.data>>list>>companyCategoryId字符串单位类别id
data.data>>list>>tradeCode字符串所属行业code
data.data>>list>>numLimit字符串管理单位数量上限
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字符串
data.data>>list>>superviseTypeName字符串监管类别名称
data.data>>list>>superviseLevelName字符串监管级别名称
data.data>>list>>companyNatureName字符串单位性质名称
data.data>>list>>companyCategoryName字符串单位类别名称
data.data>>list>>tradeName字符串所属行业名称
data.data>>list>>isEva字符串0:非评估机构 1:评估机构
data.data>>list>>businessAddress字符串工商地址
data.data>>list>>legalPeople字符串法律人
data.data>>list>>creditCode字符串信用代码
data.data>>list>>websiteAddress字符串网站地址
msg字符串提示信息,失败时的错误提示

在线测试   

参数是否必须
service 必须
access_token 可选
pageNum 必须
pageSize 必须
name 必须
types 必须
tradeCode 必须
companyCategoryId 必须
superviseTypeCode 必须
provinceCode 必须
cityCode 必须
areaCode 必须
deptId 必须
apiRequestRaw 可选
headerInfo 可选

客户端请求示例

成功响应返回示例:
{
    "code": 0,
    "msg": null,
    "data": {
        "pageNum": 1,
        "pageSize": 10,
        "size": 4,
        "startRow": 1,
        "endRow": 4,
        "total": 4,
        "pages": 1,
        "list": [
            {
                "deptId": 14,
                "name": "一般单位1",
                "sort": 1,
                "createTime": "2020-05-29 16:16:06",
                "updateTime": "2020-06-10 18:27:44",
                "parentId": 6,
                "delFlag": "0",
                "tenantId": 1,
                "type": 2,
                "provinceCode": "420000",
                "cityCode": "420100",
                "areaCode": "420115",
                "address": "金融港b5栋",
                "provinceName": "湖北省",
                "cityName": "武汉市",
                "areaName": "江夏区",
                "superviseTypeCode": "supervise_type_01",
                "superviseLevelCode": "supervise_level_01",
                "companyNatureCode": "company_nature_03",
                "companyCategoryId": "[4,18]",
                "tradeCode": "[A,A04,A041,A0141]",
                "numLimit": null,
                "superviseTypeName": "高危单位",
                "superviseLevelName": "一级消防安全重点单位",
                "companyNatureName": "民营企业",
                "companyCategoryName": null,
                "tradeName": null
            },
            {
                "deptId": 15,
                "name": "一般单位2",
                "sort": 1,
                "createTime": "2020-05-29 16:32:48",
                "updateTime": "2020-06-10 18:27:45",
                "parentId": 6,
                "delFlag": "0",
                "tenantId": 1,
                "type": 2,
                "provinceCode": "420000",
                "cityCode": "420100",
                "areaCode": "420115",
                "address": "金融港b5栋",
                "provinceName": "湖北省",
                "cityName": "武汉市",
                "areaName": "江夏区",
                "superviseTypeCode": "supervise_type_01",
                "superviseLevelCode": "supervise_level_01",
                "companyNatureCode": "company_nature_03",
                "companyCategoryId": "[4,18]",
                "tradeCode": "[A,A04,A041,A0141]",
                "numLimit": null,
                "superviseTypeName": "高危单位",
                "superviseLevelName": "一级消防安全重点单位",
                "companyNatureName": "民营企业",
                "companyCategoryName": null,
                "tradeName": null
            },
            {
                "deptId": 16,
                "name": "天空之城",
                "sort": 1,
                "createTime": "2020-05-29 16:32:48",
                "updateTime": "2020-06-10 18:27:46",
                "parentId": 6,
                "delFlag": "0",
                "tenantId": 1,
                "type": 2,
                "provinceCode": "420000",
                "cityCode": "420100",
                "areaCode": "420115",
                "address": "金融港b5栋",
                "provinceName": "湖北省",
                "cityName": "武汉市",
                "areaName": "江夏区",
                "superviseTypeCode": "supervise_type_01",
                "superviseLevelCode": "supervise_level_01",
                "companyNatureCode": "company_nature_03",
                "companyCategoryId": "[4,18]",
                "tradeCode": "[A,A04,A041,A0141]",
                "numLimit": null,
                "superviseTypeName": "高危单位",
                "superviseLevelName": "一级消防安全重点单位",
                "companyNatureName": "民营企业",
                "companyCategoryName": null,
                "tradeName": null
            },
            {
                "deptId": 24,
                "name": "一般单位33",
                "sort": 1,
                "createTime": "2020-06-10 16:26:15",
                "updateTime": "2020-06-10 18:27:48",
                "parentId": 6,
                "delFlag": "0",
                "tenantId": 1,
                "type": 2,
                "provinceCode": "420000",
                "cityCode": "420100",
                "areaCode": "420115",
                "address": "金融港b5栋",
                "provinceName": "湖北省",
                "cityName": "武汉市",
                "areaName": "江夏区",
                "superviseTypeCode": "supervise_type_01",
                "superviseLevelCode": "supervise_level_01",
                "companyNatureCode": "company_nature_01",
                "companyCategoryId": "[5,19]",
                "tradeCode": "[A,A04,A041,A0141]",
                "numLimit": null,
                "superviseTypeName": "高危单位",
                "superviseLevelName": "一级消防安全重点单位",
                "companyNatureName": "国有企业",
                "companyCategoryName": null,
                "tradeName": 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 03:37:57