管理API对接文档（2024版）

最近更新时间：


用于修改滴滴ES后台人员信息

接口说明

注意
  • 常驻地目前只支持如“北京”、“北京市”、“北京市海淀区”格式，不支持“海淀区”此类格式，如果传参中带了区县则必须把“市”、“区“、”县”字段都带上。
  • 同一公司。连续添加员工，需要间隔 150ms


基本信息

HTTP URL

/river/Member/edit

HTTP Method

POST

权限要求


请求头

参数名称

参数值

Content-Type

application/json

请求参数

字段名

字段说明

字段类型

必填

备注

client_id

申请应用时分配的AppKey

string

Y


access_token

授权后的access token

string

Y


company_id

企业ID

string

Y


timestamp

当前时间戳(精确到秒级)

int

Y


sign

签名

string

Y


member_id

员工在滴滴企业的ID

bigint

N

member_id或employee_number不能同时为空。优先级member_id高于employee_number

employee_number

员工工号

string

N


has_card_info

是否含有证件信息

int

N

是否含有证件信息，当传证件信息时，此字符传1，其他情况不传或传0

data

员工信息

string

Y

详见 data


data

字段名

字段说明

字段类型

必填

备注

phone

员工手机号

string

N

员工手机号(手机号支持修改,修改后员工ID不变)；传空或不传不更新

realname

员工姓名

string

Y

员工姓名；传空或者不传不更新

employee_number

员工工号

string

N

员工工号；不传不更新；传空将工号置空

email

邮箱

string

N

员工邮箱；不传不更新；传空将邮箱置空

system_role

系统角色

int

N

枚举值数字 0 车辆预定人员，1 普通管理员，2 超级管理员

role_ids

角色

string

N

角色（默认为员工），通过角色获取API 。可以填多个，以_分隔。初始管理员、主管不支持新增
传空将员工置为员工角色

immediate_superior_phone

员工直属上级的手机号码

string

N

直属上级可在审批流中担任审批人 immediate_superior_phone与immediate_superior_eid以手机号优先，直属上级手机号；传空或不传不更新

immediate_superior_email

直属上级邮箱

string

N

直属上级邮箱

immediate_superior_employee_number

员工直属上级的员工编号

string

N

直属上级可在审批流中担任审批人

immediate_superior_memberID

直属上级 ID

int

N

直属上级 ID （直属上级 ID，直属上级手机号，直属上级工号，直属上级邮箱四选一即可）

clear_immediate_superior

清除上级

int

N

数字1 清除

residentsname

常驻地中文

string

N

常住地中文，不传不更新

use_company_money

是否企业支付余额

int

N

是否支持企业支付；0-不支持；1-支持；不传不更新

total_quota

每月配额

string

N

每月限额，单位元，支持小数；不传不更新，传空更新为不限

is_remark

叫车时备注信息是否必填

string

N

叫车时备注信息是否必填(0-选填，1-必填，2-按制度填写)；不传不更新

budget_center_id

所在部门ID

bigint

N

所在部门ID（新）,通过成本中心查询api获取ID（类型为1）,如需传参需填入部门ID；不传或传空不更新

out_budget_id

客户部门code

string

N


con_department_ids

所在兼岗部门ID

string

N

con_department_ids与con_department_codes都存在时，以con_department_ids为准 多个使用“_”连接

con_department_codes

所在兼岗部门CODE（同部门新增修改的out_budget_id）

string

N

con_department_ids与con_department_codes都存在时，以con_department_ids为准 多个使用“_”连接

regulation_id

用车制度ID数组

string

N

制度ID；通过制度列表接口查询；多个用 _ 连接；默认为空
若该员工的所有制度都是在es后台通过部门/职级/全员方式分配，则员工身上的制度字段不用传（传递也不影响，无法清空ES配置的全员制度）；同时注意检查use_company_money字段是否传输，制度和企业支付权限都有才能企业支付。传0，清空用户绑定的制度信息。

set_dismiss_time

设置的员工离职日期

string

N

设置员工离职日期，到期后自动加入已离职名单，不传或为空时认为不设置离职时间，
不传不更新；传空更新为空 格式为 yyyy-MM-dd，时间需要传入大于今天，隔天凌晨处理离职时间。

project_ids

所在项目ID

string

N

可以填多个，以_分隔。通过成本中心查询api获取id（类型为2）不传或传空不更新

project_codes_detail

项目信息

string

N

人员上绑定的项目信息
将project_codes_detail的值转为 json 字符
"project_codes_detail":"[{"project_name":"出差巡视","project_code":"travelcode" },{"project_name":"出差巡视","project_code":"travelcode" }] "
project_ids与project_code_detail同时有值时，以project_ids为准。

