人员查询

POST

https://api2.hik-cloud.com/api/v1/estate/system/person/actions/personInfoList

功能描述

查询云眸社区指定社区下所有的住户信息。

注意：本接口查询内容只包含当前社区的房屋资料，如果住户在其他小区也有房屋，将不会显示。

返回码

返回码	返回消息	描述
200	成功
510001	参数错误	必填项为空、参数长度不符合等参数异常情况
511144	超出最大分页量限制

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api2.hik-cloud.com/api/v1/estate/system/person/actions/personInfoList' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{

         
    "communityId": "6514484bc11397508cab7870c633216b",

         
    "pageNo": 1,

         
    "pageSize": 10

         
}'

响应示例

{
    "code": 200,
    "message": "操作成功",
    "data": {
        "pageNo": 1,
        "pageSize": 100,
        "totalPage": 1,
        "total": 1,
        "hasNextPage": false,
        "hasPreviousPage": false,
        "firstPage": true,
        "lastPage": true,
        "rows": [
            {
                "personId": "6514484bc11397508cab7870c633216b",
                "personName": "张三",
                "userName": "zhangsan",
                "gender": 1,
                "mobile": "13358745129",
                "personType": 1,
                "birthday": "2001-02-02",
                "personRemark": "备注信息",
                "nation": "汉族",
                "educationalLevel": 3,
                "workUnit": "海康威视",
                "position": "研发总监",
                "religion": 2,
                "englishName": "Bob",
                "email": "12345@qq.com",
                "addressDetail": "北京市天通苑详细地址",
                "provinceCode": "130000",
                "cityCode": "130100",
                "countyCode": "130102",
                "createTime": "2019-04-07T16:00:00+08:00",
                "personCommunityRels": [
                    {
                        "communityId": "c242a6d58bb4485e99cd5c3e8c1cc570",
                        "buildingId": "c242a6d58bb4485e99cd5c3e8c1cc570",
                        "unitId": "fd8fe4f53fa449c4b9e640956030478b",
                        "roomId": "4b7c226f000146189ff76f445a7cc268",
                        "address": "欣园小区/1幢/二单元/301",
                        "identityType": 1,
                        "checkInDate": "2019-04-07",
                        "checkOutDate": "2029-05-07"
                    }
                ]
            }
        ]
    }
}

请求参数

Header 参数

Authorization

string

可选

默认值:

Bearer {{access_token}}

Body 参数application/json

communityId

string

社区ID

必需

pageNo

integer

当前页数

必需

pageSize

integer

分页量（最大支持100）

必需

示例

返回响应

🟢200成功

application/json

Body

code

integer

返回码

必需

message

string

返回消息

必需

data

object

节点对象

必需

pageNo

integer

当前页数

必需

pageSize

integer

分页量

必需

totalPage

integer

总页数

必需

total

integer

总条数

必需

hasNextPage

boolean

是否有下一页（true：是）

必需

hasPreviousPage

boolean

是否有上一页（true：是）

必需

firstPage

boolean

是否为首页（true：是）

必需

lastPage

boolean

是否为尾页（true：是）

必需

rows

array [object {21}]

资源列表（见下方）

必需

获取人员户室信息

获取人员标签列表