Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision |
api:api_applications [2020/10/14 15:06] – [Parameters] Lauri Elevant | api:api_applications [2021/01/21 12:51] – external edit 127.0.0.1 |
---|
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] | |
| ''byOfferInstitutionIDs'' | Optional | List of [[api:api_institutions|institution IDs]]. An application will match if it contains at least one offer from the listed institutions. | [1] | | | ''byOfferInstitutionIDs'' | Optional | List of [[api:api_institutions|institution IDs]]. An application will match if it contains at least one offer from the listed institutions. | [1] | |
| ''byFlagIDs'' | Optional | List of [[api:api_applications_flags|flag IDs]] | [1] [3] | | | ''byFlagIDs'' | Optional | List of [[api:api_applications_flags|flag IDs]] | [1] [3] | |
| ''limit'' | Optional | How many applications to return (Allowed range is normally 1..8192, 8192 being the default). If the ''expand'' parameter is used, the limit is 512. | | | | ''limit'' | Optional | How many applications to return (Allowed range is normally 1..16384, 16384 being the default). If the ''expand'' parameter is used, the limit is 512. | | |
| ''expand'' | Optional | Expand the chosen relational element(s), for example ''applicant,offer'' | [4] | | | ''expand'' | Optional | Expand the chosen relational element(s), for example ''applicant,offer'' | [4] | |
| |