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
9 structure changes including:
9 Modifications
Modified 9 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
        • enrolment property Modified
          • Property is now required
            Breaking
PATCH /v1/company/settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • enrolment property Modified
          • Property is now required
            Breaking
PATCH /v1/company/settings/look-and-feel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • enrolment property Modified
          • Property is now required
            Breaking
POST /v1/auth/register/company
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • CompanyDto property Modified
POST /v1/payment-links/{paymentLinkId}/process
  • Response
  • 200 response Modified
    • application/json content type Modified
      • company property Modified
        • settings property Modified
PUT /v1/company
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • enrolment property Modified
          • Property is now required
            Breaking
PUT /v1/company/address
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • enrolment property Modified
          • Property is now required
            Breaking
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
1 structure change including:
1 Addition
Added 1
POST /v1/order/{id}/record-stripe-payment
5 structure changes including:
5 Modifications
Modified 5
GET /v1/order/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • payments property Added
POST /v1/checkout
  • Response
  • 200 response Modified
    • application/json content type Modified
      • balance property Added
POST /v1/order/{id}/add-payment
  • Response
  • 200 response Modified
    • application/json content type Modified
      • payments property Added
POST /v1/order/{id}/cancel-item
  • Response
  • 200 response Modified
    • application/json content type Modified
      • payments property Added
POST /v1/order/{id}/charge-card-on-file
  • Response
  • 200 response Modified
    • application/json content type Modified
      • payments property Added
1 structure change including:
1 Addition
Added 1
POST /v1/shop/products/restore
9 structure changes including:
9 Modifications
Modified 9 Breaking
POST /v1/basket
  • Response
  • 200 response Modified
    • application/json content type Modified
      • basket property Modified
        • dropIns property Modified
POST /v1/basket/add-drop-in-to-basket
  • Response
  • 200 response Modified
    • application/json content type Modified
      • basket property Modified
        • dropIns property Modified
POST /v1/basket/add-enrolment-to-basket
  • Response
  • 200 response Modified
    • application/json content type Modified
      • basket property Modified
        • dropIns property Modified
POST /v1/basket/add-product-to-basket
  • Response
  • 200 response Modified
    • application/json content type Modified
      • basket property Modified
        • dropIns property Modified
POST /v1/basket/remove-drop-in-from-basket
  • Response
  • 200 response Modified
    • application/json content type Modified
      • basket property Modified
        • dropIns property Modified
POST /v1/basket/remove-enrolment-from-basket
  • Response
  • 200 response Modified
    • application/json content type Modified
      • basket property Modified
        • dropIns property Modified
POST /v1/basket/remove-product-from-basket
  • Response
  • 200 response Modified
    • application/json content type Modified
      • basket property Modified
        • dropIns property Modified
POST /v1/checkout/finalise
  • Body
  • application/json content type Modified
    • dropIns property Modified
      • basketItem property Modified
        • time property Modified
          • Type went from time to string
            Breaking
    • additionals property Modified
      • basketItem property Modified
        • type property Added
POST /v1/checkout/prepare-payment
  • Body
  • application/json content type Modified
    • enrolments property Modified
      • basketItem property Modified
        • studentId, courseId properties Modified
          • Properties are now required
            Breaking
    • dropIns property Modified
      • basketItem property Modified
        • studentId, courseId, date, type properties Modified
          • Properties are now required
            Breaking
        • time property Modified
          • Property is now required
            Breaking
          • Type went from time to string
            Breaking
    • additionals property Modified
      • basketItem property Modified
        • type property Added
1 structure change including:
1 Addition
Added 1
POST /v1/order/{id}/cancel-item
4 structure changes including:
1 Addition
3 Modifications
Modified 3
GET /v1/order/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • subs property Modified
        • items property Modified
POST /v1/order/{id}/add-payment
  • Response
  • 200 response Modified
    • application/json content type Modified
      • subs property Modified
        • items property Modified
POST /v1/order/{id}/charge-card-on-file
  • Response
  • 200 response Modified
    • application/json content type Modified
      • subs property Modified
        • items property Modified
Added 1
POST /v1/order/{id}/add-credit
1 structure change including:
1 Modification
Modified 1 Breaking
POST /v1/order/{id}/charge-card-on-file
  • Body
  • application/json content type Modified
    • paymentMethodId property Modified
      • Property is now required
        Breaking
1 structure change including:
1 Addition
Added 1
POST /v1/order/{id}/charge-card-on-file
2 structure changes including:
1 Addition
1 Modification
Modified 1
GET /v1/order/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • subs property Modified
        • items property Modified
        • paid property Added
