1. 全量获取项目花名册人员列表
开放平台2.0-项目-全量获取项目花名册人员列表
注意
- 如果接口需要提供auth-token,你需要通过轻筑开放平台创建应用来获取appid和secret,然后通过appid和secret来获取接口访问凭证auth-token。
- 如果需要获取当前用户的使用信息,授权确保你能获取到qzcode,然后通过
网页授权
接口获取相关信息。
1.1. 基本信息
概况 | 内容 |
---|---|
接口地址 | /api/open/v2/labor/project/getRosterListByProject |
请求方法 | 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-是 |
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(有效期为 30 分钟) |
workingStatus | number | 是 | 在离岗状态 1-在岗,2-离岗 |
personType | string | 是 | 人员性质 10-管理人员,20-建筑工人 |
uuid | string | 是 | 人员id |
stayingDays | number | 是 | 在岗天数 |
identityNumber | string | 是 | 身份证号 |
nation | string | 是 | 民族 |
age | number | 是 | 年龄(取整) |
birthday | number | 是 | 生日(时间戳) |
trainResult | number | 是 | 0-未培训 1-合格 2-不合格 |
orgId | string | 是 | 组织机构id |
orgName | string | 是 | 组织机构名称 |
响应数据结构如下所示:
{
"code": 0,
"msg": "成功",
"data": {
"updateFlag": 1,
"lastUpdateTime": 1700181786737,
"rosterList": [
{
"birthday": 599846400000,
"stationCode": "107",
"attendanceCount": 0,
"workTypeName": "",
"nation": "满",
"avatar": "xxx",
"uuid": "816c6f0a1e5a4b7eb343691045b0b225",
"orgId": "adcdc7d214724b44a3799bcfa52f1ceb",
"orgName": "德富通XX控股有限公司/XX公司",
"stayingDays": 27,
"phone": "18604120514",
"identityNumber": "130321198901046932",
"workTypeCode": "",
"name": "张鹏",
"stationName": "工程总包方-项目经理",
"trainResult": 0,
"workingStatus": 1,
"personType": "10",
"age": 35
}
]
}
}
1.4. 错误码
当返回数据中的 code 不为 0 时,为错误返回。其中errCode为详细的错误码。