This is an old revision of the document!
/api/applications/ID/courses/ID
HEAD, GET
Use the HEAD
verb to test if the application in question has this course. A request with the GET
verb returns some additional information about the course association (priority, date submitted etc.).
An application can contain multiple courses (or “priorities”) that the applicant has chosen to apply to.
Courses is the technical name given to resources that applicants “can apply to”. In some educational systems students may apply to programmes, in others, to courses. Furthermore, in exchange setups courses represent the mobilities that can be applied to. In all these cases (course, programme, mobility etc.) the technical term will still remain “course”.
Note that this will not return the course itself, but rather represents the relationships between the application and the course. Follow the course URI in the response to retrieve further information about the course in question.
Syntax
GET /api/applications/123/courses/1 Host: apply.example.edu Authorization: DREAM apikey="..."
Response headers
Content-Type: application/json Content-Length: 1234
Response codes
200 OK | The course is being applied to with this application |
404 Not Found | The course is not applied to with this application |
Response examples
{ "priority": 1, "submitted": null, "course": "/api/courses/1", "intake": "/api/intakes/2" }