派獎 - 建立審核以永久下架.md
54 additions, 0 deletions
| ... | ... | @@ -1 +1,55 @@ |
| 1 | +### SUMMARY | |
| 2 | +建立審核以將派獎設定永久下架（狀態改為 RETIRED）。 | |
| 3 | +* 永久下架後無法再次上架 | |
| 4 | +* 需要審核通過才會生效 | |
| 5 | + | |
| 6 | +### REFERENCE TABLE | |
| 7 | +* `DBMT.CMS_AUDIT` | |
| 8 | +* `DBMT.CMS_AUDIT_ENTRY` | |
| 9 | +* `DBMT.AWARD_GROUP` | |
| 10 | + | |
| 11 | +### ATTRIBUTES | |
| 12 | +* METHOD: **POST** | |
| 13 | +* PATH: `/api/features/award/group/audit/retire/{data_id: int}` | |
| 14 | +* LOGIN REQUIRED: **TRUE** | |
| 15 | +* FEATURE: `AWARD_GROUP` | |
| 16 | +* PERMISSION: `UPDATE`, `APPLY` | |
| 17 | +* CRYPTO: **None** | |
| 18 | + | |
| 19 | +### REQUEST | |
| 20 | +#### HEADERS | |
| 21 | + | |
| 22 | +| Name | Type/Len | Required(*) | Desc | | |
| 23 | +| ---| ---| ---| --- | | |
| 24 | +| Authorization | String | * | JWT Token | | |
| 25 | +| X-Request-Id | String | | X-Request-Id for api flow tracing | | |
| 26 | + | |
| 27 | +#### PAYLOAD | |
| 28 | +No request body required | |
| 29 | + | |
| 30 | +### RESPONSE | |
| 31 | +#### STATUS CODE | |
| 32 | +* 201 | |
| 33 | + | |
| 34 | +#### HEADERS | |
| 35 | + | |
| 36 | +| Name | Type/Len | Desc | | |
| 37 | +| ---| ---| --- | | |
| 38 | +| Authorization | String | JWT Token | | |
| 39 | +| X-Request-Id | String | Returning Request-Id | | |
| 40 | + | |
| 41 | +#### BODY | |
| 42 | + | |
| 43 | +| Level | Name | Type/Len | Nullable(*) | Desc | | |
| 44 | +| ---| ---| ---| ---| --- | | |
| 45 | +| 1 | status | String | | 回應狀態 (SUCCESS, FAILURE) | | |
| 46 | +| 1 | data | Dict | | 通用資料包裝 | | |
| 47 | +| 2 | id | Integer | | `CMS_AUDIT`.id | | |
| 48 | + | |
| 49 | +#### ERROR CODE | |
| 50 | + | |
| 51 | +| HTTP Status | ErrorCode | Message | Desc | | |
| 52 | +| ---| ---| ---| --- | | |
| 53 | +| 404 | NotFound | Award group not found | 派獎群組不存在 | | |
| 54 | +| 409 | AwardGroupError | Award group already retired | 派獎群組已永久下架 | |