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 21, 2024

dev
0.0.0
Compare

API structure has changed

14 structure changes including:
14 Modifications
Modified 14 Breaking
GET /v1/families/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
  • Query
  • relations query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /v1/families/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joinedAt property Modified
        • Full types went from string(date-time) | null to string(date)
          Breaking
      • archivedAt property Modified
        • Property is now required
          Breaking
      • contacts, students properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
  • Query
  • relations query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /v1/students/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /v1/students/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • family property Modified
PATCH /v1/families/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joinedAt property Modified
        • Full types went from string(date-time) | null to string(date)
          Breaking
      • archivedAt property Modified
        • Property is now required
          Breaking
      • contacts, students properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
PATCH /v1/students/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • family property Modified
POST /v1/families/
  • Body
  • application/json content type Modified
    • primaryContact property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • primaryContactFirstname, primaryContactLastname, primaryContactEmail properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joinedAt property Modified
        • Full types went from string(date-time) | null to string(date)
          Breaking
      • archivedAt property Modified
        • Property is now required
          Breaking
      • contacts, students properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /v1/families/{id}/archive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joinedAt property Modified
        • Full types went from string(date-time) | null to string(date)
          Breaking
      • archivedAt property Modified
        • Property is now required
          Breaking
      • contacts, students properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /v1/families/{id}/restore
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joinedAt property Modified
        • Full types went from string(date-time) | null to string(date)
          Breaking
      • archivedAt property Modified
        • Property is now required
          Breaking
      • contacts, students properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /v1/families/{id}/unarchive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joinedAt property Modified
        • Full types went from string(date-time) | null to string(date)
          Breaking
      • archivedAt property Modified
        • Property is now required
          Breaking
      • contacts, students properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /v1/students/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • family property Modified
POST /v1/students/{id}/archive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • family property Modified
POST /v1/students/{id}/restore
  • Response
  • 200 response Modified
    • application/json content type Modified
      • family property Modified
POST /v1/students/{id}/unarchive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • family property Modified