This is an old revision of the document!

/api/courses

HEAD, GET

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

GET /api/courses
Host: apply.example.edu
Authorization: DREAM apikey="..."

Parameters

Name		Description	Notes
`byStatuses`	Optional	List of statuses, currently limited to: `Online`, `Standby`, `Draft`, `Archived`, `Template`, `Closed`	[1]
`byTypes`	Optional	List of course types	[1]
`byModes`	Optional	List of course modes	[1]

Note [1]: Lists can be either comma or space separated. All list items are combined with logical OR operators - in other words an institution is considered matching if it matches to any of the values in the list.

Response headers

Content-Type: application/json
Content-Length: 1456
X-Count: 123

Response example

{
  "1": {
      "status": "Online",
      "updated": "2014-06-20T11:00:15+00:00",
      "institution": "/api/institutions/1",
      "intakes": {
          "1": "/api/intakes/1"
      },
      "featured": false,
      "type": "UG",
      "awards": [
          {
              "abbr": "BSc",
              "full": ""
          }
      ],
      "name": "Sample under-graduate course",
      "mode": "FT",
      "duration": "3 years",
      "credits": null,
      "language": "en",
      "country": "EE",
      "location": "Tallinn",
      "code": null,
      "quota": null,
      "prospect": {
          "uri": null
      }
  },
  "2": {
      "status": "Online",
      "updated": "2014-06-20T11:00:15+00:00",
      "institution": "/api/institutions/1",
      "intakes": {
          "1": "/api/intakes/1"
      },
      "featured": false,
      "type": "PG",
      "awards": [
          {
              "abbr": "MSc",
              "full": ""
          }
      ],
      "name": "Sample post-graduate course",
      "mode": "FT",
      "duration": "2 years",
      "credits": null,
      "language": "en",
      "country": "EE",
      "location": "Tallinn",
      "code": null,
      "quota": null,
      "prospect": {
          "uri": null
      }
  },
  "3": {
      "status": "Online",
      "updated": "2014-06-20T11:00:15+00:00",
      "institution": "/api/institutions/1",
      "intakes": {
          "1": "/api/intakes/1"
      },
      "featured": false,
      "type": "TU",
      "awards": [
          {
              "abbr": "BSc",
              "full": ""
          }
      ],
      "name": "Sample top-up course",
      "mode": "FT",
      "duration": "1 year",
      "credits": null,
      "language": "en",
      "country": "EE",
      "location": "Tallinn",
      "code": null,
      "quota": null,
      "prospect": {
          "uri": null
      }
  }
}