Both sides previous revisionPrevious revisionNext revision | Previous revision |
api:manual [2025/03/28 22:20] – [Version 6] Lauri | api:manual [2025/05/26 13:19] (current) – [List of API calls] Lauri |
---|
| 3 | Supported (default *) | | | 3 | Supported (default *) | |
| 4 | Supported | | | 4 | Supported | |
| 5 | Supported (latest, recommended) | | | 5 | Supported | |
| 6 | Not yet released | | | 6 | Supported (latest, recommended) | |
| |
* By default, version 3 of the API is used for all requests. | * By default, version 3 of the API is used for all requests. |
| [[api:/api/applicants/trackers/ID|/api/applicants/trackers/ID]] | R | DELETE | Delete a tracker, removing it from all applicants | | | [[api:/api/applicants/trackers/ID|/api/applicants/trackers/ID]] | R | DELETE | Delete a tracker, removing it from all applicants | |
| [[api:/api/applicants/ID/notes|/api/applicants/ID/notes]] | R | GET HEAD | Get the notes on the applicant | | | [[api:/api/applicants/ID/notes|/api/applicants/ID/notes]] | R | GET HEAD | Get the notes on the applicant | |
| [[api:/api/applicants/ID/notes|/api/applicants/ID/notes]] | R | PATCH | Append to existing applicant notes | | | [[api:/api/applicants/ID/notes|/api/applicants/ID/notes]] | R | POST | Create a new applicant note | |
| | [[api:/api/applicants/ID/notes/ID|/api/applicants/ID/notes/ID]] | R | GET HEAD | Get information about a specific applicant note | |
| | [[api:/api/applicants/ID/notes/ID|/api/applicants/ID/notes/ID]] | R | PUT | Update a specific applicant note | |
| [[api:/api/applications|/api/applications]] | C | GET HEAD | Get a list of applications that match the set filtering criterion | | | [[api:/api/applications|/api/applications]] | C | GET HEAD | Get a list of applications that match the set filtering criterion | |
| [[api:/api/applications/ID|/api/applications/ID]] | R | GET HEAD | Get the application contents (data input by the application). | | | [[api:/api/applications/ID|/api/applications/ID]] | R | GET HEAD | Get the application contents (data input by the application). | |
| [[api:/api/applications/ID/offers/ID/decision|/api/applications/ID/offers/ID/decision]] | R | PUT | Set the decision of the application offer in question | | | [[api:/api/applications/ID/offers/ID/decision|/api/applications/ID/offers/ID/decision]] | R | PUT | Set the decision of the application offer in question | |
| [[api:/api/applications/ID/offers/ID/notes|/api/applications/ID/offers/ID/notes]] | R | GET HEAD | Get the notes on the offer | | | [[api:/api/applications/ID/offers/ID/notes|/api/applications/ID/offers/ID/notes]] | R | GET HEAD | Get the notes on the offer | |
| [[api:/api/applications/ID/offers/ID/notes|/api/applications/ID/offers/ID/notes]] | R | PATCH | Append to existing offer notes | | | [[api:/api/applications/ID/offers/ID/notes|/api/applications/ID/offers/ID/notes]] | R | POST | Create a new offer note | |
| | [[api:/api/applications/ID/offers/ID/notes/ID|/api/applications/ID/offers/ID/notes/ID]] | R | GET HEAD | Get information about a specific offer note | |
| | [[api:/api/applications/ID/offers/ID/notes/ID|/api/applications/ID/offers/ID/notes/ID]] | R | PUT | Update a specific offer note | |
| [[api:/api/applications/ID/offers/ID/score/extra|/api/applications/ID/offers/ID/score/extra]] | R | GET HEAD | Get the extra score of a specific application offer | | | [[api:/api/applications/ID/offers/ID/score/extra|/api/applications/ID/offers/ID/score/extra]] | R | GET HEAD | Get the extra score of a specific application offer | |
| [[api:/api/applications/ID/offers/ID/score/extra|/api/applications/ID/offers/ID/score/extra]] | R | PUT | Set the extra score of the application offer in question | | | [[api:/api/applications/ID/offers/ID/score/extra|/api/applications/ID/offers/ID/score/extra]] | R | PUT | Set the extra score of the application offer in question | |
| |
* The calls ''PUT /api/applicants/ID/notes'' and ''PUT /api/applications/ID/offers/ID/notes'' have been discontinued. Use the POST verb instead for the same functionality of creating a new note: ''POST [[api:/api/applicants/ID/notes|/api/applicants/ID/notes]]'' or ''POST [[api:/api/applications/ID/offers/ID/notes|/api/applications/ID/offers/ID/notes]]''. For backwards compatibility, the PATCH verb is also supported, but is deprecated. | * The calls ''PUT /api/applicants/ID/notes'' and ''PUT /api/applications/ID/offers/ID/notes'' have been discontinued. Use the POST verb instead for the same functionality of creating a new note: ''POST [[api:/api/applicants/ID/notes|/api/applicants/ID/notes]]'' or ''POST [[api:/api/applications/ID/offers/ID/notes|/api/applications/ID/offers/ID/notes]]''. For backwards compatibility, the PATCH verb is also supported, but is deprecated. |
| * The calls ''GET [[api:/api/applicants/ID/notes|/api/applicants/ID/notes]]'' and ''GET [[api:/api/applications/ID/offers/ID/notes|/api/applications/ID/offers/ID/notes]]'' now return a proper collection of notes, instead of the concatenated string. |
==== Version 5 ==== | ==== Version 5 ==== |
| |