教学管理平台【通用】web API文档

说明

必看

请求地址比如是：/client/api/clientLogin
那么请带上域名http://192.168.1.105:8000这个东西可作为一个全局变量。
例如:http://192.168.1.105:8000/client/api/clientLogin

school_id对应学校名称

school_id	对应学校名称
01-bswx	百色市民族卫生学校
02-gdyzy	广东食品药品职业学院
02-zqmc	肇庆医学高等专科学校
03-gxtcmu	广西中医药大学附设中医学校
02-qysti	清远市技师学院
02-sxyyc	重庆三峡医药高等专科学校
02-hntcmc	湖南中医药高等专科学校
02-sddfvc	山东药品食品职业学院
03-wmu	温州医科大学

software_id对应产品软件id

software_id	对应产品名称
2	中医小镇

1、MAC地址校验产品是否有效

请求地址	/client/api/codeVerify
请求方式	`POST`
请求参数	`school_id` `bind_mac` `software_id`
返回内容	`{status:Number,message:String,data:JSON_DATA}`

MAC地址校验产品是否有效postman

2、注册码激活产品

请求地址	/client/api/codeRegister
请求方式	`POST`
请求参数	`school_id` `secret_code` `bind_hostname` `bind_mac` `software_id`
返回内容	`{status:Number,message:String,data:JSON_DATA}`

注册码激活产品postman

3、学生登录

请求地址	/client/api/clientLogin
请求方式	`POST`
请求参数	`school_id` `username` `password` `software_id`
返回内容	`{status:Number,message:String,data:JSON_DATA}`

使用
登录postman

school_id传入对应的学校名称，例如：广东食品药品职业学院
software_id传入对应的产品名称，例如：中医小镇
填入账号username和密码password

学生进行登录的时候，POST请求以上4个参数和/client/api/clientLogin这个路径。

则返回 status是状态码（200成功，403失败），message是后台返回来的消息（错误或成功），data是token令牌。

注意：
data是token令牌非常重要，在后面的学生操作上传各种记录的时候要将请求头headers里的authorizationkey值，设置成这个登录返回来的data token令牌。退出软件的时候记得把token清除，不要存放在本地。

4、学生注册

请求地址	/client/api/clientSignin
请求方式	`POST`
请求参数	`class_id` `school_id` `stu_id` `sex` `real_name` `username` `password1` `password2` `software_id`
返回内容	`{status:Number,message:String,data:JSON_DATA}`

使用
注册postman

填入对应的9个参数

注意
school_id 是学校名称
software_id 是产品名称
要一字不漏的填入进去，否则后台会返回找不到对应学校或找不到对应产品名

如何获取`class_id`?

见接口5、6、7，进行获取班级列表对应的class_id。

5、获取年级列表

请求地址	/client/api/getGradeList
请求方式	`GET`
请求参数	`school_id`
返回内容	`{status:Number,message:String,data:JSON_DATA}`

获取年级列表postman

6、获取专业列表

请求地址	/client/api/getMajorList
请求方式	`GET`
请求参数	`school_id` `grade`
返回内容	`{status:Number,message:String,data:JSON_DATA}`

获取专业列表postman

7、获取班级列表

请求地址	/client/api/getClassNameList
请求方式	`GET`
请求参数	`school_id` `grade` `major`
返回内容	`{status:Number,message:String,data:JSON_DATA}`

获取班级列表postman

8、获取年级专业班级总列表

请求地址	/client/api/getGradeMajorClass
请求方式	`GET`
请求参数	`school_id`
返回内容	`{status:Number,message:String,data:JSON_DATA}`

获取年级专业班级总列表postman