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
6 structure changes including:
6 Modifications
Modified 6
GET /v1/order/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • totalWithCredit, totalRemaining properties Added
GET /v1/orders
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • familyId, totalTendered, totalDue, totalWithCredit, totalRemaining properties Added
POST /v1/order/{id}/add-payment
  • Response
  • 200 response Modified
    • application/json content type Modified
      • totalWithCredit, totalRemaining properties Added
POST /v1/order/{id}/cancel-item
  • Response
  • 200 response Modified
    • application/json content type Modified
      • totalWithCredit, totalRemaining properties Added
POST /v1/order/{id}/charge-card-on-file
  • Response
  • 200 response Modified
    • application/json content type Modified
      • totalWithCredit, totalRemaining properties Added
POST /v1/order/{id}/record-stripe-payment
  • Response
  • 200 response Modified
    • application/json content type Modified
      • totalWithCredit, totalRemaining properties Added
5 structure changes including:
5 Modifications
Modified 5
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}/cancel-item
  • 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
POST /v1/order/{id}/record-stripe-payment
  • Response
  • 200 response Modified
    • application/json content type Modified
      • subs property Modified
        • items property Modified
1 structure change including:
1 Modification
Modified 1 Breaking
POST /v1/company/{id}/import-data
  • Response
  • 204 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 200 response Added
2 structure changes including:
2 Breaking changes
2 Removals
Removed 2 Breaking
POST /v1/families/
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /v1/families/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
1 structure change including:
1 Addition
Added 1
POST /v1/company/{id}/import-data
1 structure change including:
1 Addition
Added 1
GET /v1/orders/family-options
3 structure changes including:
3 Modifications
Modified 3
POST /v1/order/{id}/add-payment
  • Body
  • application/json content type Modified
    • paymentScheduleDate property Added
POST /v1/order/{id}/charge-card-on-file
  • Body
  • application/json content type Modified
    • paymentScheduleDate property Added
POST /v1/order/{id}/record-stripe-payment
  • Body
  • application/json content type Modified
    • paymentScheduleDate property Added
11 structure changes including:
11 Modifications
Modified 11 Breaking
GET /v1/basket/{familyId}/quote
  • Response
  • 200 response Modified
    • application/json content type Modified
      • seasons property Modified
        • season, enabledPricingPlans properties Modified
GET /v1/seasons/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • pricingPlans property Modified
GET /v1/seasons/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pricingPlans property Modified
        • discount property Modified
          • Type went from number | null to number
            Breaking
        • paymentDay, BillingTiming properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
POST /v1/checkout
  • Response
  • 200 response Modified
    • application/json content type Modified
      • checkout property Modified
        • enrolments, dropIns, products, additionals properties Modified
POST /v1/seasons/
  • Body
  • application/json content type Modified
    • pricingPlans property Modified
      • discount property Modified
        • Type went from number | null to number
          Breaking
      • paymentDay, BillingTiming properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pricingPlans property Modified
        • discount property Modified
          • Type went from number | null to number
            Breaking
        • paymentDay, BillingTiming properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
POST /v1/seasons/{id}/archive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pricingPlans property Modified
        • discount property Modified
          • Type went from number | null to number
            Breaking
        • paymentDay, BillingTiming properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
POST /v1/seasons/{id}/enrolment-status
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pricingPlans property Modified
        • discount property Modified
          • Type went from number | null to number
            Breaking
        • paymentDay, BillingTiming properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
POST /v1/seasons/{id}/pricing-scheme
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pricingPlans property Modified
        • discount property Modified
          • Type went from number | null to number
            Breaking
        • paymentDay, BillingTiming properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
POST /v1/seasons/{id}/restore
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pricingPlans property Modified
        • discount property Modified
          • Type went from number | null to number
            Breaking
        • paymentDay, BillingTiming properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
POST /v1/seasons/{id}/unarchive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pricingPlans property Modified
        • discount property Modified
          • Type went from number | null to number
            Breaking
        • paymentDay, BillingTiming properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
PUT /v1/seasons/{id}
  • Body
  • application/json content type Modified
    • pricingPlans property Modified
      • discount property Modified
        • Type went from number | null to number
          Breaking
      • paymentDay, BillingTiming properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pricingPlans property Modified
        • discount property Modified
          • Type went from number | null to number
            Breaking
        • paymentDay, BillingTiming properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
5 structure changes including:
5 Modifications
Modified 5
GET /v1/order/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • paymentSchedules property Added
POST /v1/order/{id}/add-payment
  • Response
  • 200 response Modified
    • application/json content type Modified
      • paymentSchedules property Added
POST /v1/order/{id}/cancel-item
  • Response
  • 200 response Modified
    • application/json content type Modified
      • paymentSchedules property Added
POST /v1/order/{id}/charge-card-on-file
  • Response
  • 200 response Modified
    • application/json content type Modified
      • paymentSchedules property Added
POST /v1/order/{id}/record-stripe-payment
  • Response
  • 200 response Modified
    • application/json content type Modified
      • paymentSchedules property Added
15 structure changes including:
5 Additions
10 Modifications
Modified 10
GET /v1/courses/
  • Query
  • where query parameter Modified
    • type query parameter Added
      • DateFilterSchema, TextFilterSchema, NumberFilterSchema, DecimalFilterSchema, SelectFilterSchema, MultiSelectFilterSchema, BooleanFilterSchema query parameters Added
    • firstLessonStartDate query parameter Added
      • DateFilterSchema, TextFilterSchema, NumberFilterSchema, DecimalFilterSchema, SelectFilterSchema, MultiSelectFilterSchema, BooleanFilterSchema query parameters Added
    • lastLessonEndDate 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
        • seasonId property Modified
          • Type went from string to string | null
        • seasonName, firstLessonStartDate, lastLessonEndDate, type properties Added
GET /v1/lessons
  • Response
  • 200 response Modified
    • application/json content type Modified
      • studentCounts, studentIds properties Added
GET /v1/lessons/{fromDate}/{toDate}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • studentCounts, studentIds properties Added
GET /v1/trials/availability
  • Response
  • 200 response Modified
    • application/json content type Modified
      • lesson property Modified
        • studentCounts, studentIds properties Added
PATCH /v1/courses/{id}
  • Body
  • application/json content type Modified
    • firstLessonStartDate, lastLessonEndDate, CourseType properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • entity property Modified
        • seasonId property Modified
          • Type went from string to string | null
        • seasonName, firstLessonStartDate, lastLessonEndDate, type properties Added
POST /v1/courses/
  • Body
  • application/json content type Modified
    • seasonId property Modified
      • Property is no longer required
      • Type went from string to string | null
    • firstLessonStartDate, lastLessonEndDate, CourseType properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • entity property Modified
        • seasonId property Modified
          • Type went from string to string | null
        • seasonName, firstLessonStartDate, lastLessonEndDate, type properties Added
POST /v1/courses/{id}/archive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • entity property Modified
        • seasonId property Modified
          • Type went from string to string | null
        • seasonName, firstLessonStartDate, lastLessonEndDate, type properties Added
POST /v1/courses/{id}/restore
  • Response
  • 200 response Modified
    • application/json content type Modified
      • seasonId property Modified
        • Type went from string to string | null
      • seasonName, firstLessonStartDate, lastLessonEndDate, type properties Added
POST /v1/courses/{id}/unarchive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • entity property Modified
        • seasonId property Modified
          • Type went from string to string | null
        • seasonName, firstLessonStartDate, lastLessonEndDate, type properties Added
Added 5
DELETE /v1/drop-ins/{id}/cancel
GET /v1/drop-ins
GET /v1/drop-ins/lessons
POST /v1/drop-ins/
PUT /v1/drop-ins/{id}
5 structure changes including:
5 Modifications
Modified 5
GET /v1/order/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • subs property Modified
        • items property Modified
      • creditSum property Added
POST /v1/order/{id}/add-payment
  • Response
  • 200 response Modified
    • application/json content type Modified
      • subs property Modified
        • items property Modified
      • creditSum property Added
POST /v1/order/{id}/cancel-item
  • Response
  • 200 response Modified
    • application/json content type Modified
      • subs property Modified
        • items property Modified
      • creditSum property Added
POST /v1/order/{id}/charge-card-on-file
  • Response
  • 200 response Modified
    • application/json content type Modified
      • subs property Modified
        • items property Modified
      • creditSum property Added
POST /v1/order/{id}/record-stripe-payment
  • Response
  • 200 response Modified
    • application/json content type Modified
      • subs property Modified
        • items property Modified
      • creditSum property Added
6 structure changes including:
6 Modifications
Modified 6
GET /v1/order/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • taxAmount property Modified
        • Type went from integer to integer | null
      • subs property Modified
        • taxAmount property Modified
          • Type went from integer to integer | null
        • items property Modified
GET /v1/orders
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • taxAmount property Modified
          • Type went from integer to integer | null
POST /v1/order/{id}/add-payment
  • Response
  • 200 response Modified
    • application/json content type Modified
      • taxAmount property Modified
        • Type went from integer to integer | null
      • subs property Modified
        • taxAmount property Modified
          • Type went from integer to integer | null
        • items property Modified
POST /v1/order/{id}/cancel-item
  • Response
  • 200 response Modified
    • application/json content type Modified
      • taxAmount property Modified
        • Type went from integer to integer | null
      • subs property Modified
        • taxAmount property Modified
          • Type went from integer to integer | null
        • items property Modified
POST /v1/order/{id}/charge-card-on-file
  • Response
  • 200 response Modified
    • application/json content type Modified
      • taxAmount property Modified
        • Type went from integer to integer | null
      • subs property Modified
        • taxAmount property Modified
          • Type went from integer to integer | null
        • items property Modified
POST /v1/order/{id}/record-stripe-payment
  • Response
  • 200 response Modified
    • application/json content type Modified
      • taxAmount property Modified
        • Type went from integer to integer | null
      • subs property Modified
        • taxAmount property Modified
          • Type went from integer to integer | null
        • items property Modified
1 structure change including:
1 Addition
Added 1
POST /v1/orders