人员管理

人员管理相关接口

请求方式	API	描述
GET	/v1.0/iot-02/building/personnel	获取人员列表
POST	/v1.0/iot-02/building/personnel	添加人员
PUT	/v1.0/iot-02/building/personnel	编辑人员
GET	/v1.0/iot-02/building/personnel/{person_id}/actions/detail	获取人员详情
PUT	/v1.0/iot-02/building/personnel/actions/disable	禁用/批量禁用人员
DELETE	/v1.0/iot-02/building/personnel/actions/delete	删除人员/批量删除人员
GET	/v1.0/iot-02/building/personnel/recycle-list	获取已删除人员列表
GET	/v1.0/iot-02/building/personnel/{person_id}/recycle-detail	获取已删除人员详情
PUT	/v1.0/iot-02/building/personnel/actions/recover	恢复人员/批量恢复人员

获取人员列表

功能描述

获取人员列表。

接口地址

GET /v1.0/iot-02/building/personnel

请求参数

参数名	类型	参数类型	说明	是否必需
projectId	String	body	项目 ID	false
structureId	String	body	组织 ID	false
searchType	int	body	查询类型。 1：只查询 structureId 下直接关联人员。 2：查询 structureId 关联及所有下级组织人员。默认值。	false
name	String	body	姓名	false
enabled	int	body	是否启用。 1：启用，默认 1。 2：禁用。	false
sex	int	body	性别	false
mobile	String	body	手机号码	false
email	String	body	邮箱	false
certType	String	body	证件类型	false
certNo	String	body	证件号码	false
feature	String	body	生物特征	false
personCode	String	body	工号	false
page	int	body	当前页	false
pageSize	int	body	每页数量	false

返回参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功。true：成功，false：失败
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13 位
result	Object	返回结果

result 参数说明

{
  "total": "int",
  "list": [
    {
      "personId": "String //人员 ID",
      "name": "String //姓名",
      "enabled": "int //是否启用",
      "sex": "int //性别（code）",
      "sexStr": "String //性别（值）",
      "mobileCountry": "String //手机码",
      "mobile": "String //手机号",
      "certArea": "String //证件号区域",
      "certType": "String //证件类型（code）",
      "certTypeStr": "String //证件类型（值）",
      "certNo": "String //证件号",
      "feature": "String //生物特征",
      "imageUrl": "String //头像 URL 地址",
      "imagePath": "String //图片路径",
      "checked": "boolean //是否检测",
      "imageRating": "float //图片评分，人脸需要",
      "pass": "boolean //照片是否合格",
      "personCode": "String //工号",
      "structureIds": "String[] //组织关系 ID",
      "structureNames": "String[] //组织名称",
      "structureName": "String //组织名称（用于导出字段映射）",
      "structureSnapshots": "String[] //快照"
    }
  ]
}

请求示例

{
    "projectId":"1424615984265764***"
}

响应示例

{
    "result": {
        "has_more": true,
        "list": [
            {
                "cert_area": "",
                "cert_no": "",
                "cert_type": "_",
                "cert_type_str": "",
                "enabled": 1,
                "image_path": "saas/building/building_faceImg/166254529797b6a44bfdc.jpg",
                "image_rating": 0,
                "mobile": "199****9879",
                "mobile_country": "+86",
                "name": "newpeople",
                "person_code": "456",
                "person_id": "1567428253323362***",
                "sex": 1,
                "sex_str": "男",
                "structure_ids": [
                    "1466612511766855***"
                ],
                "structure_name": "根组织 66678\\通行权限测试",
                "structure_names": [
                    "根组织 66678\\通行权限测试"
                ],
                "structure_snapshots": [
                    ""
                ]
            }
        ],
        "total": 83
    },
    "success": true,
    "t": 1662709749871,
    "tid": "e36a959a301311edaf4dfa23c521f7ba"
}

添加人员

功能描述

添加人员。

接口地址

POST /v1.0/iot-02/building/personnel

请求参数

参数名	类型	参数类型	说明	是否必需
projectId	String	body	项目 ID	false
personId	String	body	人员 ID	false
structureId	String	body	组织 ID	false
name	String	body	姓名	false
enabled	int	body	是否启用	false
sex	int	body	性别。 0：未知 1：男 2：女	false
mobileCountry	String	body	国家码	false
mobile	String	body	手机号码	false
email	String	body	邮箱	false
certArea	String	body	证件区域	false
certType	String	body	证件类型	false
certNo	String	body	证件号码	false
imagePath	String	body	头像	false
imageRating	float	body	图片评分	false
personCode	String	body	工号	false
uploadType	String	body	上传方式	false

返回参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功。true：成功，false：失败
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13 位
result	Object	返回结果

result 参数说明

boolean{}

请求示例

{
    "projectId":"1424615984265764**",
    "name":"开放 API 测试 3",
    "sex":1,
    "structureId":"1563057531880804***",
    "mobile":"18858286***",
    "mobileCountry":"+86",
    "certNo":"330483199608241***",
    "certType":"ID_CARD_CN",
    "certArea":"CN"
}

响应示例

{
    "result": true,
    "success": true,
    "t": 1628669342514
}

编辑人员

功能描述

编辑人员。

接口地址

PUT /v1.0/iot-02/building/personnel

请求参数

