8.3 员工勋章发放
# 8.3 员工勋章发放
# 接口URL
{开放平台域名地址}/openApi/open/medal/sendAsync 注:该接口为异步接口,需要调用8.4查询发放结果
# HTTP请求方式
POST
# 公共参数
| 字段 | 类型 | 是否必填 | 中文意描述 |
|---|---|---|---|
| appId | String | 是 | 由百福得向客户方发放 |
| timestamp | String | 是 | 毫秒级时间戳 防止重复攻击 |
| sign | String | 是 | 签名 |
| version | String | 否 | 业务接口版本号,如1.0.0 |
# body参数
| 字段 | 类型 | 是否必填 | 中文意描述 |
|---|---|---|---|
| businessNo | String | 是 | 发放批次的业务单号,后台导出会体现该单号 |
| giveReason | String | 否 | 颁发理由 |
| pageNo | Integer | 是 | 请求页数(分页传输第一页传1,后续不能跳页) |
| planBatchNo | String | 是 | 批次号做幂等校验,分页传输应为同一个批次号,可与businessNo一致 |
| sendUserAccounts | List<String> | 是 | 发放员工账号集合 |
| status | Integer | 是 | 0待传输,1待处理(最后一页传1,其他页传0) |
| sendPlanRewards | List<SendPlanRewardDTO> | 是 | 勋章Id集合(来自于8.1接口返回) |
# SendPlanRewardDTO:
| 字段 | 类型 | 是否必填 | 中文意描述 |
|---|---|---|---|
| rewardTargetId | Long | 是 | 勋章id |
# 请求示例
POST /openApi/open/medal/sendAsync?appId=abc×tamp=1597300776947&sign=fa66cb4d8604413b8fb30afd32e3e73e HTTP/1.1 Content-Type: application/json Cache-Control: no-cache { "businessNo": "67890324564", "giveReason": "", "pageNo": 1, "planBatchNo": "67890324564", "sendUserAccounts": ["zhangsan"], "status": 0, "sendPlanRewards": [ { "rewardTargetId": 1234 } ] }1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
# 返回参数说明
| 字段 | 类型 | 是否必填 | 中文意描述 |
|---|---|---|---|
| code | String | 返回码 | |
| msg | String | 否 | 如果错误,返回错误信息 |
# 返回示例
success:
{
"code": "0",
"msg": "success"
}
1
2
3
4
2
3
4
fail:
{
"code": "10016",
"msg": "签名错误"
}
1
2
3
4
2
3
4