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

Changelog

Last update:
Compare
4 structure changes including:
4 Modifications
Modified 4 Breaking
GET /v1/courses/
  • Query
  • sort query parameter Modified
    • dayOfWeek query parameter Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • page, pageSize, selectAll query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /v1/families/
  • Query
  • sort query parameter Modified
    • createdAt query parameter Added
GET /v1/staff/
  • Query
  • sort query parameter Modified
    • createdAt query parameter Added
GET /v1/students/
  • Query
  • sort query parameter Modified
    • createdAt query parameter Added
8 structure changes including:
8 Modifications
Modified 8 Breaking
GET /v1/auth/accounts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • CompanyDto property Modified
GET /v1/companies/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • settings property Modified
GET /v1/company/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • general property Modified
GET /v1/company/{slug}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • general property Modified
PATCH /v1/company/settings
  • Body
  • application/json content type Modified
    • general property Modified
      • industry property Modified
        • Type went from string | null to string
          Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • general property Modified
PATCH /v1/company/settings/look-and-feel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • general property Modified
PUT /v1/company
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • general property Modified
PUT /v1/company/address
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • general property Modified
8 structure changes including:
8 Modifications
Modified 8
GET /v1/auth/accounts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • CompanyDto property Modified
GET /v1/companies/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • settings property Modified
GET /v1/company/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • general property Modified
GET /v1/company/{slug}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • general property Modified
PATCH /v1/company/settings
  • Body
  • application/json content type Modified
    • general property Modified
      • CompanyIndustry property Modified
        • Type went from string to string | null
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • general property Modified
PATCH /v1/company/settings/look-and-feel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • general property Modified
PUT /v1/company
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • general property Modified
PUT /v1/company/address
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • general property Modified
1 structure change including:
1 Modification
Modified 1
GET /v1/attendances/stats
  • Query
  • lessons query parameter Modified
    • Query parameter is no longer required
  • courseId query parameter Added
1 structure change including:
1 Breaking change
1 Modification
Modified 1 Breaking
DELETE /v1/files/for-entity/{entityId}/{purpose}
  • Path went from /v1/files/{entityId}/{purpose} to /v1/files/for-entity/{entityId}/{purpose} (same operationId)
    Breaking