Path: /api/punch/whole/detail
Method: GET
接口描述:
该接口用于admin 或 API 查询某次打卡互动的详细信息。仅返回已完成打卡的信息。
错误信息说明:
| 代码(code) | 消息(message) | 说明 |
| 10000000 | invalid params | 参数错误 |
| 10000004 | invalid thqs | THQS验证失败。 |
| 10000009 | json parse error | Json 解析异常 |
| 20070000 | mongodb error | mongodb 数据库异常 |
| 20070004 | punch not exists | 打卡互动不存在。 |
| 20070008 | punch not stop | 打卡互动未结束。 |
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| accountId | 是 | 账户 ID | |
| liveId | 是 | 直播 ID | |
| punchId | 是 | 打卡 ID |
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| success | boolean | 必须 | 接口处理结果。 | ||
| error | object | 非必须 | 失败时的错误信息,success=false时必须。 | ||
| ├─ code | integer | 必须 | 错误代码。 | ||
| ├─ message | string | 必须 | 错误描述。 | ||
| data | object | 非必须 | 成功时返回的数据,success=true时必须。 | ||
| ├─ punch | object | 必须 | 打卡信息。 | ||
| ├─ id | string | 必须 | 打卡ID。 | ||
| ├─ publisherId | string | 必须 | 发起者 ID。 | ||
| ├─ publisherName | string | 必须 | 发起者名称。 | ||
| ├─ createTime | string | 必须 | 打卡开始时间,格式yyyy-MM-dd HH:mm:ss。 | ||
| ├─ total | integer | 必须 | 应打卡人数。 | ||
| ├─ punched | integer | 必须 | 实际打卡人数。 | ||
| ├─ duration | integer | 必须 | 打卡持续时间,单位:秒。 无过期时间时,返回完成时间和开始时间的差。 若有过期时间,返回完成时间和开始时间的差和过期时间和开始时间的差之间较小的值。 | ||
| ├─ punchViewers | object [] | 必须 | 参与打卡学员列表,按分页返回。 | item 类型: object | |
| ├─ id | string | 必须 | 学员 ID。 | ||
| ├─ name | string | 必须 | 学员名称。 | ||
| ├─ createTime | string | 必须 | 参与打卡时间,格式yyyy-MM-dd HH:mm:ss。 | ||
| ├─ isPunched | boolean | 必须 | 是否打卡。 | ||
| ├─ punchTime | string | 非必须 | 打卡时间,格式yyyy-MM-dd HH:mm:ss。isPunched=true 时必须。 |