| Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision |
| api:api_applications [2020/10/18 11:32] – [Parameters] Lauri Elevant | api:api_applications [2020/12/29 10:04] – [Parameters] Lauri Elevant |
|---|
| Retrieve a list of applications that match the set filtering criterion. As per norm, the ''HEAD'' verb is useful to just test if such an application exist (and how many). | Retrieve a list of applications that match the set filtering criterion. As per norm, the ''HEAD'' verb is useful to just test if such an application exist (and how many). |
| |
| There is a hard limit of 8192 items returned, which is capped to 512 if the ''expand'' parameter is used. | There is a hard limit of 16384 items returned, which is capped to 512 if the ''expand'' parameter is used. |
| ==== Syntax ==== | ==== Syntax ==== |
| |
| | ''byAcademicTermID'' | **Required** \\ (either one) | The [[api:api_academic-terms|academic term]] to filter by. | | | | ''byAcademicTermID'' | **Required** \\ (either one) | The [[api:api_academic-terms|academic term]] to filter by. | | |
| | ''byAcademicYear'' | ::: | The [[api:api_academic-years|academic year]] to filter by. | | | | ''byAcademicYear'' | ::: | The [[api:api_academic-years|academic year]] to filter by. | | |
| | | ''byAcademicYears'' | ::: | The [[api:api_academic-years|academic years]] to filter by. | | |
| | ''byCommenceYear'' | <del>Deprecated</del> | Year number, for example "2015". Please use academic year or term now. | | | | ''byCommenceYear'' | <del>Deprecated</del> | Year number, for example "2015". Please use academic year or term now. | | |
| | ''byApplicantIDs'' | Optional | List of [[api:api_applicants|applicant IDs]]. An application will match if it belongs to one of the listed applicants. | [1] | | | ''byApplicantIDs'' | Optional | List of [[api:api_applicants|applicant IDs]]. An application will match if it belongs to one of the listed applicants. | [1] | |