legal_entity_id

所在公司主体id

string

N

所在公司主体id，通过公司主体列表api可获取公司主体id
传空或不传不更新

out_legal_entity_id

外部所在公司主体id

string

N

外部所在公司主体id，传空或不传不更新

rank_id

职级id

string

N

职级id，通过职级列表api可获取职级id
不传或传空不更新

out_rank_id

外部职级 ID

string

N

外部职级 ID
同时存在 rank_id 和 out_rank_id 时，以 rank_id 为主

english_surname

英文姓

string

N

同lastname 不传不更新；传空更新为空

english_name

英文名

string

N

同firstname 有middlename时 english_name=firstname middlename 不传不更新；传空更新为空

nickname

昵称

string

N

不传不更新；传空更新为空

sex

性别

int

N

性别，0.不填 1.男 2. 女，默认为0
不传不更新

birth_date

出生日期

string

N

格式2000-01-01
注：
1、若采用AES256整体加密，此字段需明文传输，无需单独再加密
2、若不整体加密传输时，此字段只可采用AES128加密传输
3、若采用AES128整体加密，此字段仍需采用AES128单独加密（存在历史客户原因）

card_list

证件信息

[]object

N



证件信息

字段名

字段说明

字段类型

备注

card_type

证件类型

int

枚举值数字 1. 身份证，2. 护照，3. 港澳台居民居住证，4. 台胞证，5. 军官证，6. 回乡证，7. 外国人永久居留身份证

card_no

证件号码

string

证件号码
注：
1、若采用AES256整体加密，此字段需明文传输，无需单独再加密
2、若不整体加密传输时，此字段只可采用AES128加密传输
3、若采用AES128整体加密，此字段仍需采用AES128单独加密（存在历史客户原因）

expire_date

证件过期日期

string

格式：2050-01-01
注：
1、若采用AES256整体加密，此字段需明文传输，无需单独再加密
2、若不整体加密传输时，此字段只可采用AES128加密传输
3、若采用AES128整体加密，此字段仍需采用AES128单独加密（存在历史客户原因）

请求示例

curl --location 'https://api.es.xiaojukeji.com/river/Member/edit' \
--header 'Content-Type: application/json' \
--data '{"access_token":"1dd12f470485ba78b2c24fab3736e30c3c5ee9cc","client_id":"87fca1dc60c9de0a96c20fccf2ccaa40_test","client_secret":"481a0cd23c6d90dff1993982dc151601","company_id":"1125915646167936","data":"{\"role_ids\":\"\", \"employee_number\":\"123\",\"is_remark\":1,\"rank_id\":\"197213t912y3\"}","member_id":1125921312180375,"sign":"2e857c91066de9626a4fd5a039b45e46","timestamp":1690277479}'

响应参数

字段名

字段说明

字段类型

备注

errno

错误编码

string

数字 0 表示成功，非0 表示失败

errmsg

错误信息

string

errno=0时为常量"SUCCESS"，errno!=0时为错误信息




响应示例

正常示例

异常示例

错误码

通用错误解决方案

50221(member_id错误(该员工信息不存在))

  1. company_id没有对应的管理员，检查company_id填写正确，或者是否已被解散
  2. 需要编辑的员工为管理员

50222(员工与指定的企业不匹配)

  1. 员工是否已被删除
  2. 员工id和company_id是否在同一企业

50223(员工信息更新失败(xxxxx))

原因可能如下：

  1. 员工不存在(仔细检查member_id是否填写正确)
  2. 只有正常状态下的员工才可以被编辑(仔细检查员工是否已被删除)
  3. 手机号已存在(检查更新信息中的手机号是否其他员工手机号)
  4. 更新的离职时间需晚于今天

50224(员工存在未支付的订单,请先联系其支付)

  1. 如果员工手机号修改了，会先判断之前的手机号是否有未支付的订单

版本记录

日期

更新人

更新内容

上线时间

2023.11.07

陈继诗

迁移文档


2023.11.10

陈继诗

请求增加employee_number字段，data增加immediate_superior_employee_number字段,out_budget_id，project_codes_detail json串

2024.01.04

2024.02.21

陈继诗

去掉dismiss_time字段

2024.02.21

2024.08.10

陈继诗

新加字段 clear_immediate_superior

2024.08.10

2025.02.13

高洋洋

新增con_department_ids、out_con_department_codes兼岗字段

2025.02.13

2025.03.20

唐腾飞

返回新增out_legal_entity_id

2025.03.26

2025.03.24

高洋洋

增加证件、出生日期字段加密逻辑说明

2025.03.31