派獎 - 審核覆核.md
60 additions, 0 deletions
| ... | ... | @@ -1 +1,61 @@ |
| 1 | +### SUMMARY | |
| 2 | +審核派獎設定申請（包含通過和拒絕）。 | |
| 3 | +### REFERENCE TABLE | |
| 4 | +* `DBMT.CMS_AUDIT` | |
| 5 | +* `DBMT.AWARD_GROUP` | |
| 6 | +* `DBMT.AWARD` | |
| 7 | + | |
| 8 | +### ATTRIBUTES - 審核通過 | |
| 9 | +* METHOD: **PATCH** | |
| 10 | +* PATH: `/api/features/award/groups/audit/approve/{audit_id}` | |
| 11 | +* LOGIN REQUIRED: **TRUE** | |
| 12 | +* FEATURE: `AWARD_GROUP` | |
| 13 | +* PERMISSION: `REVIEW` | |
| 14 | +* CRYPTO: **None** | |
| 15 | + | |
| 16 | +### ATTRIBUTES - 審核拒絕 | |
| 17 | +* METHOD: **PATCH** | |
| 18 | +* PATH: | |
| 19 | +* LOGIN REQUIRED: **TRUE** | |
| 20 | +* FEATURE: `AWARD_GROUP` | |
| 21 | +* PERMISSION: `REVIEW` | |
| 22 | +* CRYPTO: **None** | |
| 23 | + | |
| 24 | +### REQUEST | |
| 25 | +#### HEADERS | |
| 26 | + | |
| 27 | +| Name | Type/Len | Required(*) | Desc | | |
| 28 | +| ---| ---| ---| --- | | |
| 29 | +| Content-Type | String | * | `"application/json"` | | |
| 30 | +| Authorization | String | * | JWT Token | | |
| 31 | +| X-Request-Id | String | | X-Request-Id for api flow tracing | | |
| 32 | + | |
| 33 | +#### PATH PARAMETERS | |
| 34 | + | |
| 35 | +| Name | Type/Len | Required(*) | Desc | | |
| 36 | +| ---| ---| ---| --- | | |
| 37 | +| audit_id | Integer | * | 審核 ID | | |
| 38 | + | |
| 39 | +#### PAYLOAD | |
| 40 | + | |
| 41 | +| Level | Name | Type/Len | Required(*) | Nullable(*) | Desc | | |
| 42 | +| ---| ---| ---| ---| ---| --- | | |
| 43 | +| 1 | comment | String(256) | (拒絕時必填) | * | 審核原因 | | |
| 44 | + | |
| 45 | +### RESPONSE | |
| 46 | +#### STATUS CODE | |
| 47 | +* 200 | |
| 48 | + | |
| 49 | +#### BODY | |
| 50 | + | |
| 51 | +| Level | Name | Type/Len | Nullable(*) | Desc | | |
| 52 | +| ---| ---| ---| ---| --- | | |
| 53 | +| 1 | status | String | | 回應狀態 (SUCCESS, FAILURE) | | |
| 54 | +| 1 | data | Dict | | 通用資料包裝 | | |
| 55 | +| 2 | id | Integer | | `CMS_AUDIT`.id | | |
| 56 | + | |
| 57 | +#### ERROR CODE | |
| 58 | + | |
| 59 | +| HTTP Status | ErrorCode | Message | Desc | | |
| 60 | +| ---| ---| ---| --- | |