Next revision | Previous revisionNext revisionBoth sides next revision |
api:api_courses [2014/07/01 22:22] – created Lauri Elevant | api:api_courses [2014/07/01 22:26] – [Parameters] Lauri Elevant |
---|
List courses using the filters set as parameters. The number of courses is represented in the ''X-Count'' header - use the ''HEAD'' request to simply count the number of courses matching the filters. Use the ''GET'' request to actually fetch them. | List courses using the filters set as parameters. The number of courses is represented in the ''X-Count'' header - use the ''HEAD'' request to simply count the number of courses matching the filters. Use the ''GET'' request to actually fetch them. |
| |
| **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". |
==== Syntax ==== | ==== Syntax ==== |
| |
| |
^ Name ^ ^ Description ^ Notes ^ | ^ Name ^ ^ Description ^ Notes ^ |
| ''byStatuses'' | Optional | List of statuses, currently limited to: ''Online'',''Standby'',''Draft'',''Archived'',''Template'',''Closed'' | [1] | | | ''byStatuses'' | Optional | List of statuses, currently limited to: ''Online'', ''Standby'', ''Draft'', ''Archived'', ''Template'', ''Closed'' | [1] | |
| ''byTypes'' | Optional | List of [[api:api_classificators|course types]] | [1] | | | ''byTypes'' | Optional | List of [[api:api_classificators|course types]] | [1] | |
| ''byModes'' | Optional | List of [[api:api_classificators|course modes]] | [1] | | | ''byModes'' | Optional | List of [[api:api_classificators|course modes]] | [1] | |