| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| api:api_applications [2023/02/06 13:18] – [HEAD, GET] Safak | api:api_applications [2024/07/30 11:50] (current) – external edit 127.0.0.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..16384, 16384 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..32768, 32768 being the default). If the ''expand'' parameter is used, the limit is 8192. | | |
| | ''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] | |
| |
| * // Note [2]: This limits selection to applications that have been submitted, since offers (initially in "Unreplied" status) will be created while submitting an application. An application may contain any number of courses, but they will be turned into offers only at submission. This also applies to edits made after submission. For example an applicant may add a course after submission, but the corresponding offer will appear only after submission. // | * // Note [2]: This limits selection to applications that have been submitted, since offers (initially in "Unreplied" status) will be created while submitting an application. An application may contain any number of courses, but they will be turned into offers only at submission. This also applies to edits made after submission. For example an applicant may add a course after submission, but the corresponding offer will appear only after submission. // |
| * // Note [3]: Currently only one flag ID can be listed. This limitation will be lifted at a later date. // | * // Note [3]: Currently only one flag ID can be listed. This limitation will be lifted at a later date. // |
| * // Note [4]: Some elements in the returned objects are links to other API calls. Using the ''expand'' parameter, it is possible to expand this data to the actual records, saving additional API calls. The full list of possible expansions is ''applicant,flags,courses,offers,documents,studyplans''. You can set one or multiple expansions, combining them in a comma-separated fashion to the ''expand'' parameter. Note also that using this parameter caps to ''limit'' to 512 due to performance reasons.// | * // Note [4]: Some elements in the returned objects are links to other API calls. Using the ''expand'' parameter, it is possible to expand this data to the actual records, saving additional API calls. The full list of possible expansions is ''applicant,flags,courses,offers,documents,tasks,scores''. You can set one or multiple expansions, combining them in a comma-separated fashion to the ''expand'' parameter. Note also that using this parameter caps to ''limit'' to 8192 due to performance reasons.// |
| ==== Response headers ==== | ==== Response headers ==== |
| |
| "offers": "/api/applications/16/offers", | "offers": "/api/applications/16/offers", |
| "exports": "/api/applications/16/exports", | "exports": "/api/applications/16/exports", |
| "documents": "/api/applications/16/documents", | "documents": "/api/applications/16/documents" |
| "studyplans": "/api/applications/16/studyplans" | |
| } | } |
| } | } |