| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| api:manual [2025/03/28 22:13] – [Version 6] Lauri | api:manual [2025/04/03 13:32] (current) – [Version 6] 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. |
| This version brings changes to the notes related API calls, related to the change made to the applicant and offer notes system. Previously, applicant and offer cards had a single large "Notes" field. It has since been expanded to be able to create multiple notes (with different colours). For backwards compatibility reasons, the API usage still remained the same up until API version 5 . For example, the ''GET /api/applicants/ID/notes'' call returns a single string concatenating all the notes together as it still remains a single big notes field. Starting from API version 6, the API semantics reflect the true nature of the notes system. | This version brings changes to the notes related API calls, related to the change made to the applicant and offer notes system. Previously, applicant and offer cards had a single large "Notes" field. It has since been expanded to be able to create multiple notes (with different colours). For backwards compatibility reasons, the API usage still remained the same up until API version 5 . For example, the ''GET /api/applicants/ID/notes'' call returns a single string concatenating all the notes together as it still remains a single big notes field. Starting from API version 6, the API semantics reflect the true nature of the notes system. |
| |
| * 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, PATCH 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 ==== |
| |