参数名	类型	参数类型	说明	是否必需
projectId	String	body	项目 ID	false
personId	String	body	人员 ID	false
structureId	String	body	组织 ID	false
originStructureId	String	body	原组织结构 ID	false
name	String	body	姓名	false
enabled	int	body	是否启用	false
sex	int	body	性别。 0：未知 1：男 2：女	false
mobileCountry	String	body	国家码	false
mobile	String	body	手机号码	false
email	String	body	邮箱	false
certArea	String	body	证件区域	false
certType	String	body	证件类型	false
certNo	String	body	证件号码	false
imagePath	String	body	头像	false
imageRating	float	body	图片评分	false
personCode	String	body	工号	false
uploadType	String	body	上传方式	false

返回参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功。true：成功，false：失败
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13 位
result	Object	返回结果

result 参数说明

boolean{}

请求示例

{
    "projectId":"1424615984265764***",
    "name":"测试 2",
    "sex":2,
    "structureId":"1439128403298041***",
    "mobile":"18858286***",
    "mobileCountry":"+86",
    "certNo":"330483199608240***",
    "certType":"ID_CARD_CN",
    "certArea":"CN"
}

响应示例

{
    "result": true,
    "success": true,
    "t": 1628669342514
}

获取人员详情

功能描述

获取人员详情。

接口地址

GET /v1.0/iot-02/building/personnel/{person_id}/actions/detail

请求参数

参数名	类型	参数类型	说明	是否必需
personId	String	body	人员 ID	false
projectId	String	body	项目 ID	false

返回参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功。true：成功，false：失败
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13 位
result	Object	返回结果

result 参数说明

同人员列表接口。

请求示例

{
    "projectId":"1424615984265764***",
    "personId":"1563051208690630***"
}

响应示例

同列表接口。

禁用/批量禁用人员

功能描述

禁用/批量禁用人员。

接口地址

PUT /v1.0/iot-02/building/personnel/actions/disable

请求参数

参数名	类型	参数类型	说明	是否必需
projectId	String	body	项目 ID	false
personIdList	String[]	body	人员 ID 集	false

返回参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功。true：成功，false：失败
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13 位
result	Object	返回结果

result 参数说明

boolean{}

请求示例

{
    "projectId":"1424615984265764***",
    "personId":"1562778729048965***"
}

响应示例

{
    "result": true,
    "success": true,
    "t": 1628669342514
}

删除人员/批量删除人员

功能描述

删除人员/批量删除人员。

接口地址

DELETE /v1.0/iot-02/building/personnel/actions/delete

请求参数

参数名	类型	参数类型	说明	是否必需
projectId	String	body	项目 ID	false
personId	String	body	人员 ID	false
personIdList	String[]	body	人员 ID 集	false
targetStructureId	String	body	目标组织 ID	false
originStructureId	String	body	原有组织 ID	false

返回参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功。true：成功，false：失败
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13 位
result	Object	返回结果

result 参数说明

boolean{}

请求示例

{
  "personIdList": "人员 ID 集",
  "originStructureId": "原有组织 ID",
  "personId": "人员 ID",
  "projectId": "项目 ID",
  "targetStructureId": "目标组织 ID"
}

响应示例

boolean{}

获取已删除人员详情

功能描述

获取已删除人员详情。

接口地址

GET /v1.0/iot-02/building/personnel/{person_id}/recycle-detail

请求参数

参数名	类型	参数类型	说明	是否必需
personId	String	body	人员 ID	false
projectId	String	body	项目 ID	false

返回参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功。true：成功，false：失败
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13 位
result	Object	返回结果

result 参数说明

同列表接口。

请求示例

{
  "personId": "人员 ID"
}

响应示例

同列表接口。

获取已删除人员列表

功能描述

获取已删除人员列表。

接口地址

GET /v1.0/iot-02/building/personnel/recycle-list

请求参数

参数名	类型	参数类型	说明	是否必需
projectId	String	body	项目 ID	false
structureId	String	body	组织 ID	false
structureSnapshotName	String	body	搜索组织快照信息	false
searchType	int	body	查询类型。 1：只查询 structureId 下直接关联人员。 2：查询 structureId 关联及所有下级组织人员。默认。	false
name	String	body	姓名	false
enabled	int	body	是否启用。 1：启用，默认 1。 2：禁用	false
sex	int	body	性别	false
mobile	String	body	手机号码	false
email	String	body	邮箱	false
certType	String	body	证件类型	false
certNo	String	body	证件号码	false
feature	String	body	生物特征	false
personCode	String	body	工号	false
page	int	body	当前页	false
pageSize	int	body	每页数量	false
isExportQuery	boolean	body	是否是导出查询，默认不导出	false

返回参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功。true：成功，false：失败
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13 位
result	Object	返回结果

result 参数说明

同列表接口。

请求示例

同列表接口。

响应示例

{
  "total": "int",
  "list": [
    {
      "list": "快照"
    }
  ],
  "hasMore": "boolean"
}

恢复人员/批量恢复人员

功能描述

恢复人员/批量恢复人员。

接口地址

PUT /v1.0/iot-02/building/personnel/actions/recover

请求参数

参数名	类型	参数类型	说明	是否必需
projectId	String	body	项目 ID	false
personId	String	body	人员 ID	false
personIdList	String[]	body	人员 ID 集	false
targetStructureId	String	body	目标组织 ID	false
originStructureId	String	body	原有组织 ID	false

返回参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功。true：成功，false：失败
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13 位
result	Object	返回结果

result 参数说明

boolean{}

请求示例

{
  "personIdList": "人员 ID 集",
  "originStructureId": "原有组织 ID",
  "personId": "人员 ID",
  "projectId": "项目 ID",
  "targetStructureId": "目标组织 ID"
}

响应示例

boolean{}

错误码

以下为该接口常见的业务异常。更多的异常错误，请参见全局错误码。

错误码	说明
500	系统错误