派獎紀錄匯出.md
44 additions, 4 deletions
| ... | ... | @@ -1,13 +1,17 @@ |
| 1 | +下載派獎紀錄匯出 Excel | |
| 2 | +* `AWARD` | |
| 3 | +* `AWARD_GROUP` | |
| 4 | +* `AWARD_RECORD` | |
| 1 | - * PATH: `/api/features/` | |
| 5 | + * PATH: `/api/features/award/records/export-excel` | |
| 2 | 6 | * LOGIN REQUIRED: **TRUE** |
| 3 | - * FEATURE: | |
| 4 | - * PERMISSION: | |
| 7 | + * FEATURE: AWARD_RECORD | |
| 8 | + * PERMISSION: READ | |
| 5 | 9 | * CRYPTO: **None** |
| 6 | - ```auto | |
| 10 | + ```json | |
| 7 | 11 | "Content-Type": "application/json", |
| 8 | 12 | "x-request-id": "78f91284-d9df-43e6-a8d2-d557273c10bb" |
| 13 | + | |
| 14 | +#### QUERY STRING | |
| 15 | + | |
| 16 | +| Level | Name | Type/Len | Required(*) | Nullable(*) | Desc | | |
| 17 | +| ---| ---| ---| ---| ---| --- | | |
| 18 | +| 1 | award__code | String | | | 獎項代號 | | |
| 19 | +| 1 | award__name | String | | | 獎項名稱 (模糊比對) | | |
| 20 | +| 1 | award__group_id | Integer | | | 獎項群 ID | | |
| 21 | +| 1 | award_group__name | String | | | 獎項群名稱 (模糊比對) | | |
| 22 | +| 1 | invite_code | String | | | 會員編號 | | |
| 23 | +| 1 | award_record__trans_id | String | | | 交易代號 (AWARD_RECORD.TRANS_ID) | | |
| 24 | +| 1 | award_record__user_id | String | | | 身份證字號 | | |
| 25 | +| 1 | award_record__claim_time_start | Datetime | | | 領獎開始時間 | | |
| 26 | +| 1 | award_record__claim_time_end | Datetime | | | 領獎結束時間 | | |
| 27 | +| 1 | award_record__status | String | | | 派獎狀態<br>(前端參考 「派獎狀態（對外顯示狀態）」傳入對應的狀態及結果？)<br>PENDING：待派獎<br>PROGRESS：處理中<br>DONE：完成, ERROR_PROGRESS：異常處理中 | | |
| 28 | +| 1 | award_record__result | String | | | 派獎結果 (前端參考 「派獎狀態（對外顯示狀態）」傳入對應的狀態及結果？)<br>SUCCESS：成功<br>CHECK：確認中<br>FAIL：失敗 | | |
| 29 | +| 1 | award_record__channel_source | Enum | | | 派獎通路別<br>(目前只有 WEBA)<br>WEBA：WEBA<br>MISSION_BOARD：任務牆<br>PERSONAL_ACTIVITY：個人化專屬活動 | | |
| 30 | +| 1 | award_record__other_code | String | | | 其他通路活動代號(AWARD_RECORD.CHANNEL_INFO.otherCode) | | |
| 31 | + | |
| 32 | +### RESPONSE | |
| 33 | +#### STATUS CODE | |
| 34 | +* 201 | |
| 35 | + | |
| 36 | +#### BODY | |
| 37 | + | |
| 38 | +| Level | Name | Type/Len | Nullable(*) | Desc | | |
| 39 | +| ---| ---| ---| ---| --- | | |
| 40 | +| 1 | status | String | | 回應狀態 (SUCCESS, FAILURE) | | |
| 41 | +| 1 | data | Dict | | 通用資料包裝 | | |
| 42 | + | |
| 43 | +#### Data | |
| 44 | + | |
| 45 | +#### ERROR CODE | |
| 46 | + | |
| 47 | +| HTTP Status | ErrorCode | Message | Desc | | |
| 48 | +| ---| ---| ---| --- | |