Differences

This shows you the differences between two versions of the page.

--- api:manual [2025/03/28 21:48] – [Version 5] Lauri
+++ api:manual [2025/04/03 13:32] (current) – [Version 6] Lauri
@@ Line 56: / Line 56: @@
 | 3 | Supported (default *) |
 | 4 | Supported |
-| 5 | Supported (latest, recommended) |
+| 5 | Supported |
+| 6 | Supported (latest, recommended) |
 * By default, version 3 of the API is used for all requests.
@@ Line 156: / Line 157: @@
 | [[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 | PUT | Set the notes box on an applicant card, overwriting existing |
 | [[api:/api/applicants/ID/notes|/api/applicants/ID/notes]] | R | PATCH | Append to existing applicant notes |
 | [[api:/api/applications|/api/applications]] | C | GET HEAD | Get a list of applications that match the set filtering criterion  |
@@ Line 183: / Line 183: @@
 | [[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 | PUT | Set the notes box on an offer, overwriting existing |
 | [[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/score/extra|/api/applications/ID/offers/ID/score/extra]] | R | GET HEAD | Get the extra score of a specific application offer |
@@ Line 287: / Line 286: @@
 ===== Changelog  =====
+==== Version 6 ====
+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, 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 ====
@@ Line 300: / Line 305: @@
   * The ''GET [[api:/api/applications/ID/offers|/api/applications/ID/offers]]'' call will return the full resource path (such as ''/api/applications/offers/types/123'') for the ''type'' and ''type-confirmed'' fields. Before version 4, these fields contained the name of the offer type, such as ''Accepted''.
   * The ''GET [[api:/api/applications/ID/offers/ID/type|/api/applications/ID/offers/ID/type]]'' call l will return the full resource path (such as ''/api/applications/offers/types/123'') in the response. Before version 4, the response referred to the currently set offer type using the offer type name, such as ''Accepted''.
+  * The ''GET [[api:/api/journal|/api/journal]]'' call now expects in the ''byEvents'' parameter to specify the ''Offer was edited: ?'' and ''Offer was confirmed: ?'' events using a numeric offer type ID, rather than a name, for example ''Offer was edited: 123''