HTTP/HTTPS
请求协议
中科图灵开放平台 / 智慧消防系统管理模块 / 单位管理-分页列表
单位管理-分页列表
接口地址:https://api.iot.ink/api/app.php?s=Manage.Admin_Dept_GetfindPage.Api
接口描述: 单位管理-分页列表
接口参数
参数名字 | 类型 | 是否必须 | 默认值 | 其他 | 说明 |
---|---|---|---|---|---|
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.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>>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
}
}
失败响应返回示例:
错误列表
错误状态码 | 错误描述信息 |
---|---|
400 | ret=400,客户端参数错误或非法请求 |
404 | 表示接口服务不存在 |
406 | ret=406,access_token令牌校验不通过 |
407 | ret=407,app_key权限不足,或未知应用 |
408 | ret=408,当前用户禁止使用,或用户未登录 |
409 | ret=409,接口流量不足 |
500 | 表示服务端内部错误 |
本文档生成时间:2024-04-20 03:37:57