Upcoming Breaking API Changes
All upcoming breaking changes to the API are listed below, ordered by the effective date of the change.
2027/04/01 - Planning locations endpoint removal
The following endpoint is planned to be removed as its functionality is fully covered by another endpoint and its name collides with the new endpoints that allow planning locations on meetings or planning events via the API.
| Endpoint | Method | Originally used for | Replacement |
|---|---|---|---|
/api/v1/planning/locations | GET | Listing all meeting locations | /api/v1/meeting_locations |
Migration recommendations
Switch from /api/v1/planning/locations to /api/v1/meeting_locations, it provides the same data along with the address.
2027/04/01 - Planning event meeting_location_id field removal
The meeting_location_id field on planning events is deprecated and planned for removal. A planning event's location comes from the meeting it belongs to, and the field has never been visible or editable in Eduframe itself.
| Endpoint | Method | Change |
|---|---|---|
/api/v1/planning/events | GET | meeting_location_id removed from response |
/api/v1/planning/events/{id} | GET | meeting_location_id removed from response |
/api/v1/planning/events | POST | meeting_location_id no longer accepted |
Migration recommendations
Read the location from the planning event's meeting through /api/v1/meetings/{id} instead, and stop sending meeting_location_id when creating planning events.
TBD - Affiliations endpoints removal
The following endpoints/methods are deprecated and planned for removal:
| Endpoint | Method |
|---|---|
/api/v1/affiliations | GET |
/api/v1/affiliations | POST |
/api/v1/affiliations/{id} | PATCH |
/api/v1/affiliations/{id} | DELETE |
Migration recommendations
Switch from /api/v1/affiliations to /api/v1/organization_affiliations to ensure accurate user-organization relationships.
TBD - Get personal program elements endpoint removal
The following endpoints/methods are deprecated and planned for removal:
| Endpoint | Method |
|---|---|
/api/v1/program/personal_program_elements | GET |
For further details, refer to the API documentation or contact Eduframe support.