| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| api:api_courses [2020/05/11 16:31] – [Response codes] Lauri Elevant | api:api_courses [2021/12/08 14:19] (current) – [HEAD, GET] 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". | **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. In all these cases (course, programme etc.) the technical term will still remain "course". |
| ==== Syntax ==== | ==== Syntax ==== |
| |
| | ''institution'' | **Required** | A valid institution ID in DreamApply (see the ''/api/institutions'' calls to learn it). | | | ''institution'' | **Required** | A valid institution ID in DreamApply (see the ''/api/institutions'' calls to learn it). | |
| | ''type'' | **Required** | Course type code (undergraduate, postgraduate, etc). Make a call to [[api:api_classificators|/api/classificators]] or use DreamApply GUI tools (System -> Classificators) to learn possible ''Course type'' classificator values. | | | ''type'' | **Required** | Course type code (undergraduate, postgraduate, etc). Make a call to [[api:api_classificators|/api/classificators]] or use DreamApply GUI tools (System -> Classificators) to learn possible ''Course type'' classificator values. | |
| | ''name'' | Optional | Up to 2048 characters. | | | ''mode'' | **Required** | Course mode code (full time, part time, etc). Make a call to [[api:api_classificators|/api/classificators]] or use DreamApply GUI tools (System -> Classificators) to learn possible ''Course mode'' classificator values. | |
| | | ''name'' | **Required** | Up to 2048 characters. | |
| | ''awards_abbr'' | Optional | Abbreviation of the award (BSc, MSc, etc). | | | ''awards_abbr'' | Optional | Abbreviation of the award (BSc, MSc, etc). | |
| | ''awards_full'' | Optional | Full name of the award (for example "Bachelor of Science"). Up to 2048 characters. | | | ''awards_full'' | Optional | Full name of the award (for example "Bachelor of Science"). Up to 2048 characters. | |
| | ''mode'' | Optional | Course mode code (full time, part time, etc). Make a call to [[api:api_classificators|/api/classificators]] or use DreamApply GUI tools (System -> Classificators) to learn possible ''Course mode'' classificator values. | | | |
| | ''language'' | Optional | Accepts a 2-letter (alpha-2) ISO language code. | | | ''language'' | Optional | Accepts a 2-letter (alpha-2) ISO language code. | |
| | ''country'' | Optional | Accepts an [[http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2|ISO 3166-1 alpha-2 country code]]. | | | ''country'' | Optional | Accepts an [[http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2|ISO 3166-1 alpha-2 country code]]. | |