| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| api:api_reports_reportname [2014/06/29 20:33] – [Parameters] Lauri | api:api_reports_reportname [2024/07/30 11:50] (current) – external edit 127.0.0.1 |
|---|
| |
| ^ Name ^ Required ^ Description ^ Notes ^ | ^ Name ^ Required ^ Description ^ Notes ^ |
| | ''?commenceYear'' | //See above// | Year number, representing the intake season to use | | | | ''commenceYear'' | //See above// | Year number, representing the intake season to use | | |
| | ''?comparedYear'' | //See above// | Same as above, used for reports that compare two seasons | | | | ''comparedYear'' | //See above// | Same as above, used for reports that compare two seasons | | |
| | ''?institutions'' | //See above// | List of [[api:api_institutions|institution ID-s]] | [1] | | | ''institutions'' | //See above// | List of [[api:api_institutions|institution ID-s]] | [1] | |
| | ''?courses'' | //See above// | List of [[api:api_courses|course ID-s]] | [1] | | | ''courses'' | //See above// | List of [[api:api_courses|course ID-s]] | [1] | |
| | ''?regions'' | //See above// | List of [[api:api_regions|region ID-s]] | [1] | | | ''regions'' | //See above// | List of [[api:api_regions|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.// | * // Note [1]: Lists can be either comma or space separated.// |
| ==== Response headers ==== | ==== Response headers ==== |
| |
| Content-Type: text/csv | Content-Type: text/csv; charset=utf-8 |
| Content-Length: 12345 | Content-Length: 12345 |
| Content-Disposition: attachment; filename="Registrations-2014-02-12T15:19:21+00:00.csv" | 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. |