2.3 用户同步(主动查询)
# 2.3 用户同步(主动查询)
企业方面提供查询接口,百福得主动查询,默认频率为一天一次,全量更新用户信息,account不存在创建,存在则更新
# 接口URL
客户方提供,百福得主动查询
# HTTP请求方式
POST
# 公共参数
| 字段 | 类型 | 是否必填 | 中文意描述 |
|---|---|---|---|
| appId | String | 是 | appId,由客户方提供 |
| timestamp | String | 是 | 毫秒级时间戳 防止重复攻击 |
| version | String | 否 | 业务接口版本号,如1.0.0 |
| sign | String | 是 | 签名 |
# body参数
| 字段 | 类型 | 是否必填 | 中文意描述 |
|---|---|---|---|
| pageNo | Integer | 是 | 页码 |
| pageSize | Integer | 是 | 单页数量 默认200 |
| deptId | String | 否 | 部门id |
# 请求示例
POST /userlist?appId=abc×tamp=1620710648458&sign=fa66cb4d8604413b8fb30afd32e3e73e HTTP/1.1 Content-Type: application/json Cache-Control: no-cache { "pageNo": 1, "pageSize":200 }1
2
3
4
5
6
7
# 返回参数说明
| 字段 | 类型 | 是否必填 | 中文意描述 |
|---|---|---|---|
| code | String | 返回码 | |
| data | ResponseData | 否 | 用户集合 |
| msg | String | 否 | 如果错误,返回错误信息 |
ResponseData:
| 字段 | 类型 | 是否必填 | 中文意描述 |
|---|---|---|---|
| account | String | 是 | 账号 |
| initiationStatus | String | 是 | 在职状态1在职 2离职(员工创建和更新均为在职,东福区分执行创建/更新) |
| username | String | 是 | 姓名 |
| externalNo | String | 是 | 企业内部用户唯一标识(若无唯一标识可赋值与account一致,出参根据externalNo返回用户信息校验结果) |
| password | String | 否 | 初始密码 |
| enname | String | 否 | 英文名 |
| mobile | String | 否 | 手机 |
| String | 否 | 邮箱 | |
| sex | String | 否 | 性别 1:男 2:女 |
| birthday | String | 否 | 生日 格式 yyyy-MM-dd |
| initiationAt | String | 否 | 入会时间 格式 yyyy-MM-dd |
| entryAt | String | 否 | 入职时间 格式 yyyy-MM-dd |
| isForeigner | String | 否 | 是否外籍员工 0:非外籍员工 1:外籍员工 |
| department | String | 否 | 部门code,详见部门同步接口 |
| position | String | 否 | 员工岗位名称(职位) |
| jobNumber | String | 否 | 工号 |
| idType | String | 否 | 证件类型 1-身份证、2-警官证、3-军官证、4-港澳台证、5-护照、6-其他、7-港澳居民来往大陆通行证、8-台湾居民来往大陆通行证 |
| idCard | String | 否 | 证件号 |
| extAttributeJson | String | 否 | 扩展字段JSON,必须key:value结构,例如:{"name":"zhangsan","age":18} |
# 返回示例
success:
{
"code": "0",
"msg": "success",
"data": [
{
"account": "123",
"initiationStatus": "1",
"externalNo": "7ad23229753615609dcf0639c2f56fd2885acc15",
"username": "张三",
"enname": "zhangsan",
"mobile": "13587659870",
"email": "zhangsan@qq.com",
"sex": "1",
"birthday": "19920517",
"initiationAt": "20190918",
"entryAt": "20190918",
"isForeigner": "0",
"department": "123",
"position": "总经理",
"jobNumber": "T001",
"idType": "1",
"idCard": "310634199205171756",
"extAttributeJson":"{\"name\":\"zhangsan\",\"age\":18}"
},
{
"account": "124",
"initiationStatus": "1",
"externalNo": "7ad23229753615609dcf0639c2f56fd2885add8c",
"username": "李四",
"enname": "lisi",
"mobile": "13587659872",
"email": "lisi@qq.com",
"sex": "2",
"birthday": "19920617",
"initiationAt": "20180918",
"entryAt": "20180918",
"isForeigner": "0",
"department": "123",
"position": "总经理",
"jobNumber": "T002",
"idType": "1",
"idCard": "310634199206171767",
"extAttributeJson":"{\"name\":\"lisi\",\"age\":20}"
}
]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
fail:
{
"code": "10016",
"data": null,
"msg": "签名错误"
}
1
2
3
4
5
2
3
4
5