Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
Next revisionBoth sides next revision
api:api_courses [2014/07/01 22:22] – created Lauri Elevantapi:api_courses [2014/07/23 22:26] Lauri Elevant
Line 5: Line 5:
 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 ====
  
Line 15: Line 15:
  
 ^ 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] |
Line 26: Line 26:
   Content-Length: 1456   Content-Length: 1456
   X-Count: 123   X-Count: 123
 +
 +==== Response example ====
 +
 +  {
 +    "1": {
 +        "status": "Online",
 +        "updated": "2014-06-20T11:00:15+00:00",
 +        "institution": "/api/institutions/1",
 +        "partnership": null,
 +        "partner": null,
 +        "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",
 +        "partnership": null,
 +        "partner": null,
 +        "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",
 +        "partnership": null,
 +        "partner": null,
 +        "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
 +        }
 +    }
 +  }