课程表API文档

1. 1. 默认模块
2. 2. Authentication
3. 3. 课程
   1. 3.1. POST 添加课程
      1. 3.1.1. 请求参数
      2. 3.1.2. 返回结果
      3. 3.1.3. 返回数据结构
   2. 3.2. GET 获取某一天课程
      1. 3.2.1. 请求参数
      2. 3.2.2. 返回结果
      3. 3.2.3. 返回数据结构
   3. 3.3. GET 获取所有课程
      1. 3.3.1. 请求参数
      2. 3.3.2. 返回结果
      3. 3.3.3. 返回数据结构
   4. 3.4. POST 删除课程
      1. 3.4.1. 请求参数
      2. 3.4.2. 返回结果
      3. 3.4.3. 返回数据结构
4. 4. 周次
   1. 4.1. GET 获取当前周次
      1. 4.1.1. 返回结果
      2. 4.1.2. 返回数据结构
   2. 4.2. GET 更新周次
      1. 4.2.1. 请求参数
      2. 4.2.2. 返回结果
      3. 4.2.3. 返回数据结构
5. 5. 节次
   1. 5.1. POST 添加节次
      1. 5.1.1. 请求参数
      2. 5.1.2. 返回结果
      3. 5.1.3. 返回数据结构
   2. 5.2. POST 设置当前周次
      1. 5.2.1. 请求参数
      2. 5.2.2. 返回结果
      3. 5.2.3. 返回数据结构
   3. 5.3. GET 获取所有节次
      1. 5.3.1. 请求参数
      2. 5.3.2. 返回结果
      3. 5.3.3. 返回数据结构
   4. 5.4. POST 删除节次
      1. 5.4.1. 请求参数
      2. 5.4.2. 返回结果
      3. 5.4.3. 返回数据结构
6. 6. 数据模型

默认模块

Base URLs:

Authentication

课程

POST 添加课程

POST /capi/course/add/index.php

Body 请求参数

token: ""
name: 英语
teacher: ""
day: "2"
start_jc: "7"
end_jc: "8"
start_week: "1"
end_week: "17"
type: "2"
address: ""

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» token	body	string	是	none
» name	body	string	是	none
» teacher	body	string	是	none
» day	body	string	是	none
» start_jc	body	string	是	none
» end_jc	body	string	是	none
» start_week	body	string	是	none
» end_week	body	string	是	none
» type	body	string	是	none
» address	body	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

GET 获取某一天课程

GET /capi/course/list/index.php

请求参数

名称	位置	类型	必选	说明
token	query	string	是	none
day	query	string	是	none
week	query	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

GET 获取所有课程

GET /capi/course/all/index.php

请求参数

名称	位置	类型	必选	说明
token	query	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

POST 删除课程

POST /capi/course/delete/index.php

Body 请求参数

token: ""
id: ""

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» token	body	string	是	none
» id	body	string	是	课程id

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

周次

GET 获取当前周次

GET /capi/options/current_week.php

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

GET 更新周次

GET /capi/options/update_week.php

请求参数

名称	位置	类型	必选	说明
token	query	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

节次

POST 添加节次

POST /capi/jc/add/index.php

Body 请求参数

token: ""
name: ""
start: ""
end: ""

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» token	body	string	是	none
» name	body	string	是	none
» start	body	string	是	none
» end	body	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

POST 设置当前周次

POST /capi/options/set_week.php

Body 请求参数

token: ""
week: ""

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» token	body	string	是	none
» week	body	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

GET 获取所有节次

GET /capi/jc/all/

请求参数

名称	位置	类型	必选	说明
token	query	string	是	none

返回示例

200 Response

{
    "status": "success",
    "message": "获取数据成功",
    "data": [
        {
            "id": "ef4861af05d2da835887877edce11b8b",
            "name": "1",
            "time": "8:00-8:45"
        },
        {
            "id": "ab2daadf27506caf6931f0ca8b8462fe",
            "name": "2",
            "time": "8:55-9:40"
        },
        {
            "id": "a75349da4ac2530bc08753bfffb3a2ef",
            "name": "3",
            "time": "10:00-10:45"
        },
        {
            "id": "c370c47a23a764731ede6dacd02f83a8",
            "name": "4",
            "time": "10:55-11:40"
        },
        {
            "id": "2b6ff6642c4ded48eeeb55e2ca55d465",
            "name": "5",
            "time": "11:45-12:30"
        },
        {
            "id": "e9b541d3b6a13c4dbe70ffd48ba29912",
            "name": "6",
            "time": "14:05-14:50"
        },
        {
            "id": "46984f55fd18f1f569c0c957e5976c77",
            "name": "7",
            "time": "15:00-15:45"
        },
        {
            "id": "5b80064be735c7dbefe40f9495c43965",
            "name": "8",
            "time": "15:55-16:40"
        },
        {
            "id": "db7a5133e6a105f6d43d70f1aa1cfb54",
            "name": "9",
            "time": "17:00-17:45"
        },
        {
            "id": "5070eba9897d091b27787bc7d86456c5",
            "name": "10",
            "time": "17:55-18:40"
        },
        {
            "id": "e5854339e47b2bc759aa81dde2f105e3",
            "name": "11",
            "time": "19:10-19:55"
        },
        {
            "id": "c595bf5b941b31fd016e67d89003c557",
            "name": "12",
            "time": "20:05-20:50"
        },
        {
            "id": "aaf7ce19091d261a6dde21b10f9ebb25",
            "name": "13",
            "time": "20:55-21:40"
        }
    ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

POST 删除节次

POST /capi/jc/delete/

Body 请求参数

token: ""
id: ""

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» token	body	string	是	none
» id	body	string	是	节次id

返回示例

{
    "status": "failed",
    "message": "该节次不存在",
    "data": ""
}

{
    "status": "success",
    "message": "删除节次成功",
    "data": ""
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

数据模型