This is an old revision of the document!


/api/reports/ReportName

HEAD, GET

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.

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.

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. All list items are combined with logical OR operators - in other words an application is considered matching if it matches to any of the values in the list.

Response headers

Content-Type: text/csv
Content-Length: 12345
Content-Disposition: attachment; filename="Registrations-2014-02-12T15:19:21+00:00.csv"