Added 1
POST /v1/order/{id}/add-payment
4 structure changes including:
4 Modifications
Modified 4
GET /v1/shop/product-recommendations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • products property Modified
        • category property Modified
          • Type went from string to string | null
GET /v1/shop/product/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • categoryId property Modified
        • Type went from string to string | null
GET /v1/shop/products
  • Response
  • 200 response Modified
    • application/json content type Modified
      • products property Modified
        • category property Modified
          • Type went from string to string | null
POST /v1/shop/product/
  • Body
  • application/json content type Modified
    • categoryId property Modified
      • Type went from string to string | null
  • Response
  • 200 response Modified
    • application/json content type Modified
      • categoryId property Modified
        • Type went from string to string | null
1 structure change including:
1 Modification
Modified 1
GET /v1/orders
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • paid property Added
1 structure change including:
1 Modification
Modified 1
GET /v1/orders
  • Query
  • where query parameter Modified
    • familyId query parameter Added
      • DateFilterSchema, TextFilterSchema, NumberFilterSchema, DecimalFilterSchema, SelectFilterSchema, MultiSelectFilterSchema, BooleanFilterSchema query parameters Added
1 structure change including:
1 Addition
Added 1
GET /v1/feature-flags/{companyId}/get
2 structure changes including:
2 Additions
Added 2
GET /v1/students/{id}/measurements
POST /v1/students/{id}/measurements
34 structure changes including:
1 Breaking change
22 Additions
12 Modifications
Modified 12 Breaking
GET /v1/integrations/stripe/{familyId}/payment-intents/{entityId}/get
  • Path went from /v1/integrations/stripe/{familyId}/payment-intents/{transactionDetail} to /v1/integrations/stripe/{familyId}/payment-intents/{entityId}/get (same operationId)
    Breaking
  • Path
  • transactionDetail path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • entityId path parameter Added
GET /v1/transactions/
  • Query
  • where query parameter Modified
    • orderId 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
        • transaction property Modified
POST /v1/basket/{familyId}/checkout
  • Response
  • 200 response Modified
    • application/json content type Modified
      • transaction property Modified
        • orderId property Added
POST /v1/integrations/stripe/{familyId}/payment-intents/capture/{paymentIntentId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • transaction property Modified
        • orderId property Added
POST /v1/integrations/stripe/{familyId}/payment-intents/charge-payment-method
  • Response
  • 200 response Modified
    • application/json content type Modified
      • transaction property Modified
        • orderId property Added
POST /v1/integrations/stripe/{familyId}/refunds/{transactionDetailId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • transaction property Modified
        • orderId property Added
POST /v1/payment-links/{paymentLinkId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • aggregateTransaction property Modified
        • transaction property Modified
POST /v1/payment-links/{paymentLinkId}/process
  • Response
  • 200 response Modified
    • application/json content type Modified
      • debitAggregateTransaction property Modified
        • transaction property Modified
      • creditAggregateTransaction property Modified
        • transaction property Modified
POST /v1/transactions/create-custom
  • Response
  • 200 response Modified
    • application/json content type Modified
      • transaction property Modified
        • orderId property Added
POST /v1/transactions/create-from-season
  • Response
  • 200 response Modified
    • application/json content type Modified
      • transaction property Modified
        • orderId property Added
POST /v1/transactions/create-manual-payment
  • Response
  • 200 response Modified
    • application/json content type Modified
      • transaction property Modified
        • orderId property Added
POST /v1/transactions/{transaction}/create-credit-note
  • Response
  • 200 response Modified
    • application/json content type Modified
      • transaction property Modified
        • orderId property Added
Added 22
POST /v1/shop/products/archive
POST /v1/shop/product/
POST /v1/shop/category
POST /v1/order/update
POST /v1/checkout/prepare-payment
DELETE /v1/shop/category/{id}
GET /v1/order/{id}
GET /v1/orders
GET /v1/shop/category
GET /v1/shop/companyproducts
GET /v1/shop/product-recommendations
GET /v1/shop/product/{id}
GET /v1/shop/products
POST /v1/basket
POST /v1/basket/add-drop-in-to-basket
POST /v1/basket/add-enrolment-to-basket
POST /v1/basket/add-product-to-basket
POST /v1/basket/remove-drop-in-from-basket
POST /v1/basket/remove-enrolment-from-basket
POST /v1/basket/remove-product-from-basket
POST /v1/checkout
POST /v1/checkout/finalise
1 structure change including:
1 Breaking change
1 Removal
Removed 1 Breaking
POST /v1/transactions/create-from-bill
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
1 structure change including:
1 Modification
Modified 1 Breaking
GET /v1/attendances/stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • completePercent, attendancePercent properties Modified
        • Type went from integer to number(float)
          Breaking