取得品牌列表.md
144 additions, 0 deletions
| ... | ... | @@ -1 +1,145 @@ |
| 1 | +# 品牌館 - 品牌館列表 | |
| 2 | +### SUMMARY | |
| 3 | +查詢品牌館資訊列表,支援分頁及篩選功能。可依品牌館名稱、品牌館代號進行查詢,並支援排序功能。 | |
| 4 | + | |
| 5 | +### REFERENCE TABLE | |
| 6 | + | |
| 7 | +**品牌館相關** | |
| 8 | +* `DBMT.T_BAS_BRAND_INFO` | |
| 9 | + | |
| 10 | +### ATTRIBUTES | |
| 11 | +* METHOD: **GET** | |
| 12 | +* PATH: `/api/features/mission-board/brand` | |
| 13 | +* LOGIN REQUIRED: **TRUE** | |
| 14 | +* FEATURE: `None` | |
| 15 | +* PERMISSION: `None` | |
| 16 | +* CRYPTO: **None** | |
| 17 | + | |
| 18 | +### REQUEST | |
| 19 | +#### HEADERS | |
| 20 | + | |
| 21 | +| Name | Type/Len | Required(*) | Desc | | |
| 22 | +| ---| ---| ---| --- | | |
| 23 | +| Authorization | String | * | JWT Token | | |
| 24 | +| X-Request-Id | String | | X-Request-Id for api flow tracing | | |
| 25 | + | |
| 26 | +```json | |
| 27 | +// Example: | |
| 28 | +{ | |
| 29 | + "Authorization": "Bearer jwt-token", | |
| 30 | + "x-request-id": "78f91284-d9df-43e6-a8d2-d557273c10bb" | |
| 31 | +} | |
| 32 | +``` | |
| 33 | + | |
| 34 | +#### QUERY PARAMETERS | |
| 35 | + | |
| 36 | +| Name | Type/Len | Required(*) | Desc | | |
| 37 | +| ---| ---| ---| --- | | |
| 38 | +| seq_no | Integer | | 序號 | | |
| 39 | +| brand_id | String | | 品牌館代號 (精準搜尋) | | |
| 40 | +| brand_name | String | | 品牌館名稱 (模糊搜尋) | | |
| 41 | + | |
| 42 | +```cpp | |
| 43 | +// Example | |
| 44 | +GET /api/features/mission-board/brand?brand_name=星巴克 | |
| 45 | +``` | |
| 46 | + | |
| 47 | +### RESPONSE | |
| 48 | +#### STATUS CODE | |
| 49 | +* 200 | |
| 50 | + | |
| 51 | +#### HEADERS | |
| 52 | + | |
| 53 | +| Name | Type/Len | Desc | | |
| 54 | +| ---| ---| --- | | |
| 55 | +| Authorization | String | JWT Token | | |
| 56 | +| X-Request-Id | String | Returning Request-Id | | |
| 57 | + | |
| 58 | +```json | |
| 59 | +// Example: | |
| 60 | +{ | |
| 61 | + "Authorization": "Bearer jwt-token", | |
| 62 | + "x-request-id": "78f91284-d9df-43e6-a8d2-d557273c10bb" | |
| 63 | +} | |
| 64 | +``` | |
| 65 | + | |
| 66 | +#### BODY | |
| 67 | + | |
| 68 | +| Level | Name | Type/Len | Nullable(*) | Desc | | |
| 69 | +| ---| ---| ---| ---| --- | | |
| 70 | +| 1 | status | String | | 回應狀態 (SUCCESS, FAILURE) | | |
| 71 | +| 1 | data | Dict | | 通用資料包裝 | | |
| 72 | + | |
| 73 | +#### Data | |
| 74 | + | |
| 75 | +| Level | Name | Type/Len | Nullable(*) | Desc | | |
| 76 | +| ---| ---| ---| ---| --- | | |
| 77 | +| 2 | items | List | | 品牌館列表 | | |
| 78 | + | |
| 79 | +#### items | |
| 80 | + | |
| 81 | +| Level | Name | Type/Len | Nullable(*) | Desc | Source | | |
| 82 | +| ---| ---| ---| ---| ---| --- | | |
| 83 | +| 3 | seq_no | Integer | | 序號 | `T_BAS_BRAND_INFO.SEQ_NO` | | |
| 84 | +| 3 | brand_id | String | | 品牌館代號 | `T_BAS_BRAND_INFO.BRAND_ID` | | |
| 85 | +| 3 | brand_name | String | | 品牌館名稱 | `T_BAS_BRAND_INFO.BRAND_NAME` | | |
| 86 | +| 3 | brand_pic | String | | 品牌館圖片 | `T_BAS_BRAND_INFO.BRAND_PIC` | | |
| 87 | +| 3 | brand_order | Integer | * | 品牌館排序 | `T_BAS_BRAND_INFO.BRAND_ORDER` | | |
| 88 | +| 3 | create_id | String | * | 建立者 | `T_BAS_BRAND_INFO.CREATE_ID` | | |
| 89 | +| 3 | create_time | Datetime | * | 建立時間 | `T_BAS_BRAND_INFO.CREATE_TIME` | | |
| 90 | +| 3 | update_id | String | * | 更新者 | `T_BAS_BRAND_INFO.UPDATE_ID` | | |
| 91 | +| 3 | update_time | Datetime | * | 更新時間 | `T_BAS_BRAND_INFO.UPDATE_TIME` | | |
| 92 | +| 3 | version | Integer | | 版本 | `T_BAS_BRAND_INFO.VERSION` | | |
| 93 | + | |
| 94 | +```json | |
| 95 | +// Example: | |
| 96 | +{ | |
| 97 | + "status": "SUCCESS", | |
| 98 | + "data": { | |
| 99 | + "items": [ | |
| 100 | + { | |
| 101 | + "seq_no": 1, | |
| 102 | + "brand_id": "STARBUCKS", | |
| 103 | + "brand_name": "星巴克咖啡", | |
| 104 | + "brand_pic": "starbucks_logo.png", | |
| 105 | + "brand_order": 1, | |
| 106 | + "create_id": "admin", | |
| 107 | + "create_time": "2024/01/15 10:30:00", | |
| 108 | + "update_id": "admin", | |
| 109 | + "update_time": "2024/06/20 14:25:00", | |
| 110 | + "version": 2 | |
| 111 | + }, | |
| 112 | + { | |
| 113 | + "seq_no": 2, | |
| 114 | + "brand_id": "MCDONALD", | |
| 115 | + "brand_name": "麥當勞", | |
| 116 | + "brand_pic": "mcdonalds_logo.png", | |
| 117 | + "brand_order": 2, | |
| 118 | + "create_id": "admin", | |
| 119 | + "create_time": "2024/01/15 11:00:00", | |
| 120 | + "update_id": null, | |
| 121 | + "update_time": null, | |
| 122 | + "version": 0 | |
| 123 | + }, | |
| 124 | + { | |
| 125 | + "seq_no": 3, | |
| 126 | + "brand_id": "UNIQLO", | |
| 127 | + "brand_name": "UNIQLO", | |
| 128 | + "brand_pic": "uniqlo_logo.png", | |
| 129 | + "brand_order": 3, | |
| 130 | + "create_id": "admin", | |
| 131 | + "create_time": "2024/01/16 09:15:00", | |
| 132 | + "update_id": "editor", | |
| 133 | + "update_time": "2024/05/10 16:45:00", | |
| 134 | + "version": 1 | |
| 135 | + } | |
| 136 | + ] | |
| 137 | + } | |
| 138 | +} | |
| 139 | +``` | |
| 140 | + | |
| 141 | +#### ERROR CODE | |
| 142 | + | |
| 143 | +| HTTP Status | ErrorCode | Message | Desc | | |
| 144 | +| ---| ---| ---| --- | |