The the report's contents as CSV data. You may use the HEAD verb to see the size of the CSV data if you want to decide if it is worth downloading it.


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


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.

Name Required Description Notes
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 List of institution ID-s [1]
courses See above List of course ID-s [1]
regions See above List of region ID-s [1]
  • Note [1]: Lists can be either comma or space separated.

Response headers

Content-Type: text/csv; charset=utf-8
Content-Length: 12345
Content-Disposition: attachment; filename="Registrations-2014-02-12T15:19:21+00:00.csv"
Last-Modified: Tue, 01 Jul 2014 16:35:19 GMT
Expires: Tue, 01 Jul 2014 16:53:36 GMT

Note that the Expires and Last-Modified headers can be used to assess the need to fetch a fresh copy of the data. If a new request is issued before Expires, then the same data is guaranteed to be returned, hence making such unintelligent polling useless.