Both sides previous revisionPrevious revision | Next revisionBoth sides next revision |
api:api_journal [2024/02/14 16:19] – [Parameters] Lauri Elevant | api:api_journal [2024/02/15 10:00] – [Parameters] Lauri Elevant |
---|
* // Note [3]: For backwards compatibility reasons, the default order/limit are set to "oldest-first" and 1024, respectively. In many cases, for example when polling for new events, it makes sense to fetch the last 10 items. In this case, set "order" to "newest-first" and "limit" to 10. // | * // Note [3]: For backwards compatibility reasons, the default order/limit are set to "oldest-first" and 1024, respectively. In many cases, for example when polling for new events, it makes sense to fetch the last 10 items. In this case, set "order" to "newest-first" and "limit" to 10. // |
* // 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,application,course,institution,invoice,offer,document,flag,tracker''. 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. Also note that the ''invoice'' expansion is not available when the API key is limited to an institution.// | * // 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,application,course,institution,invoice,offer,document,flag,tracker''. 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. Also note that the ''invoice'' expansion is not available when the API key is limited to an institution.// |
* // Note [5]: Some events are not associated with any applications and these filters are thus unavailable. If you choose an incompatible event while also setting the ''byAcademicTermID'' or ''byAcademicYear'' filter, an error will be returned. // | * // Note [5]: Some events are not associated with any applications and these filters are thus unavailable. If you choose an incompatible event while also setting the ''byAcademicTermID'' or ''byAcademicYear'' filter, an error will be returned.// |
| |
| |