文档首页/ ISDP/ API参考/ API接口/ 人员管理/ 查询人员信息（API名称：getPersonList）
更新时间：2024-04-26 GMT+08:00
查看PDF
分享

查询人员信息（API名称：getPersonList）

功能介绍

查询人员信息：人员名称、人员编码、人员状态、角色、岗位、电话号码等信息

相关接口

接口名称

调用说明

获取Token

调用该接口获取到Token，再调用其他接口时，需要在请求消息头中添加“Authorization”，其值即为Token。

URL

请求方式

HTTPS地址

服务架构

消息体类型

POST

https://isdp+域名/openapi/v1/person/getPersonList

OpenAPI

application/json

请求头

KEY

VALUE

是否必填

描述

Content-Type

application/json

是

无

Authorization

bearer ${access_token}

是

bearer +“ ”+5.2.1中获取的access_token的值

请求参数

参数

数据类型

是否必填

描述

page

PageRequest

否

分页参数

roleIds

List<Long>

否

角色id列表

roleName

String

否

角色名称，多个用英文分号分隔

roleNo

List<String>

否

角色编码列表

positionIds

List<Long>

否

岗位id列表

positionCode

List<String>

否

岗位编码列表

positionName

String

否

岗位名称，多个用英文分号分隔

idList

List<Long>

否

人员id列表

personCodeList

List<String>

否

人员编码列表

personCode

String

否

人员编码，模糊查询

personNameList

List<String>

否

人员名称列表

personName

String

否

人员名称，模糊查询

personStatus

String

否

人员状态编码：NoAccountOpened;OpeningAccount;OpenAccount;Freeze;Cancel，多个用英文分号分隔

personType

String

否

人员类型编码：Admin;Customer;Employee;Other;Supplier，多个用英文分号分隔

isSmartDevice

String

否

是否为智能设备账号，Y：查询智能设备账号，N：不查询智能设备账号

orgIdList

List<Long>

否

所属组织id集合

orgIncludeChild

boolean

否

是否包含所属组织的子级组织

orgNoList

List<String>

否

所属组织编码集合

orgName

String

否

组织名称，单个组织名称则为右模糊查询，多个用英文分号分隔则为精确批量查询

profilePictureStatus

String

否

工作照状态，已上传：CollectionSucceeded，未上传：CollectionFailed

phone

String

否

电话号码

PageRequest:

参数

数据类型

是否必填

描述

start

int

否

分页查询开始的位置，默认为0

count

int

否

分页查询取多少条数据，默认为200

响应参数

字段名

数据类型

字段名称

personId

Long

人员id

personCode

String

人员编码

personName

String

人员名称

personType

String

人员类型

profilePictureStatus

String

工作照状态，CollectionSucceeded:已注册、CollectionFailed:未注册

userId

Long

用户id

phone

String

手机号码，脱敏返回

integrationAccount

String

集成账号

roleInfo

List<Map<String,Object>>

角色信息

positionInfo

List<Map<String,Object>>

岗位信息

Org

Map<String, Object>

组织信息

udfExtend1

String

扩展字段1

udfExtend2

String

扩展字段2

udfExtend3

String

扩展字段3

udfExtend4

String

扩展字段4

udfExtend7

String

扩展字段7

udfExtend8

String

扩展字段8

udfExtend9

String

扩展字段9

udfExtend10

String

扩展字段10

tenantId

Long

租户id

certificateType

String

证件类型

certificateNo

String

证件号码

profilePictureId

String

证件照id

blackList

int

黑名单0：否，1：是

reason

String

原因

adminOrgId

Long

所属行政组织

lastUpdatedBy

Long

最后更新人

lastUpdateDate

String

最后更新时间

personStatus

String

人员状态

isSmartDevice

String

是否为智能设备账号

qualificationCode

String

作业资质id(多个用英文逗号分隔)

roleInfo:

参数

类型

描述

roleId

Long

角色id

roleName

String

角色名称

roleCode

String

角色编码

positionInfo:

参数

类型

描述

positionName

String

岗位名称

positionId

Long

岗位id

positionCode

String

岗位编码

请求示例

{
    "page": {
        "count": 20,
        "start": 0
    },
    "positionIds": [
        5000829,
        5000830
    ],
    "positionCode": [
        "HWtest"
    ],
    "positionName": "测试",
    "idList": [
        5001610,
        5001609
    ],
    "personCodeList": [
        "h00799695b",
        "h00799695a"
    ],
    "personName": null,
    "personType": "Employee;Customer",
    "orgIdList": [
        9911292880
    ],
    "orgIncludeChild": false,
    "orgNoList": [
        "SaasTenant101075"
    ],
    "orgName": "1551",
    "profilePictureStatus": "CollectionFailed",
    "phone": "13572003278",
    "personStatus": "NoAccountOpened;OpenAccount",
    "isSmartDevice": "N",
    "roleName": "现场作业人员;项目助理/后台人员",
    "roleNo": [
        "ConstructionSiteOperator",
        "ConstructionProjectAssistant"
    ],
    "roleId": [
        126290,
        126294
    ]
}

响应示例

{
    "data": [
        {
            "personId": 5001610,
            "profilePictureStatus": "CollectionFailed",
            "personCode": "h00799695b",
            "personName": "黄xxtest2",
            "qualificationCode": null,
            "personType": "Employee",
            "tenantId": 101075,
            "certificateType": "",
            "certificateNo": null,
            "profilePictureId": "",
            "blackList": 0,
            "reason": null,
            "phone": "135******78",
            "adminOrgId": 9911292880,
            "integrationAccount": "",
            "lastUpdatedBy": 36378,
            "lastUpdateDate": "2023-08-11T14:23:09.000+08:00",
            "personStatus": "NoAccountOpened",
            "udfExtend1": null,
            "udfExtend2": null,
            "udfExtend3": null,
            "udfExtend4": null,
            "udfExtend7": null,
            "udfExtend8": null,
            "udfExtend9": null,
            "udfExtend10": null,
            "isSmartDevice": "N",
            "userId": 5003069,
            "Org": {
                "id": 9911292880,
                "orgId": 9911292880,
                "value": "15512345678aaa",
                "orgName": "15512345678aaa",
                "orgNo": "SaasTenant101075"
            },
            "positionInfo": [
                {
                    "positionName": "测试",
                    "positionId": "5000829",
                    "positionCode": "HWtest"
                }
            ],
            "roleInfo": [
                {
                    "roleId": "126290",
                    "roleCode": "ConstructionSiteOperator",
                    "roleName": "现场作业人员"
                },
                {
                    "roleId": "126294",
                    "roleCode": "ConstructionProjectAssistant",
                    "roleName": "项目助理/后台人员"
                }
            ]
        }
    ],
    "pos": 0,
    "total_count": 1,
    "entityName": null,
    "totalCount": 1
}

父主题： 人员管理

相关文档