---
# System prepended metadata

title: 請校務系統廠商提供的資料

---

# 請校務系統廠商提供的資料
:::warning 
注意事項
- 所有與程式碼有關之區塊，皆須有 syntax highlight 並有醒目之區塊提示（可參考下面範例）
- 以下提供的僅為所需之資料，排版方式可做調整，以舒適且方便閱讀為原則
:::
## API 總表
自己寫
## API 詳細內容

:::info
每個API 說明都需要包含以下資訊
:::
### 基本資訊
- API 名稱
- 功能簡介
- Http method 
- API 路徑
### Request
- Parameters
    | name | detail           | example |
    | ---- |:---------------- |:------- |
    | Text | 解釋的越**詳細**越好 | Text    |
- Headers
    | name | detail           | example |
    | ---- | ---------------- |:------- |
    | Text | 解釋的越**詳細**越好 | Text    |
- Body
    | name | detail           | example |
    | ---- |:---------------- |:------- |
    | Text | 解釋的越**詳細**越好 | Text    |
    
#### Example
請提供呼叫範例

### Response
- 回傳資料欄位說明
    | name | detail               |
    | ---- |:-------------------- |
    | Text | 解釋的越**詳細**越好 |
- Success Response Example
    ```json
    HTTP/1.1 200 OK
    Server: Jaguar Server Version 5.5.0
    X-Trace-Id: test
    Connection: Close
    Content-Type: application/json; charset=UTF-8
    Transfer-Encoding: chunked

    {
      "code": 0,
      "msg": "Success",
      "data": []
    }
    ```
- Error Response Example
    需要詳細列出所有會遇到的 Error Code，並說明原因
    :::info
    每個 API Error Code 都需要包含以下資訊
    :::
    - 請**詳細**說明錯誤原因  
    - Http Status Code
    - Example Response 
        ```json
        HTTP/1.1 401 Unauthorized
        Transfer-Encoding: chunked
        Content-Type: application/json; charset=utf-8
        Server: Microsoft-IIS/7.5
        X-Powered-By: ASP.NET
        Date: Mon, 12 Dec 2022 06:46:25 GMT
        Connection: close

        {
          "code": 2,
          "msg": "Wrong account or password",
          "data": null
        }
        ```
    

## 文件版本修訂紀錄
- 日期、時間
- 修改者
- 修改的地方、原因