列表

优质

小牛编辑

133浏览

2023-12-01

请求地址

https://api.es.xiaojukeji.com/river/Member/get

返回数据格式

JSON

请求方式

GET

是否需要登录

是关于登录授权，参见如何登录授权

访问授权限制

暂无

请求参数

名称	类型	必选	描述
client_id	string	yes	申请应用时分配的AppKey
access_token	string	yes	授权后的access token
timestamp	int	yes	当前时间戳，精确到秒级
company_id	bigint	yes	企业ID
email	string	no	员工邮箱
employee_number	string	no	员工号
phone	string	no	员工手机号
realname	string	no	员工姓名
status	string	no	员工状态(仅支持1-正常、4-离职、6-未绑定手机号，查询多种状态时以英文逗号分隔，如"1,4"，默认为"1,4,6")
offset	int	yes	数据开始位置
length	int	yes	数据条数（最大100条）
sign	string	yes	签名

注意事项

员工工号、手机号是精确查询，名字为模糊查询
offset必须可以被length整除，如offset=0,length=100,0可以被100整除，合法；offset=1,length=100,1不能被100整除，不合法

请求示例

curl -X GET -H "Content-Type: application/x-www-form-urlencoded" https://api.es.xiaojukeji.com/river/Member/get?client_id=client_id_test&access_token=141ea31466478eab2f1c1ddcca2675b989a16552&timestamp=1566764837&company_id=12345678980&offset=0&length=10&sign=091cf244ad5ab16935cfe44fc698bc58

返回参数说明

返回值字段	字段类型	字段说明
errno	string	0表示成功，非0表示失败
errmsg	string	errno=0时为常量"SUCCESS"，errno!=0时为错误信息
data	object	员工列表信息

data数据格式

返回值字段	字段类型	字段说明
total	int	此次查询符合条件的员工总数
records	array	员工集合

records数组元素格式

返回值字段	字段类型	字段说明
id	bigint	员工在滴滴企业平台的ID
phone	string	员工手机号
realname	string	员工姓名
employee_number	string	员工ID（员工在公司的员工号）
email	string	邮箱
department	string	部门名称（老），后续此参数会去掉
branch_name	string	所在分公司名称（老），后续此参数会去掉
system_role	int	系统角色(0-车辆预定人员，1-普通管理员，2-超级管理员)
role_ids	string	角色，通过角色获取API
mmediate_superior_phone	string	员工直属上级的手机号码，直属上级可在审批流中担任审批人
residentsname	string	常驻地中文
use_company_money	int	是否企业支付余额（0-否，1-是）
total_quota	string	每月配额
is_remark	int	叫车时备注信息是否必填(0-选填，1-必填，2-按制度填写)
budget_center_id	bigint	所在部门ID（新）
use_car_config	array	用车规则ID数组
regulation_id	array	用车制度ID数组。跟新增、修改、详情等API统一
set_dismiss_time	string	设置的员工离职日期，为空时表示未设置离职日期，格式为 "2018-07-01”
dismiss_time	string	员工实际离职日期,为空时表示未离职,格式为 "2018-07-01 13:24:54"
invoice_info	string	开票主体信息

返回示例

{
    "errno":0,
    "errmsg":"success",
    "data":{
        "total":5,
        "records":[
            {
                "id":"4596091316915930912",
                "phone":"13178080118",
                "realname":"王五",
                "employee_number":"DD99999",
                "email":"wangwu@didichuxing.com",
                "department":"QA",
                "branch_name":"",
                "system_role":2,
                "residentsname":"",
                "total_quota":"1000.00",
                "use_company_money":1,
                "is_remark":0,
                "budget_center_id":"0",
                "use_car_config":[
                    "5489709520894035023",
                    "5489198484344538189"
                ],
                "set_dismiss_time":"2018-07-01",
                "dismiss_time":"2018-07-01 13:24:54"
            }
        ]
    }
}

接口错误解决方案

通用错误解决文档

4xx 错误
1xxx 错误

10003(offset或length不合法)

offset必须为length的整数倍

offset较大未获取到数据

如果贵企业员工数量较多，查询是offset较大，比如10w，需使用last_id查询