创建人员SophonFogSys/api/users（POST）

功能描述

新建一个人员，人员编号具有唯一性。

调用URL

调用方法: POST

http://192.168.1.180:5555/SophonFogSys/api/users

请求参数（JSON格式）

一级参数二级参数类型默认值选择描述举例

identity_id

string

无

必选

人员编号，可为工号之类的

”001“

need_bring_pic

bool

true

可选

决定是否在注册时候附带图片，默认true,需要附带图片

import_mode

bool

false

可选

False：使用图片提取特征值进行注册 ，即传入reg_photo。True：使用传入的特征值进行注册，即传入feature。

reg_photo

base64

无

必选

完成人脸的创建，在need_bring_pic默认值即true时，必须要带图片数据进行注册。

feature

list

无

import_mode =True时候必选

group_name

string

无

必选

直接完成分组的绑定，可以支持多个分组同时绑定，分组名称之间以英文字符逗号分隔。

”default_group“

ignore_exist

boolean

false

可选

默认为false，当这个identity_id已经存在的时候，会返回already exist的错误, 设置成true的话，会忽略已经存在错误，把这个人添加到group里面，并把当前信息update到该identity_id上

false

create_no_exit_permission

boolean

false

可选

默认为False, 当创建的人员携带的权限组id即permisssion_ids不存在不会进行自动创建设置为True的话，填写的权限组id不存在就会自动创建权限组

false

support_single_face

boolean

false

可选

默认为false, 如果为true, 要求只支持单一人脸，把之前注册的人脸进行删除。

fiqa_level

string

无

可选

质量检测级别，共high，middle，low，custom, no 5个级别, 其中no表示下放人员不需要再进行质量检测

info

dict

必选

个人其他信息

name

string

无

必选

人员名称

小王

type

int

无

必选

1: 员工（默认为员工，包括这个字段不存在的情况） 2: 访客 4: 陌生人 5: VIP

1

permission_ids

list

无

可选

权限组， 此处为列表（数组）, 如["f4add9c0-4212-4064-a045-b6185cf00501","abckd9c0-4212-4064-a045-b6185defw501"]

["f4add9c0-4212-4064-a045-b6185cf00501","abckd9c0-4212-4064-a045-b6185defw501"]

....

自定义

可选

其他的用户信息

注意，如果想要和SE5 边缘计算盒中的LiteOS 中人员信息（更多配置）同步，info字段部分需要按照下面的要求进行：

一级参数二级参数三级参数类型默认值选择描述（展示文案）

info

dict

{}

必选

name

string

无

必选

姓名

user_id

string

无

必选

用户ID

ext_info

dict

{}

可选

mobile

string

无

可选

手机号

email

string

无

可选

电子邮箱

idNumber

string

无

可选

证件号码

gender

string

无

可选

性别

visit_card_number

string

无

可选

门禁卡号

jobNumber

string

无

可选

工号

department

string

无

可选

部门

entryTime

string

无

可选

入职时间

title

string

无

可选

职位

address

string

无

可选

地址

floor

string

无

可选

楼层

building_no

string

无

可选

楼栋

room

string

无

可选

房间号

descriptor

string

无

可选

人员描述

startTime

string

无

可选

访客有效，来访时间

endTime

string

无

可选

访客有效，离开时间

purpose

string

无

可选

访客有效，来访目的

Interviewee

string

无

可选

访客有效，受访人

comeFrom

string

无

可选

访客有效，受访单位

message

string

无

可选

访客有效，欢迎语

请求示例：

请求url: http://192.168.1.180:5555/SophonFogSys/api/users
请求body:
        {
            "info":{"name":"小王","type":1,"permission_ids":["f4add9c0-4212-4064-a045-						b6185cf00501","abckd9c0-4212-4064-a045-b6185defw501"]},
            "group_name":"default_group",
            "identity_id":"001",
            "import_mode":false,
            "reg_photo":""  //base64格式图片内容
        }

返回信息：

请求成功

一级参数二级参数三级参数类型选择描述

data

dict

identity_id

string

必选

人员编号，可为工号之类的

reg_photo

base64

必选

完成人脸的创建

group_name

string

必选

直接完成分组的绑定,

info

dict

必选

个人其他信息

name

string

必选

人员名称

type

int

必选

1:员工（默认为员工，包括这个字段不存在的情况）2: 访客3: 黑名单4：陌生人5:VIP

permission_ids

list

必选

权限组，列表（数组）, 如["f4add9c0-4212-4064-a045-b6185cf00501","abckd9c0-4212-4064-a045-b6185defw501"]

.......

自定义

可选

其他的用户信息

请求成功示例：

{
    "data": {
        "group_name": "default_group",
        "identity_id": "001",
        "info": {
            "name": "小王",
            "permission_ids": ["f4add9c0-4212-4064-a045-b6185cf00501","abckd9c0-4212-								4064-a045-b6185defw501"],
            "type": 1,
            "user_id": "001"
        },
        "reg_photo": "xxx"
    }
}

请求失败

一级参数二级参数类型描述

error

code

int

请求错误码

message

string

错误描述

status

string

错误类型

Previous3. 人员管理Next查询人员/SophonFogSys/api/users（GET）

Last updated