Skip to content

UPMS提供给第三方系统获取员工信息API

参数名 参数类型 是否必填 参数说明 示例
clientId String 是 喜茶分配给第三方的client Id exampleClientId
timestamp String 是 请求时间戳（东八区）用于做请求时效验证，单位：秒 1600412480
sign String 是 签名结果 dFCBnsgzv/2h...
payload Object 是 请求正文
--cursorId Long 否 查询的id (默认按id排序获取1000条数据,传具体id数据查询大于该id的数据) 1
--size integer 否 查询的条数(默认值1000,限制最大为1000) 1000
--source String 是 数据来源（E_ROAD->EHR系统，PRM->事业合伙人） E_ROAD
--selector List 否 查询字段集(id,userId,staffCode,outStaffCode,jobNumber,name,depts,positions,positionNames,phoneNumber,status)
--lastUpdatedTimeStart String 否 适用于增量更新场景的数据获取，每次从上一次的更新时间往后增量拉取数据。格式： yyyy-MM-dd HH:mm:ss 2023-10-10 00:00:00
--lastUpdatedTimeEnd String 否 根据修改时间筛选 end 格式： yyyy-MM-dd HH:mm:ss 2023-10-10 00:00:00
--userId Long 否 用户id 1
  • 请求示例
{
  "cursorId": 1,
  "size": 1000,
  "source": "E_ROAD",
  "selector": [
    "id",
    "staffCode", 
    "outStaffCode",
    "jobNumber",
    "name",
    "depts",
    "positions",
    "positionNames",
    "phoneNumber",
    "status"
  ]
}
  • 返回示例
{
"code": 0,
"message": "SUCCESS",
"requestId": null,
"data": [

            {

              "id": 123456,
              "staffCode": "ER_T123456",
              "outStaffCode":"T123456",
              "jobNumber": "T123456",
              "name": "张三",
              "depts": [
                "123"
                ,
                "234"
                ],
            "positions": [
                "1",
                "2"
                ],
            "positionNames":[
                "店员",
                "店长"
            ],
            "phoneNumber": "18812341234",
            "status": "ON_WORK",
            "source":"E_ROAD",
            "lastUpdatedTime":"2023-10-10 00:00:00",
            "jobType":"STORE"

        }
    ]
}
  • data的数据类型和字段说明参考
字段名 类型 描述 示例
id Long id 123456
staffCode String 员工编码 ER_T123456
outStaffCode String 源系统员工编码 T123456
jobNumber String 员工工号 T123456
name String 用户姓名 张三
depts List 用户所属组织 ["123","234"]
positions List 用户岗位 ["1","2"]
positionNames List 用户岗位名称 ["店员","店长"]
phoneNumber String 用户手机号码 18812341234
status String TERMINATION-离职；ON_WORK-在职 ON_WORK
source String 数据来源（E_ROAD->EHR系统，PRM->事业合伙人） E_ROAD
lastUpdatedTime String 最近更新的时间 2023-10-10 00:00:00
jobType String 员工职位类型 FUNCTIONAL职能员工 STORE直营门店员工 PRM_STORE 合伙人门店员工 STORE