Change Updates

Do not miss any Class Manager API changes, ever again

Subscribe to the Class Manager API changelog to be up to date on recent changes.

RSS

Dec 31, 2024

stage
0.0.14-stage.0
Compare
0.0.14-stage.0

API structure has changed

15 structure changes including:
3 Breaking changes
2 Additions
12 Modifications
1 Removal
Modified 12 Breaking
GET /v1/locations/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • openTime, closeTime properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /v1/locations/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • openTime, closeTime properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /v1/rooms/
  • Query
  • includeArchived query parameter Added
PATCH /v1/seasons/{id}
  • Body
  • application/json content type Modified
    • hasMaxRegistrationFee property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
POST /v1/families/create
  • Path went from /v1/families/ to /v1/families/create (same operationId)
    Breaking
  • Body
  • application/json content type Modified
    • name, joinedAt, primaryContactFirstname, primaryContactLastname, primaryContactEmail properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • firstname, lastname, email, phone properties Added
POST /v1/families/{id}
  • Verb went from PUT to POST (same operationId)
    Breaking
  • Body
  • application/json content type Modified
    • name, joinedAt, primaryContactFirstname, primaryContactLastname, primaryContactEmail properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • firstname, lastname, email, phone properties Added
  • Response
  • 404 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 422 response Added
POST /v1/locations/
  • Body
  • application/json content type Modified
    • openTime, closeTime properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • openTime, closeTime properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /v1/locations/{id}/archive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • openTime, closeTime properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /v1/locations/{id}/restore
  • Response
  • 200 response Modified
    • application/json content type Modified
      • openTime, closeTime properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /v1/locations/{id}/unarchive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • openTime, closeTime properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /v1/seasons/
  • Body
  • application/json content type Modified
    • hasMaxRegistrationFee property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
PUT /v1/locations/{id}
  • Body
  • application/json content type Modified
    • openTime, closeTime properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • openTime, closeTime properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
Removed 1 Breaking
POST /v1/enrolment-adjustments/extra-lesson
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 2
POST /v1/families/
PUT /v1/families/{id}