新增條件樣板.md
87 additions, 0 deletions
| ... | ... | @@ -1 +1,88 @@ |
| 1 | +## SUMMARY | |
| 2 | +建立任務牆子任務條件 template，樣板不需過審可直接新增修改 | |
| 3 | +### REFERENCE TABLE | |
| 4 | +* `DBMT.CMS_MISSION_RULE_PATTERN` | |
| 5 | +### ATTRIBUTES | |
| 6 | +* METHOD: **POST** | |
| 7 | +* PATH: `/api/features/mission-board/pattern/create` | |
| 8 | +* LOGIN REQUIRED: **TRUE** | |
| 9 | +* FEATURE: `MISSION_BOARD` | |
| 10 | +* PERMISSION: `CREATE` | |
| 11 | +* CRYPTO: **None** | |
| 12 | + | |
| 13 | +### REQUEST | |
| 14 | +#### HEADERS | |
| 15 | + | |
| 16 | +| Name | Type/Len | Required(*) | Desc | | |
| 17 | +| ---| ---| ---| --- | | |
| 18 | +| Content-Type | String | * | `"application/json"` | | |
| 19 | +| Authorization | String | | JWT Token | | |
| 20 | +| X-Request-Id | String | | X-Request-Id for api flow tracing | | |
| 21 | + | |
| 22 | +```json | |
| 23 | +// Example: | |
| 24 | +{ | |
| 25 | + "Content-Type": "application/json", | |
| 26 | + "Authorization": "Bearer jwt-token", | |
| 27 | + "x-request-id": "78f91284-d9df-43e6-a8d2-d557273c10bb" | |
| 28 | +} | |
| 29 | +``` | |
| 30 | + | |
| 31 | +#### PAYLOAD | |
| 32 | + | |
| 33 | +| Level | Name | Type/Len | Required(*) | Nullable(*) | Desc | | |
| 34 | +| ---| ---| ---| ---| ---| --- | | |
| 35 | +| 1 | data | Dict | * | | 樣板條件設定 | | |
| 36 | + | |
| 37 | +### DATA | |
| 38 | + | |
| 39 | +| Level | Name | Type/Len | Required(*) | Nullable(*) | Desc | | |
| 40 | +| ---| ---| ---| ---| ---| --- | | |
| 41 | +| 2 | award_group | Dict | * | | 派獎群組設定 | | |
| 42 | +| 2 | gp_action | Dict | * | | 小樹點有效期限設定 | | |
| 43 | +| 2 | awards | List(Dict) | * | | 獎項設定列表 | | |
| 44 | + | |
| 45 | +### award_group | |
| 46 | + | |
| 47 | +| Level | Name | Type/Len | Required(*) | Nullable(*) | Desc | | |
| 48 | +| ---| ---| ---| ---| ---| --- | | |
| 49 | +| 3 | id | Integer | | * | 派獎群組 ID (新增時不提供) | | |
| 50 | +| 3 | name | String(50) | * | | 派獎群組名稱 | | |
| 51 | +| 3 | status | Enum | * | | 狀態:<br>ACTIVE: 上架<br>INACTIVE: 下架<br>RETIRED: 永久下架 | | |
| 52 | +| 3 | start_time | Datetime | * | | 派獎開始時間 | | |
| 53 | +| 3 | end_time | Datetime | * | | 派獎結束時間 | | |
| 54 | + | |
| 55 | +### | |
| 56 | + | |
| 57 | +### RESPONSE | |
| 58 | +#### STATUS CODE | |
| 59 | +* 201 | |
| 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 | +| 2 | id | Integer | | `CMS_AUDIT`.id | | |
| 82 | + | |
| 83 | +#### ERROR CODE | |
| 84 | + | |
| 85 | +| HTTP Status | ErrorCode | Message | Desc | | |
| 86 | +| ---| ---| ---| --- | | |
| 87 | +| | | | | |