1. 获取花名册人员列表

开放平台2.0-项目-获取项目花名册人员列表

注意

  • 如果接口需要提供auth-token,你需要通过轻筑开放平台创建应用来获取appid和secret,然后通过appid和secret来获取接口访问凭证auth-token。
  • 如果需要获取当前用户的使用信息,授权确保你能获取到qzcode,然后通过网页授权接口获取相关信息。

1.1. 基本信息

概况 内容
接口地址 /api/open/v2/labor/device/rosterList
请求方法 POST
请求数据类型 JSON
响应数据类型 JSON

1.2. 请求数据

1.2.1. 请求头(request-header)

请求头除了默认的参数还需要添加如下请求头参数:

字段 描述
auth-token 接口访问凭据,你可以通过平台下发的appid和secret获取凭据
Content-Type application/json;charset=UTF-8

1.2.2. 请求体(request-body)

字段 类型 是否必填 描述
projectUuid string 项目id
lastUpdateTime number 上次更新时间戳,初次请求传0,后续每次请求使用上一次该接口返回的服务器更新时间戳
companyUuid string 公司id(组织机构接口中的orgId并且类型为公司)
workTypeCode string 工种code
workingStatus number 在离岗状态 0-全部,1-在岗,2-离岗
workTeamUuid string 班组id(组织机构接口中的orgId并且类型为班组)
incrementalFlag number 是否增量获取 0-否,1-是,若选择增量获取,则获取更新时间在lastUpdateTime之后的数据,否则获取全量人员数据。默认全量获取

1.3. 响应数据

响应数据中 code, msg, data 为默认字段,所有字段如下表所示:

字段 类型 是否必填 描述
code number 返回码
msg string 返回消息
data object 返回数据
    lastUpdateTime number 服务器更新时间戳,用于下一次请求
    updateFlag number 是否有更新:0 - 无更新;1 - 有更新
    rosterList array 人员列表(updateFlag = 1时有值)
        attendanceCount number 出勤天数
        workTypeName string 工种名称
        workTypeCode string 工种编码
        stationName string 岗位名称
        stationCode string 岗位编码
        name string 人员名字
        avatar string 人员头像url
        workingStatus number 在离岗状态 1-在岗,2-离岗
        personType string 人员性质 10-管理人员,20-建筑工人
        uuid string 人员id
        stayingDays number 在岗天数
        identityNumber string 身份证号
        nation string 民族
        age number 年龄(取整)
        birthday number 生日(时间戳)

响应数据结构如下所示:

{
  "code": 0,
  "msg": "成功",
  "data": {
    "updateFlag": 1,
    "lastUpdateTime": 1700181786737,
    "rosterList": [
      {
        "attendanceCount": 0,
        "workTypeName": "其它",
        "workTypeCode": "1000",
        "stationName": "项目经理",
        "stationCode": "1000",
        "name": "张三",
        "avatar": "xxxxxxxxxxxx",
        "workingStatus": 1,
            "personType": "10",
        "uuid": "xxxxxxxxxxxx",
        "stayingDays": 100,
            "identityNumber": "xxxxxxxxxxxx"
      }
    ]
  }
}

1.4. 错误码

当返回数据中的 code 不为 0 时,为错误返回。其中errCode为详细的错误码。

1.5. 逻辑图

逻辑图

© All Rights Reserved            updated 2024-09-06 08:41:46

results matching ""

    No results matching ""