This is an old revision of the document!
/api/reports/ReportName
HEAD, GET
List applicants using the filters set as parameters. The number of applicants is represented in the X-Count header - use the HEAD request to simply count the number of applicants matching the filters. Use the GET request to actually fetch them.
Syntax
GET /api/reports/Registrations Host: apply.example.edu Authorization: DREAM apikey="..."
Parameters
Each report will require a different set of parameters. If any one of them is not properly set, an error will be returned, listing the unset parameters. Use this functionality to learn which report will require which parameter.
?commenceYear | See above | Year number, representing the intake season to use |
?comparedYear | See above | Same as above, used for reports that compare two seasons |
?institutions | See above | A space or comma separated list of institution ID-s |
?courses | See above | A space or comma separated list of course ID-s |
?regions | See above | A space or comma separated list of region ID-s |
Response headers
Content-Type: text/csv Content-Length: 12345 Content-Disposition: attachment; filename="Registrations-2014-02-12T15:19:21+00:00.csv"