Cube Rewards Tool
#309ff
Back

前往 ClickUp
2025/12/11
6 min read

派獎 - 正式列表

派獎 - 正式列表.md
186 additions, 0 deletions
... ... @@ -1 +1,187 @@
1 +### SUMMARY
2 +取得派獎設定列表，包含派獎群組及其關聯的獎項、小樹點設定、推播通知設定。
3 +### REFERENCE TABLE
4 +* `DBMT.AWARD_GROUP`
5 +* `DBMT.AWARD`
6 +* `DBMT.AWARD_GP`
7 +* `DBMT.PUSHNOTIFY_RELATION`
8 +* `DBMT.PUSHNOTIFY_NOTIFICATION_ENTRY`
9 +* `DBMT.PUSHNOTIFY_MESSAGE_ENTRY`
10 +
11 +### ATTRIBUTES
12 +* METHOD: **GET**
13 +* PATH: `/api/features/award/groups`
14 +* LOGIN REQUIRED: **TRUE**
15 +* FEATURE: `AWARD_GROUP`
16 +* PERMISSION: `READ`
17 +* CRYPTO: **None**
18 +
19 +### REQUEST
20 +#### HEADERS
21 +
22 +| Name | Type/Len | Required(*) | Desc |
23 +| ---| ---| ---| --- |
24 +| Content-Type | String | * | `"application/json"` |
25 +| Authorization | String | * | JWT Token |
26 +| X-Request-Id | String | | X-Request-Id for api flow tracing |
27 +
28 +```json
29 +// Example:
30 +{
31 + "Content-Type": "application/json",
32 + "Authorization": "Bearer jwt-token",
33 + "x-request-id": "78f91284-d9df-43e6-a8d2-d557273c10bb"
34 +}
35 +```
36 +
37 +#### QUERY STRING
38 +
39 +| Level | Name | Type/Len | Required(*) | Nullable(*) | Desc |
40 +| ---| ---| ---| ---| ---| --- |
41 +| 1 | page | Integer | | * | 頁籤 DEFAULT = 1 |
42 +| 1 | per_page | Integer | | * | 筆數/頁 DEFAULT = 20 |
43 +| 1 | award_group__id | Integer | | | 派獎群組 ID |
44 +| 1 | award_group__name | String | | | 派獎群組名稱 |
45 +| 1 | award_group__start_time | Datetime | | | 派獎開始時間 |
46 +| 1 | award_group__end_time | Datetime | | | 派獎結束時間 |
47 +| 1 | award_group__time_state | Enum | | | 時間狀態:<br>PENDING: 尚未開始<br>PROGRESS: 進行中<br>FINISHED: 已結束 |
48 +| 1 | award_group__status | List(Enum) | | | 派獎群組狀態:<br>ACTIVE: 上架<br>INACTIVE: 下架<br>RETIRED: 永久下架 |
49 +| 1 | award_gp__action_code | String | | | 小樹點行動代碼 |
50 +
51 +```cpp
52 +// Example
53 +/api/features/award/groups?page=1&per_page=20&award_group__name=星巴克活動
54 +```
55 +
56 +### RESPONSE
57 +#### STATUS CODE
58 +* 200
59 +
60 +#### HEADERS
61 +
62 +| Name | Type/Len | Desc |
63 +| ---| ---| --- |
64 +| Authorization | String | JWT Token |
65 +| X-Request-Id | String | Returning Request-Id |
66 +
67 +```json
68 +// Example:
69 +{
70 + "Authorization": "Bearer jwt-token",
71 + "x-request-id": "78f91284-d9df-43e6-a8d2-d557273c10bb"
72 +}
73 +```
74 +
75 +#### BODY
76 +
77 +| Level | Name | Type/Len | Nullable(*) | Desc |
78 +| ---| ---| ---| ---| --- |
79 +| 1 | status | String | | 回應狀態 (SUCCESS, FAILURE) |
80 +| 1 | data | Dict | | 通用資料包裝 |
81 +
82 +#### Data
83 +
84 +| Level | Name | Type/Len | Nullable(*) | Desc |
85 +| ---| ---| ---| ---| --- |
86 +| 2 | items | List | | 結果列表 |
87 +| 2 | pagination | Dict | | 分頁資訊 |
88 +
89 +#### Items
90 +
91 +| Level | Name | Type/Len | Nullable(*) | Desc |
92 +| ---| ---| ---| ---| --- |
93 +| 3 | award_group | Dict | | 派獎群組資訊 |
94 +| 3 | awards | List(Dict) | | 獎項設定列表 |
95 +
96 +#### award_group
97 +
98 +| Level | Name | Type/Len | Nullable(*) | Desc |
99 +| ---| ---| ---| ---| --- |
100 +| 4 | id | Integer | | 派獎群組 PK |
101 +| 4 | name | String | | 派獎群組名稱 |
102 +| 4 | status | Enum | | 狀態:<br>ACTIVE: 上架<br>INACTIVE: 下架<br>RETIRED: 永久下架 |
103 +| 4 | time_state | Enum | | 時間狀態:<br>PENDING: 尚未開始<br>PROGRESS: 進行中<br>FINISHED: 已結束 |
104 +| 4 | start_time | Datetime | | 派獎開始時間 |
105 +| 4 | end_time | Datetime | | 派獎結束時間 |
106 +| 4 | create_time | Datetime | | 建立時間 |
107 +| 4 | update_time | Datetime | | 更新時間 |
108 +
109 +#### awards (List Item)
110 +
111 +| Level | Name | Type/Len | Nullable(*) | Desc |
112 +| ---| ---| ---| ---| --- |
113 +| 4 | award | Dict | | 獎項資訊 |
114 +| 4 | prize_gp | Dict | | 小樹點獎項資訊 |
115 +| 4 | notify | Dict | * | 推播通知資訊 |
116 +
117 +#### award
118 +
119 +| Level | Name | Type/Len | Nullable(*) | Desc |
120 +| ---| ---| ---| ---| --- |
121 +| 5 | id | Integer | | 獎項 PK |
122 +| 5 | code | String | | 獎項代碼 |
123 +| 5 | name | String | | 獎項名稱 |
124 +| 5 | group_id | Integer | | 所屬派獎群組 ID |
125 +| 5 | active_status | Enum | | 啟用狀態:<br>ACTIVE: 啟用<br>INACTIVE: 停用 |
126 +| 5 | process_status | Enum | | 處理狀態:<br>AVAILABLE: 可用<br>FULL: 已額滿<br>EXECUTED: 已執行 |
127 +| 5 | award_type | Enum | | 獎項類型:<br>ORCA_POINT: 小樹點<br>QWARE: Qware 點數<br>SELFGEN_VOUCHER: 自建票券<br>EDENRED: Edenred<br>SYSTEX: Systex |
128 +| 5 | deliver_type | Enum | | 發放類型:<br>IMMEDIATE: 立即發放<br>ETA: 預定時間發放 |
129 +| 5 | deliver_amount | Integer | | 發放數量 |
130 +| 5 | deliver_limit | Integer | | 發放上限 |
131 +| 5 | deliver_time | Datetime | * | 預定發放時間 (ETA 時需要) |
132 +| 5 | create_time | Datetime | | 建立時間 |
133 +| 5 | update_time | Datetime | | 更新時間 |
134 +
135 +#### prize_gp
136 +
137 +| Level | Name | Type/Len | Nullable(*) | Desc |
138 +| ---| ---| ---| ---| --- |
139 +| 5 | id | Integer | | 小樹點獎項 PK |
140 +| 5 | award_id | Integer | | 關聯獎項 ID |
141 +| 5 | action_code | String | | 行動代碼 |
142 +| 5 | expire_duration | Integer | | 過期天數 (1-1095) |
143 +| 5 | note | String | * | 備註 |
144 +| 5 | create_time | Datetime | | 建立時間 |
145 +| 5 | update_time | Datetime | | 更新時間 |
146 +
147 +#### notify
148 +
149 +| Level | Name | Type/Len | Nullable(*) | Desc |
150 +| ---| ---| ---| ---| --- |
151 +| 5 | id | Integer | | 推播關聯 PK |
152 +| 5 | relation_table | Enum | | 關聯表:<br>AWARD: 獎項<br>ASSIGNED_COUPON: 塞券 |
153 +| 5 | relation_id | Integer | | 關聯 ID |
154 +| 5 | notification | Dict | * | 外部推播設定 |
155 +| 5 | message | Dict | * | 訊息夾設定 |
156 +
157 +#### notification
158 +
159 +| Level | Name | Type/Len | Nullable(*) | Desc |
160 +| ---| ---| ---| ---| --- |
161 +| 6 | id | Integer | | 推播 PK |
162 +| 6 | pushnotify_relation_id | Integer | | 關聯 PUSHNOTIFY_RELATION.ID |
163 +| 6 | title | String | * | 推播標題 |
164 +| 6 | content | String | * | 推播內文 |
165 +| 6 | notification_behavior | Enum | * | 推播點擊行為:<br>OPEN_URL: 開啟連結<br>OPEN_INBOX: 開啟訊息夾 |
166 +| 6 | url | String | * | DeepLink 網址 |
167 +| 6 | create_time | Datetime | | 建立時間 |
168 +| 6 | update_time | Datetime | | 更新時間 |
169 +
170 +#### message
171 +
172 +| Level | Name | Type/Len | Nullable(*) | Desc |
173 +| ---| ---| ---| ---| --- |
174 +| 6 | id | Integer | | 訊息夾 PK |
175 +| 6 | pushnotify_relation_id | Integer | | 關聯 PUSHNOTIFY_RELATION.ID |
176 +| 6 | title | String | * | 訊息夾標題 |
177 +| 6 | content | String | * | 訊息夾內文 |
178 +| 6 | btn_wording | String | * | 按鈕文字 |
179 +| 6 | url | String | * | 網址 |
180 +| 6 | create_time | Datetime | | 建立時間 |
181 +| 6 | update_time | Datetime | | 更新時間 |
182 +
183 +#### ERROR CODE
184 +
185 +| HTTP Status | ErrorCode | Message | Desc |
186 +| ---| ---| ---| --- |
Prev
派獎 - 建立審核新增
Next
派獎 - 更新審核編輯