1. 门禁接入

API列表

编号 API名称 路径 版本
1.1 组织架构顶层查询 /v1/iot/door/face/doorAuthEmploy/queryParentOrg 1.0
1.2 组织架构查询 /v1/iot/door/face/doorAuthEmploy/queryOrg 1.0
1.3 组织获取员工接口 /v1/iot/door/face/doorAuthEmploy/queryEmploye 1.0
1.4 添加员工信息 /v1/iot/door/face/doorAuthEmploy/insertEmploye 1.0
1.5 员工信息查询 /v1/iot/door/face/doorAuthEmploy/queryDoorEmploye 1.0

API调用

1.1: 组织架构顶层查询

描述 组织架构顶层查询

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/door/face/doorAuthEmploy/queryParentOrg

方法：POST

名称 位置 类型 必填 描述

请求参数

名称 位置 类型 必填 描述
token body string y 请求token
pageNo body string y 页码
pageSize body string y 页数

请求Body描述(非Form表单数据)

{
    "token":"MTczNUU3MkMzMUJFOEVGMThFNTc2OUIwQzE2NEQxNjNCRkFBNzYzQjZDNUFCMjhFOTc1NzE5NkY4QkJGQjNEQw==",
    "pageNo": 0,
    "pageSize": 9999
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
success 顶层 boolean 是 是否成功
data 顶层 boolean 是 响应数据对象
返回结果示例
{
    "code": "200",
    "success": true,
    "data": {
        "count": "1",
        "list": [
            {
                "code": "1",
                "full_name": "美的集团",
                "full_parent_id": "",
                "parent_id": "",
                "name": "美的集团",
                "id": "5da0539bdd622b40a752c50e"
            }
        ]
    }
}

1.2: 组织架构查询

描述 组织架构查询

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/iot/door/face/doorAuthEmploy/queryOrg

方法：POST

名称 位置 类型 必填 描述

请求参数

名称 位置 类型 必填 描述
token body string y 请求token
pageNo body string y 页码
pageSize body string y 页数
parentId body string y 父节点id

请求Body描述(非Form表单数据)

{
    "token":"MTczNUU3MkMzMUJFOEVGMThFNTc2OUIwQzE2NEQxNjNCRkFBNzYzQjZDNUFCMjhFOTc1NzE5NkY4QkJGQjNEQw==",
    "pageNo": 0,
    "pageSize": 9999,
    "parentId": "5da0539bdd622b40a752c50e"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING y 响应码标识
success 顶层 boolean y 是否成功
data 顶层 boolean y 响应数据对象
返回结果示例
{
    "code":"200",
    "success":true,
    "data":{
        "count":"3",
        "list":[
            {
                "code":"2",
                "full_name":"美的集团/外部账户组织机构",
                "full_parent_id":"5da0539bdd622b40a752c50e",
                "parent_id":"5da0539bdd622b40a752c50e",
                "name":"外部账户组织机构",
                "id":"5db82b72dd622b1d98ab48dd"
            },
            Object{...},
            Object{...}
        ]
    }
}

1.3: 组织获取员工信息

描述

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/iot/door/face/doorAuthEmploy/queryEmploye

方法：POST

名称 位置 类型 必填 描述

请求参数

名称 位置 类型 必填 描述
token body string y token
pageNo body int y 页码
pageSize body int y 页数
orgCode body string y 组织编码
username body string n 姓名

请求Body描述(非Form表单数据)

{
    "token":"MkRCNTRGMDg3RjgzQzU1Q0ZGNjA3RTdGMDE2QjNBNjlEN0MzOTY2Q0FEMTU1NDVGMkI3Qzg1NTFEN0UxMUFBNQ==",
    "pageNo": 0,
    "pageSize": 9999,
    "orgCode": "1",
    "username":"潘"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 boolean 是 响应数据对象
返回结果示例
{
    "code": "200",
    "success": true,
    "data": {
        "count": "2",
        "list": [
            {
                "id": "2027640",
                "name": "潘少基",
                "account": "pansj3",
                "phone": "",
                "orgName": "智能系统开发部"
            }
        ]
    }
}

1.4: 新增员工信息

描述 新增员工信息

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/iot/door/face/doorAuthEmploy/insertEmploye

方法：POST

名称 位置 类型 必填 描述

请求参数

名称 位置 类型 必填 描述
params body JSONArray y 参数
personId params string y 员工id
account params string y 员工账号
personName params string y 员工名
orgName params string n 组织名
email params string n email
phone params string n 电话
projectId params string n 项目id

请求Body描述(非Form表单数据)

{
    "params": [
        {
            "personId":"2027640",
            "account":"pansj3",
            "personName":"潘少基",
            "orgName":"智能开发部",
            "email":"1111@mail",
            "phone": "13800138000",
            "projectId":"21322153" 
        }
    ]
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 boolean 是 响应数据对象
返回结果示例
{
    "code": "200",
    "success": true,
    "data": true
}

1.5: 员工查询

描述 员工查询

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/iot/door/face/doorAuthEmploy/queryDoorEmploye

方法：POST

名称 位置 类型 必填 描述

请求参数

名称 位置 类型 必填 描述
pageNo body int y 页码
pageSize body int y 页数
seachText body string n 姓名或电话
projectId body int y 项目id

请求Body描述(非Form表单数据)

{
    "pageNo": 1,
    "pageSize": 10,
    "seachText": "138",
    "projectId":"21322153" 
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 boolean 是 响应数据对象
返回结果示例
{
    "code": "200",
    "success": true,
    "data": {
        "total": 1,
        "list": [
            {
                "empPhone": "13800138000",
                "createTime": 1604315001000,
                "empName": "潘少基",
                "empEmail": "1111@mail",
                "personId": 2027640,
                "updateTime": 1604315002000,
                "id": 2,
                "projectId": "21322153",
                "account": "pansj3"
            }
        ]
    }
}

results matching ""

    No results matching ""