当前位置: API文档

setting.Employee.search(员工查询)

¥标准

1.接口说明

1.1 接口描述:获取ERP的员工页面信息
1.2 适用版本:客户端 V1.3.6.3及以上版本
1.3 增量获取:支持
1.4 时间跨度:
1.5注意事项:

2.调用场景

2.1 举例说明:自研商城、SCMSRM、财务系统、SAP等系统的对接

3.请求参数说明

   3.1 请求地址

环境HTTP地址
测试环境http://47.92.239.46/openapi
正式环境http://wdt.wangdian.cn/openapi

  3.2 公共请求参数

名称字段类型长度
必须描述
卖家账号sidString
卖家账号, 由旺店通分配
接口账号keyString
由旺店通分配appkey, 在发送的数据中对应 key 字段,获取方式点击这里
saltString
由旺店通分配appsecret,是由两部分构成, 冒号前面的部分是secret, 冒号后面的部分是salt. 例如一个appsecret是testsecret:testsalt, 那么secret为testsecret, salt为testsalt.
接口名称methodString
调用的接口名称
版本号vString
1.0
秒级时间戳timestampint
秒级时间戳, 当前时间戳减去 2012-01-01 00:00:00(1325347200), 时间与服务器时间差120s内即合法。
签名signString
签名
分页大小page_sizeint
分页大小,分页查询必传
分页编号page_noint
分页编号,分页查询必传,标准接口page_no从0开始
是否计算查询结果的总条数calc_totalint
是否计算查询结果的总条数, 需要计算则1, 否则填0         

   3.3 业务请求参数

名称字段类型长度
必须描述

查询参数

params

Map<String, Object>


查询参数

分页

pagerPager
分页

params

名称字段类型长度
必须描述

开始时间

start_time

date


开始修改时间

结束时间

end_time

date


结束修改时间

员工编号

employee_no

String


员工编号

pager

名称字段类型长度
必须描述
分页大小page_sizeInt4分页大小
页号page_noInt4

从0开始

4.响应参数

名称字段类型长度
必须描述
状态码statusInt

状态码,0表示正常

错误信息messageString

无错误信息不返回

员工数据data

Map<String, Object>


员工相关数据

data

响应参数说明示例值或者格式、具体含义、使用方法及注意事项(如隐私数据淘系平台不返回,其他平台正常返回

名称字段类型长度
必须描述

单据数据

order_list

List<Map<String, Object>>


员工数据

总数

total_count

Int

11

查询条件总单据数

order_list

名称字段类型长度
必须描述
员工id

employee_id

Int11员工id
员工编号employee_noString
员工编号
姓名nameString
姓名
昵称shortnameString
昵称
性别genderInt4

性别:

1:男  2:女

职位position_nameString

职位

部门department_name String

部门

工种roles_maskInt11

工种:

1 业务员 2审单员 4打单员 8验货员 16打包员 32拣货员 64发货员 128结算员 512采购员 1024质检员 2048生产员


(注意:如果是3,则表示该员工有业务员和审单员的工种“1+2”,如果是15,则表示该员工有业务员审单员打单员验货员四个工种“1+2+4+8”,其他数字以此类推)

备注remarkString

备注

内置员工is_system_userboolean1

是否是系统内置员工

是否停用is_disabledboolean
true: 停用
删除状态deletedint1不为0则表示已经删除

5.请求示例

json格式请求报文
[{"start_time":"2021-12-01 00:00:00","end_time":"2021-12-12 12:00:00"}]
PHP
<?php
header("Content-Type: text/html; charset=UTF-8");
date_default_timezone_set("Asia/Shanghai");
require_once('wdtsdk.php');
  
$client = new WdtErpClient("url", "wdtapi3", "appkey", "secret");
  
$parMap = new stdClass();
$parMap->start_time = "2021-12-01 00:00:00";
$parMap->end_time = "2021-12-12 00:00:00";

  
  
$pager = new Pager(1, 0, true);
$data = $client->pageCall("setting.Employee.search", $pager, $parMap);
  
?>
JAVA
C#

6.响应示

   6.1 正常响应示例 

JSON
{
    "status": 0,
    "data": {
        "total_count": 14,
        "order_list": [
            {
                "roles_mask": 0,
                "gender": 0,
                "is_system_user": false,
                "employee_id": 374,
                "name": "",
                "position_name": "慧策技术支持",
                "employee_no": "lxxx-test2",
                "remark": "开放接口",
                "shortname": "lxxxx-test2"
            }
        ]
    }
}

   6.2 异常响应示例

JSON
{
    "status": 100,
    "message": "超过每分钟最大调用频率限制,请稍后重试"
}





常用工具