| Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision |
| api:api_courses [2020/05/11 16:29] – Lauri Elevant | api:api_courses [2020/05/11 16:31] – [Response codes] Lauri Elevant |
|---|
| | ''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'' | Up to 2048 characters. | | | ''name'' | Optional | Up to 2048 characters. | |
| | ''awards_abbr'' | Abbreviation of the award (BSc, MSc, etc). | | | ''awards_abbr'' | Optional | Abbreviation of the award (BSc, MSc, etc). | |
| | ''awards_full'' | 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'' | 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. | | | | ''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'' | Accepts a 2-letter (alpha-2) ISO language code. | | | ''language'' | Optional | Accepts a 2-letter (alpha-2) ISO language code. | |
| | ''country'' | 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]]. | |
| | ''location'' | The location where the studies take place (city, district, etc). Up to 256 characters. | | | ''location'' | Optional | The location where the studies take place (city, district, etc). Up to 256 characters. | |
| | ''code'' | Can be any text to uniquely identify this course in another system, like a Study Information System or course catalogue. Up to 128 characters. | | | ''code'' | Optional | Can be any text to uniquely identify this course in another system, like a Study Information System or course catalogue. Up to 128 characters. | |
| | ''prospect_uri'' | An URL where the applicant can learn more about this course/programme. | | | ''prospect_uri'' | Optional | An URL where the applicant can learn more about this course/programme. | |
| |
| ==== Response headers ==== | ==== Response headers ==== |
| |
| | ''201 Created'' | New course was created | | | ''201 Created'' | New course was created | |
| | | ''422 Unprocessable Entity'' | There were some validation errors (see the returned text) | |