Skip to content

api.md

Latest commit

 

History

History
40 lines (24 loc) · 1.51 KB

api.md

File metadata and controls

40 lines (24 loc) · 1.51 KB

EduServer API

This is specification for EduServer API.

API uses REST guidelines and primarily flat structure.

Descriptions for some of object types can be found here.

Some requests have Required authentication or Required authorization marks. This requests must contain Authorization header with Bearer token obtained from server.

Endpoints

Common API:

  • POST /auth – Acquire token: In progress ...

Learner API:

  • GET /courses — Get all courses: details

  • GET /courses/<pk>/materials — Get all course materials: details

  • GET|HEAD /courses/<pk>/structure — Get structure of the course: details

  • GET /sections/<pk> — Get one or several sections: details

  • GET /lessons/<pk> — Get one or several lessons: details

  • GET /tasks/<pk> — Get one or several tasks: details

  • GET /comments/<pk> — Get all comments for <pk> study item: In progress ...

  • POST /comments/<pk> — Send comment for <pk> study item: In progress ...

Educator API:

  • POST /courses — Create new course: details.

  • PUT /courses/<pk>/update — Upload new version of the course: details

  • GET /courses/mine — Get all courses available for editing: In progress ...

  • GET /courses/<pk>/full — Get editing materials for this course: In progress ...