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

Changelog

Last update:
Compare
1 structure change including:
1 Modification
Modified 1 Breaking
POST /v1/payment-links/{paymentLinkId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • paymentSession property Modified
        • customerSession property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
9 structure changes including:
9 Modifications
Modified 9 Breaking
GET /v1/families/{id}/user
  • Response
  • 200 response Modified
    • application/json content type Modified
      • phone property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /v1/staff/{id}/user
  • Response
  • 200 response Modified
    • application/json content type Modified
      • phone property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /v1/users/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • phone property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
PATCH /v1/users/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • alternative Modified
        • LoginDto, UserDto alternatives Modified
POST /v1/auth/login
  • Response
  • 200 response Modified
    • application/json content type Modified
      • user property Modified
        • phone property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
POST /v1/auth/register
  • Response
  • 200 response Modified
    • application/json content type Modified
      • user property Modified
        • phone property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
POST /v1/auth/register/company
  • Response
  • 200 response Modified
    • application/json content type Modified
      • user property Modified
        • phone property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
POST /v1/auth/reset-password
  • Response
  • 200 response Modified
    • application/json content type Modified
      • user property Modified
        • phone property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
POST /v1/users/{user}/impersonate
  • Response
  • 200 response Modified
    • application/json content type Modified
      • user property Modified
        • phone property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
3 structure changes including:
3 Modifications
Modified 3
GET /v1/lessons
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /v1/lessons/{fromDate}/{toDate}
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /v1/trials/availability
  • Response
  • 200 response Modified
    • application/json content type Modified
      • lesson property Modified
3 structure changes including:
3 Modifications
Modified 3
GET /v1/lessons
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /v1/lessons/{fromDate}/{toDate}
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /v1/trials/availability
  • Response
  • 200 response Modified
    • application/json content type Modified
      • lesson property Modified
1 structure change including:
1 Addition
Added 1
GET /v1/courses/{id}/image
2 structure changes including:
2 Modifications
Modified 2
GET /v1/balances
  • Response
  • 200 response Modified
    • application/json content type Modified
      • nextScheduledPaymentDate property Added
GET /v1/families/{familyId}/balance
  • Response
  • 200 response Modified
    • application/json content type Modified
      • nextScheduledPaymentDate property Added
7 structure changes including:
7 Modifications
Modified 7
GET /v1/courses/
  • Query
  • where query parameter Modified
    • is_recurring query parameter Added
      • DateFilterSchema, TextFilterSchema, NumberFilterSchema, DecimalFilterSchema, SelectFilterSchema, MultiSelectFilterSchema, BooleanFilterSchema query parameters Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • entity property Modified
GET /v1/courses/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • entity property Modified
        • is_recurring property Added
PATCH /v1/courses/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • entity property Modified
        • is_recurring property Added
POST /v1/courses/
  • Body
  • application/json content type Modified
    • is_recurring property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • entity property Modified
        • is_recurring property Added
POST /v1/courses/{id}/archive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • entity property Modified
        • is_recurring property Added
POST /v1/courses/{id}/restore
  • Response
  • 200 response Modified
    • application/json content type Modified
      • is_recurring property Added
POST /v1/courses/{id}/unarchive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • entity property Modified
        • is_recurring property Added
2 structure changes including:
2 Modifications
Modified 2 Breaking
GET /v1/balances
  • Response
  • 200 response Modified
    • application/json content type Modified
      • beforeTransactionId property Modified
        • Property is now required
          Breaking
      • totalToPay, nextScheduledPayment properties Added
GET /v1/families/{familyId}/balance
  • Response
  • 200 response Modified
    • application/json content type Modified
      • beforeTransactionId property Modified
        • Property is now required
          Breaking
      • totalToPay, nextScheduledPayment properties Added
1 structure change including:
1 Modification
Modified 1
POST /v1/checkout
  • Response
  • 200 response Modified
    • application/json content type Modified
      • checkout property Modified
        • enrolments, dropIns, products, additionals properties Modified
6 structure changes including:
6 Modifications
Modified 6
GET /v1/contacts/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • archivedAt property Added
GET /v1/contacts/receives-additional
  • Response
  • 200 response Modified
    • application/json content type Modified
      • archivedAt property Added
GET /v1/contacts/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • archivedAt property Added
POST /v1/contacts/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • archivedAt property Added
POST /v1/contacts/{id}/restore
  • Response
  • 200 response Modified
    • application/json content type Modified
      • archivedAt property Added
PUT /v1/contacts/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • archivedAt property Added
2 structure changes including:
2 Modifications
Modified 2
POST /v1/checkout/finalise
  • Body
  • application/json content type Modified
    • enrolments property Modified
      • acceptedQuote property Modified
        • paymentPlanId property Added
POST /v1/checkout/prepare-payment
  • Body
  • application/json content type Modified
    • enrolments property Modified
      • acceptedQuote property Modified
        • paymentPlanId property Added
2 structure changes including:
2 Breaking changes
2 Modifications
Modified 2 Breaking
GET /v1/order/{id}/company-payment-start
  • Verb went from POST to GET (same operationId)
    Breaking
  • Body
  • application/json content type Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Query
  • orderItemId, date query parameters Added
GET /v1/order/{id}/family-payment-start
  • Verb went from POST to GET (same operationId)
    Breaking
  • Body
  • application/json content type Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Query
  • orderItemId, date query parameters Added
6 structure changes including:
4 Breaking changes
2 Additions
2 Modifications
2 Removals
Modified 2 Breaking
POST /v1/order/{id}/family-payment-finish
  • Path went from /v1/order/{id}/{orderItemId}/family-payment-finish/{date} to /v1/order/{id}/family-payment-finish (same operationId)
    Breaking
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
    • orderItemId, date properties Added
  • Path
  • orderItemId, date path parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /v1/order/{id}/family-payment-start
  • Path went from /v1/order/{id}/{orderItemId}/family-payment-start/{date} to /v1/order/{id}/family-payment-start (same operationId)
    Breaking
  • Verb went from GET to POST (same operationId)
    Breaking
  • Path
  • orderItemId, date path parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Body
  • application/json content type Added
Removed 2 Breaking
GET /v1/order/{id}/{orderItemId}/payment-schedule-payment-start/{date}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/order/{id}/{orderItemId}/payment-schedule-payment-finish/{date}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 2
POST /v1/order/{id}/company-payment-finish
POST /v1/order/{id}/company-payment-start
1 structure change including:
1 Modification
Modified 1
POST /v1/checkout/prepare-payment
  • Response
  • 200 response Modified
    • application/json content type Modified
      • paymentMethods property Modified
        • cardProcessingFee property Added
5 structure changes including:
4 Additions
1 Modification
Modified 1
POST /v1/payment-links/{paymentLinkId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • subtotal, processingFee, processingFeePercent, total properties Added
Added 4
GET /v1/order/{id}/{orderItemId}/family-payment-start/{date}
GET /v1/order/{id}/{orderItemId}/payment-schedule-payment-start/{date}
POST /v1/order/{id}/{orderItemId}/family-payment-finish/{date}
POST /v1/order/{id}/{orderItemId}/payment-schedule-payment-finish/{date}
22 structure changes including:
22 Modifications
Modified 22 Breaking
GET /v1/holidays/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • createdAt property Modified
          • Property is now required
            Breaking
        • updatedAt property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /v1/holidays/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • createdAt property Modified
        • Property is now required
          Breaking
      • updatedAt property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /v1/lessons
  • Response
  • 200 response Modified
    • application/json content type Modified
      • holidays property Modified
        • createdAt property Modified
          • Property is now required
            Breaking
        • updatedAt property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /v1/lessons/{fromDate}/{toDate}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • holidays property Modified
        • createdAt property Modified
          • Property is now required
            Breaking
        • updatedAt property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /v1/locations/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • archivedAt, createdAt properties Modified
          • Properties are now required
            Breaking
        • updatedAt property 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
      • archivedAt, createdAt properties Modified
        • Properties are now required
          Breaking
      • updatedAt property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /v1/rooms/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • archivedAt, createdAt properties Modified
          • Properties are now required
            Breaking
        • updatedAt property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /v1/rooms/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • archivedAt, createdAt properties Modified
        • Properties are now required
          Breaking
      • updatedAt property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /v1/trials/availability
  • Response
  • 200 response Modified
    • application/json content type Modified
      • lesson property Modified
        • holidays property Modified
POST /v1/holidays/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • createdAt property Modified
        • Property is now required
          Breaking
      • updatedAt property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /v1/holidays/{id}/restore
  • Response
  • 200 response Modified
    • application/json content type Modified
      • createdAt property Modified
        • Property is now required
          Breaking
      • updatedAt property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /v1/locations/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • archivedAt, createdAt properties Modified
        • Properties are now required
          Breaking
      • updatedAt property 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
      • archivedAt, createdAt properties Modified
        • Properties are now required
          Breaking
      • updatedAt property 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
      • archivedAt, createdAt properties Modified
        • Properties are now required
          Breaking
      • updatedAt property 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
      • archivedAt, createdAt properties Modified
        • Properties are now required
          Breaking
      • updatedAt property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /v1/rooms/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • archivedAt, createdAt properties Modified
        • Properties are now required
          Breaking
      • updatedAt property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /v1/rooms/{id}/archive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • archivedAt, createdAt properties Modified
        • Properties are now required
          Breaking
      • updatedAt property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /v1/rooms/{id}/restore
  • Response
  • 200 response Modified
    • application/json content type Modified
      • archivedAt, createdAt properties Modified
        • Properties are now required
          Breaking
      • updatedAt property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /v1/rooms/{id}/unarchive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • archivedAt, createdAt properties Modified
        • Properties are now required
          Breaking
      • updatedAt property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
PUT /v1/holidays/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • createdAt property Modified
        • Property is now required
          Breaking
      • updatedAt property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
PUT /v1/locations/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • archivedAt, createdAt properties Modified
        • Properties are now required
          Breaking
      • updatedAt property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
PUT /v1/rooms/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • archivedAt, createdAt properties Modified
        • Properties are now required
          Breaking
      • updatedAt property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking