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

Oct 1, 2024

stage
0.0.4-stage.6
Compare
0.0.4-stage.6

API structure has changed

18 structure changes including:
2 Breaking changes
9 Additions
7 Modifications
2 Removals
Modified 7 Breaking
POST /v1/basket/{familyId}/checkout
  • Body
  • application/json content type Modified
    • paymentIntentId property Modified
      • Full types went from string to string | null
POST /v1/auth/reset-password
  • Response
  • 200 response Modified
    • application/json content type Modified
      • user property Modified
        • id, firstname, lastname, email, phone, email_verified_at properties Modified
          • Properties are now required
            Breaking
POST /v1/auth/register
  • Response
  • 200 response Modified
    • application/json content type Modified
      • user property Modified
        • id, firstname, lastname, email, phone, email_verified_at properties Modified
          • Properties are now required
            Breaking
POST /v1/auth/login
  • Response
  • 200 response Modified
    • application/json content type Modified
      • user property Modified
        • id, firstname, lastname, email, phone, email_verified_at properties Modified
          • Properties are now required
            Breaking
PATCH /v1/users/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • LoginDto alternative Modified
        • user property Modified
      • UserDto alternative Modified
        • id, firstname, lastname, email, phone, email_verified_at properties Modified
          • Properties are now required
            Breaking
GET /v1/company/{slug}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • enrolment property Added
GET /v1/activity-logs/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • created_at property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • createdAt property Added
Removed 2 Breaking
GET /v1/staff/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /v1/company/teachers
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 9
POST /v1/transactions/create-credit-note
GET /v1/transactions/chart/by-charge-and-payment
GET /v1/students/count
GET /v1/students/birthdays
GET /v1/staff/{id}
GET /v1/families/count
GET /v1/enrolments/students/count
GET /v1/enrolments/chart/by-month
DELETE /v1/files/{entityId}/{purpose}