派獎紀錄列表.md
61 additions, 0 deletions
| ... | ... | @@ -28,3 +28,64 @@ |
| 28 | 28 | "x-request-id": "78f91284-d9df-43e6-a8d2-d557273c10bb" |
| 29 | + | |
| 30 | +#### QUERY STRING | |
| 31 | + | |
| 32 | +| Level | Name | Type/Len | Required(*) | Nullable(*) | Desc | | |
| 33 | +| ---| ---| ---| ---| ---| --- | | |
| 34 | +| 1 | page | Integer | | * | 頁籤 DEFAULT = 1 | | |
| 35 | +| 1 | per_page | Integer | | * | 筆數/頁 DEFAULT = 20 | | |
| 36 | +| 1 | award_record__trans_id | String | | | 交易代號 (AWARD_RECORD.TRANS_ID) | | |
| 37 | +| 1 | award_group__id | Integer | | | 獎項群 ID | | |
| 38 | +| 1 | award_group__name | String | | | 獎項群名稱 (模糊比對) | | |
| 39 | +| 1 | award__code | String | | | 獎項代號 | | |
| 40 | +| 1 | award__name | String | | | 獎項名稱 (模糊比對) | | |
| 41 | +| 1 | invite_code | String | | | 會員編號 | | |
| 42 | +| 1 | identity_id | String | | | 身份證字號 | | |
| 43 | +| 1 | award_record__claim_time_start | Datetime | | | 領獎開始時間 | | |
| 44 | +| 1 | award_record__claim_time_end | Datetime | | | 領獎結束時間 | | |
| 45 | +| 1 | award_record__status | String | | | 派獎狀態 (前端參考 「派獎狀態（對外顯示狀態）」傳入對應的狀態及結果？) | | |
| 46 | +| 1 | award_record__result | String | | | 派獎結果 (前端參考 「派獎狀態（對外顯示狀態）」傳入對應的狀態及結果？) | | |
| 47 | +| 1 | award_record__source | Enum | | | 派獎通路別：<br>(目前只有 WEBA)<br>WEBA - WEBA<br>MISSION_BOARD - 任務牆<br>PERSONAL_ACTIVITY - 個人化專屬活動 | | |
| 48 | +| 1 | award_record__channel_info | | | | 其他通路活動代號<br>(AWARD_RECORD.CHANNEL_INFO.KEY????) | | |
| 49 | + | |
| 50 | +### RESPONSE | |
| 51 | +#### STATUS CODE | |
| 52 | +* 200 | |
| 53 | + | |
| 54 | +#### BODY | |
| 55 | + | |
| 56 | +| Level | Name | Type/Len | Nullable(*) | Desc | | |
| 57 | +| ---| ---| ---| ---| --- | | |
| 58 | +| 1 | status | String | | 回應狀態 (SUCCESS, FAILURE) | | |
| 59 | +| 1 | data | Dict | | 通用資料包裝 | | |
| 60 | + | |
| 61 | +#### Data | |
| 62 | + | |
| 63 | +| Level | Name | Type/Len | Nullable(*) | Desc | | |
| 64 | +| ---| ---| ---| ---| --- | | |
| 65 | +| 2 | items | List | | 審核結果列表 | | |
| 66 | +| 2 | pagination | Dict | | 分頁資訊 | | |
| 67 | + | |
| 68 | +#### Items (List Item) | |
| 69 | + | |
| 70 | +| Level | Name | Type/Len | Nullable(*) | Desc | | |
| 71 | +| ---| ---| ---| ---| --- | | |
| 72 | +| 3 | id | Integer | | 審核 ID | | |
| 73 | +| 3 | feature | String | | 功能模組 | | |
| 74 | +| 3 | function | String | | 功能名稱 | | |
| 75 | +| 3 | progress | Enum | | 審核進度:<br>pending: 待審核<br>approved: 已通過<br>rejected: 已拒絕 | | |
| 76 | +| 3 | comment | String | * | 審核備註 | | |
| 77 | +| 3 | requester_id | Integer | | 申請人 ID | | |
| 78 | +| 3 | auditor_id | Integer | * | 審核人 ID | | |
| 79 | +| 3 | action | Enum | | 審核動作:<br>create: 新增<br>update: 更新<br>delete: 刪除 | | |
| 80 | +| 3 | create_time | Datetime | | 建立時間 | | |
| 81 | +| 3 | update_time | Datetime | | 更新時間 | | |
| 82 | +| 3 | requester | Dict | | 申請人資訊 | | |
| 83 | +| 3 | auditor | Dict | * | 審核人資訊 | | |
| 84 | +| 3 | data | Dict | | 派獎設定資料 | | |
| 85 | + | |
| 86 | +#### ERROR CODE | |
| 87 | + | |
| 88 | +| HTTP Status | ErrorCode | Message | Desc | | |
| 89 | +| ---| ---| ---| --- | |