---
# System prepended metadata

title: Untitled

---

## 约定

### 数据格式

- 响应状态码约定：

  响应有两种情况：成功或失败。目前为简单起见，成功统一使用200状态码，失败统一使用400状态码，具体错误情况在消息体中表明。

- 返回格式:

  ```json5
  {
      "succeed": false,  // 表明操作是否成功
      "err_code": 10000,  // 如果未成功，则此项存在，表示错误码
      "err_msg": "map no found",  // 如果未成功，则此项存在，表示错误信息
      "data": {
          // 如果操作成功，则此项存在，作为响应数据，可为none
      }
  }
  ```

## 学生端

- 获取登录页面
    - url
        `GET /login`
        `GET /student/login`
    - returns

- 登录
    - url 
        `POST /student/login`
    - data
        ```json
        {
            "account":"123456"
            "password":"000000"
            "user_type":"student"
        }
        ```
    - returns
        - success
             ```json
            {
                "status_code":"00000"
                "message":"success"
                "data":null
            }
            ```
        - failure
            ```json
            {
                "status_code":"A0201"
                "message":"account doesn't exist"
                "data":null
            }
            ```
            ```json
            {
                "status_code":"A0210"
                "message":"password wrong"
                "data":null
            }
            ```
- 登出
    - url
        `GET /student/logout`
    - returns
        - success
             ```json
            {
                "status_code":"00000"
                "message":"success"
                "data":null
            }
            ```
        - failure
            ```json
            {
                "status_code":"B0001"
                "message":"system wrong"
                "data":null
            }
            ```