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
Class Manager

Mar 15, 2024

dev
0.0.4-dev.358
Compare
0.0.4-dev.358

API structure has changed

21 structure changes including:
2 Breaking changes
2 Additions
17 Modifications
2 Removals
Modified 17 Breaking
POST /v1/students/{id}/unarchive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • birthdate, photoConsent properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • dateOfBirth, mediaConsent, discountable properties Added
POST /v1/students/{id}/restore
  • Response
  • 200 response Modified
    • application/json content type Modified
      • birthdate, photoConsent properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • dateOfBirth, mediaConsent, discountable properties Added
POST /v1/students/{id}/archive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • birthdate, photoConsent properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • dateOfBirth, mediaConsent, discountable properties Added
POST /v1/students/
  • Body
  • application/json content type Modified
    • birthdate, photoConsent properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • dateOfBirth, mediaConsent properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • birthdate, photoConsent properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • dateOfBirth, mediaConsent, discountable properties Added
POST /v1/families/{id}/restore
  • Response
  • 200 response Modified
    • application/json content type Modified
      • students property Modified
POST /v1/families/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • students property Modified
PATCH /v1/students/{id}
  • Body
  • application/json content type Modified
    • birthdate, photoConsent properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • dateOfBirth, mediaConsent properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • birthdate, photoConsent properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • dateOfBirth, mediaConsent, discountable properties Added
PATCH /v1/families/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • students property Modified
PATCH /v1/company/settings
  • Body
  • application/json content type Modified
    • timezone, taxEnabled properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • general, tax, trial properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • timezone, taxEnabled properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • id, name, slug, email, phone, created_at, logo, settings properties Added
  • 422, 404 responses Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 403 response Added
PATCH /v1/company
  • Response
  • 200 response Modified
    • application/json content type Modified
      • address1, address2, town, state, country, postcode, timezone, locale, use12HourClock, brandColor, brandColors properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • phone, settings properties Added
GET /v1/students/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • birthdate, photoConsent properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • dateOfBirth, mediaConsent, discountable properties Added
GET /v1/students/
  • Query
  • where query parameter Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /v1/families/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • students property Modified
GET /v1/families/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /v1/company/{slug}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Added
GET /v1/company/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • address1, address2, town, state, country, postcode, timezone, locale, use12HourClock, brandColor, brandColors properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • phone, settings properties Added
GET /v1/auth/accounts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
Removed 2 Breaking
GET /v1/company/settings
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /v1/company/{slug}/settings
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 2
GET /v1/companies/
DELETE /v1/companies/{id}