批次補派獎異常紀錄列表.md
10 additions, 92 deletions
| ... | ... | @@ -9,9 +9,9 @@ |
| 9 | - * PATH: `/api/features/award/record` | |
| 9 | + * PATH: `/api/features/award/record/compensate/batch` | |
| 10 | 10 | * LOGIN REQUIRED: **TRUE** |
| 11 | - * FEATURE: AWARD_RECORD | |
| 11 | + * FEATURE: AWARD_COMPENSATE | |
| 12 | 12 | * PERMISSION: READ |
| 13 | 13 | * CRYPTO: **None** |
| 14 | -| 1 | invite_code | String | | | 會員編號 | | |
| 15 | -| 1 | award_record__trans_id | String | | | 交易代號 (AWARD_RECORD.TRANS_ID) | | |
| 16 | -| 1 | award_record__user_id | String | | | 身份證字號 | | |
| 17 | -| 1 | award_record__claim_time_start | Datetime | | | 領獎開始時間 | | |
| 18 | -| 1 | award_record__claim_time_end | Datetime | | | 領獎結束時間 | | |
| 19 | -| 1 | award_record__status | String | | | 派獎狀態<br>(前端參考 「派獎狀態（對外顯示狀態）」傳入對應的狀態及結果？)<br>PENDING：待派獎<br>PROGRESS：處理中<br>DONE：完成, ERROR_PROGRESS：異常處理中 | | |
| 20 | -| 1 | award_record__result | String | | | 派獎結果 (前端參考 「派獎狀態（對外顯示狀態）」傳入對應的狀態及結果？)<br>SUCCESS：成功<br>CHECK：確認中<br>FAIL：失敗 | | |
| 21 | -| 1 | award_record__channel_source | Enum | | | 派獎通路別<br>(目前只有 WEBA)<br>WEBA：WEBA<br>MISSION_BOARD：任務牆<br>PERSONAL_ACTIVITY：個人化專屬活動 | | |
| 22 | - | 1 | award_record__other_code | String | | | 其他通路活動代號(AWARD_RECORD.CHANNEL_INFO.otherCode) | | |
| 14 | + | 1 | award__type | Enum | | | 獎項類型<br>ORCA_POINT:小樹點生活QWARE: 安源SELFGEN_VOUCHER: 自建EDENRED: 宜睿<br>SYSTEX: 精誠 | | |
| 23 | -| 3 | id | Integer | | 派獎紀錄序號 | | |
| 24 | -| 3 | trans_id | String | | 交易代號 (可為神枋 ORDER_ID) | | |
| 25 | -| 3 | award_id | Integer | | 獎項序號 | | |
| 26 | -| 3 | user_id | String | | 身份證字號 | | |
| 27 | -| 3 | deliver_amount | Integer | | 派送數量 | | |
| 28 | -| 3 | status | Enum | | 執行狀態<br>PENDING：待派獎PROGRESS：處理中DONE：完成, ERROR_PROGRESS：異常處理中 | | |
| 29 | -| 3 | result | Enum | * | 執行結果<br>SUCCESS：成功CHECK：確認中FAIL：失敗 | | |
| 30 | -| 3 | channel_source | Enum | | 派獎來源通路<br>WEBA：WEBA<br>MISSION_BOARD：任務牆<br>PERSONAL_ACTIVITY：個人化專屬活動 | | |
| 31 | -| 3 | push_batch_id | String | * | 推播 BATCH ID | | |
| 32 | -| 3 | claim_time | Datetime | * | 領獎時間 | | |
| 33 | -| 3 | issue_time | Datetime | * | 派獎成功時間 | | |
| 34 | -| 3 | create_time | Datetime | | 建立時間 | | |
| 35 | -| 3 | invite_code | String | * | 會員編號 | | |
| 36 | -| 3 | update_time | Datetime | * | 更新時間 | | |
| 37 | -| 3 | award_info | Dict | | 不同類型獎項的附加資訊 | | |
| 38 | -| 3 | channel_info | Dict | * | 派獎來源通路的附加資訊 | | |
| 39 | -| 3 | award | Dict | | 獎項資料 | | |
| 40 | -| 3 | award_group | Dict | | 獎項群資料 | | |
| 41 | -| 3 | logs | List[Dict] | * | 派獎紀錄 log | | |
| 42 | - | |
| 43 | -### award_record.award_info | |
| 44 | - | |
| 45 | -| Level | Name | Type/Len | Nullable(*) | Desc | | |
| 46 | -| ---| ---| ---| ---| --- | | |
| 47 | -| 4 | otherCode | String | * | 其他通路活動代號 | | |
| 48 | -| 4 | memo | String | * | 備註 | | |
| 49 | - | |
| 50 | -### award_record.channel_info | |
| 51 | - | |
| 52 | -| Level | Name | Type/Len | Nullable(*) | Desc | | |
| 53 | -| ---| ---| ---| ---| --- | | |
| 54 | -| 4 | gp_identity_id | String | * | 小樹會員 ID | | |
| 55 | - | |
| 56 | -### award_record.award | |
| 57 | - | |
| 58 | -| Level | Name | Type/Len | Nullable(*) | Desc | | |
| 59 | -| ---| ---| ---| ---| --- | | |
| 60 | -| 4 | id | Integer | | 獎項序號 | | |
| 61 | -| 4 | code | String | | 獎項代號 | | |
| 62 | -| 4 | name | String | | 獎項名稱 | | |
| 63 | -| 4 | group_id | Integer | | 獎項群序號 | | |
| 64 | -| 4 | active_status | Enum | | 獎項狀態<br>ACTIVE：啟用<br>INACTIVE：停用 | | |
| 65 | -| 4 | process_status | Enum | | 執行狀態<br>AVALABLE：可用<br>FULL：已額滿<br>EXECUTED：排程已執行 | | |
| 66 | -| 4 | award_type | Enum | | 獎項類型<br>ORCA_POINT：小樹點生活<br>QWARE：安源<br>SELFGEN_VOUCHER：自建<br>EDENRED：宜睿 SYSTEX：精誠 | | |
| 67 | -| 4 | deliver_type | Enum | | 發送類型<br>IMMEDIATE：立即<br>ETA：指定時間 | | |
| 68 | -| 4 | deliver_amount | Integer | | 發送數量 (每次) | | |
| 69 | -| 4 | deliver_limit | Integer | | 發送次數上限 | | |
| 70 | -| 4 | deliver_time | Datetime | * | 發送時間 | | |
| 71 | -| 4 | create_time | Datetime | | 建立時間 | | |
| 72 | -| 4 | update_time | Datetime | * | 更新時間 | | |
| 73 | - | |
| 74 | -### award_record.group | |
| 75 | - | |
| 76 | -| Level | Name | Type/Len | Nullable(*) | Desc | | |
| 77 | -| ---| ---| ---| ---| --- | | |
| 78 | -| 4 | id | Integer | | 獎項群序號 | | |
| 79 | -| 4 | name | String | | 獎項群名稱 | | |
| 80 | -| 4 | status | Enum | | 獎項群狀態, ACTIVE:上架, INACTIVE: 下架, RETIRED: 永久下架 | | |
| 81 | -| 4 | start_time | Datetime | | 獎項群開始時間 | | |
| 82 | -| 4 | end_time | Datetime | | 獎項群結束時間 | | |
| 83 | -| 4 | create_time | Datetime | | 建立時間 | | |
| 84 | -| 4 | update_time | Datetime | | 更新時間 | | |
| 85 | - | |
| 86 | -### award_record.log | |
| 87 | - | |
| 88 | -| Level | Name | Type/Len | Nullable(*) | Desc | | |
| 89 | -| ---| ---| ---| ---| --- | | |
| 90 | -| 4 | id | Integer | | 派獎紀錄 log 序號 | | |
| 91 | -| 4 | request_id | String | * | REQUEST_ID (可為神枋 REQUEST_ID) | | |
| 92 | -| 4 | record_id | Integer | | AWARD_RECORD.ID | | |
| 93 | -| 4 | info | Dict | * | 不同獎項類型的附加資訊 | | |
| 94 | -| 4 | result | Enum | | 本次執行結果<br>SUCCESS：成功<br>CHECK：確認中<br>FAIL：失敗 | | |
| 95 | -| 4 | error_msg | String | * | 失敗原因 | | |
| 96 | -| 4 | creator | String | | 建立者<br>WEBA：WEBA<br>MISSION_BOARD：任務牆<br>PERSONAL_ACTIVITY：個人化專屬活動<br>CMS：CMS 錯誤處理<br>SYSTEM：B2E 排程 | | |
| 97 | -| 4 | create_time | Datetime | | 建立時間 | | |
| 98 | - | |
| 99 | -### award_record.award_record_log.info | |
| 100 | - | |
| 101 | -| Level | Name | Type/Len | Nullable(*) | Desc | | |
| 102 | -| ---| ---| ---| ---| --- | | |
| 103 | - | 5 | gp_identity_id | String | * | 小樹會員 ID | | |
| 15 | + | 3 | id | Integer | | 獎項 ID | | |
| 16 | +| 3 | group_id | Integer | | 獎項群 ID | | |
| 17 | +| 3 | group_name | String | | 獎項群名稱 | | |
| 18 | +| 3 | award_code | String | | 獎項代號 | | |
| 19 | +| 3 | award_name | String | | 獎項名稱 | | |
| 20 | +| 3 | award_type | Enum | | 獎項類型<br>ORCA_POINT:小樹點生活QWARE: 安源SELFGEN_VOUCHER: 自建EDENRED: 宜睿SYSTEX: 精誠 | | |
| 21 | +| 3 | failure_count | Integer | | 失敗筆數 | |