[关闭]
@fuyb1986 2017-05-25T06:11:42.000000Z 字数 3461 阅读 555

班级

冰橙课件


获取班级列表

老师创建的班级用此接口获取
学生加入的班级用此接口获取

Method and URL Structure

Method Resource URL Authorization
GET /api/classroom/ YES

cURL Example

  1. curl -X GET -H 'Authorization: token 95b7b4d8fff5d76c9d3d2954fe5c7d456c110a8c' -H 'Content-Type: application/json' http://localhost/api/classroom/

Response Data

Name Description
pk id
name 名称
created 创建时间
teacher 教师用户信息

Response

  1. {
  2. "count":1,
  3. "next":null,
  4. "previous":null,
  5. "results":[{
  6. "pk":1,
  7. "name":"三年级(9)班",
  8. "created":"2017-05-17T17:58:58.894193",
  9. "teacher":{
  10. "pk":1,
  11. "owner":1,
  12. "nickname":"xiaoming",
  13. "avatar_url":"http://www.example.com/xiaoming.jpg",
  14. "slogan":"xiaoming's slogan",
  15. "name":"赵小明",
  16. "sex":"M",
  17. "sex_display":"男",
  18. "birthday":"1990-01-01"
  19. }
  20. }]
  21. }

创建班级

Method and URL Structure

Method Resource URL Authorization
POST /api/classroom/create/ YES

Request Pramaters

Name Description Required Default
name 名称 YES

Request Data

  1. {
  2. "name": "一年级(1)班"
  3. }

cURL Example

  1. curl -X POST -H 'Authorization: token 95b7b4d8fff5d76c9d3d2954fe5c7d456c110a8c' -H 'Content-Type: application/json' --data '{"name": "一年(1)班"}' http://localhost/api/classroom/create/

Response Data

Name Description
pk id
name 名称
created 创建时间
teacher 教师用户信息

Response

  1. {
  2. "pk":1,
  3. "name":"一年级(1)班",
  4. "created":"2017-05-17T18:17:51.396326",
  5. "teacher":{
  6. "pk":1,
  7. "owner":1,
  8. "nickname":"xiaoming",
  9. "avatar_url":"http://www.example.com/xiaoming.jpg",
  10. "slogan":"xiaoming's slogan",
  11. "name":"赵小明",
  12. "sex":"M",
  13. "sex_display":"男",
  14. "birthday":"1990-01-01"
  15. }
  16. }

更新班级

老师更新自己创建的班级

Method and URL Structure

Method Resource URL Authorization
PUT /api/classroom/update/${pk}/ YES

Request Pramaters

Name Description Required Default
name 名称 YES

Request Data

  1. {
  2. "name": "三年级(1)班"
  3. }

cURL Example

  1. curl -X PUT -H 'Authorization: token 95b7b4d8fff5d76c9d3d2954fe5c7d456c110a8c' -H 'Content-Type: application/json' --data '{"name": "三年级(1)班"}' http://localhost/api/classroom/update/200/

Response Data

Name Description
pk id
name 名称
created 创建时间
teacher 教师用户信息

Response

  1. {
  2. "pk":200,
  3. "name":"三年级(1)班",
  4. "created":"2017-05-17T18:17:51.396326",
  5. "teacher":{
  6. "pk":1,
  7. "owner":1,
  8. "nickname":"xiaoming",
  9. "avatar_url":"http://www.example.com/xiaoming.jpg",
  10. "slogan":"xiaoming's slogan",
  11. "name":"赵小明",
  12. "sex":"M",
  13. "sex_display":"男",
  14. "birthday":"1990-01-01"
  15. }
  16. }

删除班级

老师删除自己创建的班级

Method and URL Structure

Method Resource URL Authorization
DELETE /api/classroom/delete/200/ YES

cURL Example

  1. curl -X DELETE -H 'Authorization: token 95b7b4d8fff5d76c9d3d2954fe5c7d456c110a8c' -H 'Content-Type: application/json' http://localhost/api/classroom/delete/200/

搜索班级

学生获取老师创建的班级

Method and URL Structure

Method Resource URL Authorization
GET /api/classroom/search/ YES

Request Pramaters

Name Description Required Default
teacher 老师用户名 YES

Request Data

  1. {
  2. "teacher": "12345678910"
  3. }

cURL Example

  1. # 方式一
  2. curl -X GET -H "Authorization: token 95b7b4d8fff5d76c9d3d2954fe5c7d456c110a8c" -H "Content-Type: application/json" http://localhost/api/classroom/search/?teacher=12345678910
  3. # 方式二
  4. curl -X GET -H 'Authorization: token 95b7b4d8fff5d76c9d3d2954fe5c7d456c110a8c' -H 'Content-Type: application/json' --data '{"teacher": "12345678910"}' http://localhost/api/classroom/search/

Response Data

Name Description
pk id
name 名称
created 创建时间
teacher 教师用户信息

Reponse

  1. {
  2. "count":2,
  3. "next":null,
  4. "previous":null,
  5. "results":[{
  6. "pk":2,
  7. "name":"三年级(9)班",
  8. "created":"2017-05-18T14:27:57.002889",
  9. "teacher":{
  10. "pk":1,
  11. "owner":1,
  12. "nickname":"xiaoming",
  13. "avatar_url":"http://www.example.com/xiaoming.jpg",
  14. "slogan":"xiaoming's slogan",
  15. "name":"赵小明",
  16. "sex":"M",
  17. "sex_display":"男",
  18. "birthday":"1990-01-01"
  19. }
  20. },{
  21. "pk":1,
  22. "name":"三年级(9)班",
  23. "created":"2017-05-18T14:27:57.000523",
  24. "teacher":{
  25. "pk":1,
  26. "owner":1,
  27. "nickname":"xiaoming",
  28. "avatar_url":"http://www.example.com/xiaoming.jpg",
  29. "slogan":"xiaoming's slogan",
  30. "name":"赵小明",
  31. "sex":"M",
  32. "sex_display":"男",
  33. "birthday":"1990-01-01"
  34. }
  35. }]
  36. }
添加新批注
在作者公开此批注前,只有你和作者可见。
回复批注