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
12 structure changes including:
2 Additions
10 Modifications
Modified 10
GET /v1/families/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • autopayEnabled property Added
GET /v1/families/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • autopayEnabled property Added
POST /v1/families/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • autopayEnabled property Added
POST /v1/families/create
  • Response
  • 200 response Modified
    • application/json content type Modified
      • autopayEnabled property Added
POST /v1/families/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • autopayEnabled property Added
POST /v1/families/{id}/archive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • autopayEnabled property Added
POST /v1/families/{id}/restore
  • Response
  • 200 response Modified
    • application/json content type Modified
      • autopayEnabled property Added
POST /v1/families/{id}/unarchive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • autopayEnabled property Added
POST /v1/payment-links/{paymentLinkId}/process
  • Response
  • 200 response Modified
    • application/json content type Modified
      • family property Modified
        • autopayEnabled property Added
PUT /v1/families/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • autopayEnabled property Added
Added 2
POST /v1/families/{id}/disable-autopay
POST /v1/families/{id}/enable-autopay
3 structure changes including:
1 Addition
2 Modifications
Modified 2 Breaking
GET /v1/attendees
  • Response
  • 200 response Modified
    • application/json content type Modified
      • makeUpLessons property Added
POST /v1/make-up-lessons/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Type went from object to array[object]
        Breaking
      • id, companyId, courseId, studentId, date, time properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • MakeUpLessonDto property Added
Added 1
GET /v1/make-up-lessons/
11 structure changes including:
11 Modifications
Modified 11
GET /v1/auth/accounts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • CompanyDto property Modified
GET /v1/basket/{familyId}/quote
  • Response
  • 200 response Modified
    • application/json content type Modified
      • seasons property Modified
        • items property Modified
GET /v1/billing/{familyId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • discounts 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
        • tax property Modified
PATCH /v1/company/settings
  • Body
  • application/json content type Modified
    • tax property Modified
      • taxMode property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • tax property Modified
PATCH /v1/company/settings/look-and-feel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • tax property Modified
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
        • tax property Modified
PUT /v1/company/address
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • tax property Modified
7 structure changes including:
7 Additions
Added 7
GET /v1/reporting/course/export
GET /v1/reporting/family/export
GET /v1/reporting/staff/export
GET /v1/reporting/stats/family
GET /v1/reporting/stats/student
GET /v1/reporting/student/export
GET /v1/reporting/transaction/export
1 structure change including:
1 Addition
Added 1
GET /v1/feature-flags/all
7 structure changes including:
7 Modifications
Modified 7 Breaking
GET /v1/feature-flags/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • id, name, globallyEnabled, adminEnabled, companyEnabled properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • data property Added
POST /v1/feature-flags/{featureFlagId}/disable-by-admin
  • Path
  • featureFlagId path parameter Modified
    • Path parameter is now required
      Breaking
    • Type is now string
POST /v1/feature-flags/{featureFlagId}/disable-for-company
  • Path
  • featureFlagId path parameter Modified
    • Path parameter is now required
      Breaking
    • Type is now string
POST /v1/feature-flags/{featureFlagId}/disable-globally
  • Path
  • featureFlagId path parameter Modified
    • Path parameter is now required
      Breaking
    • Type is now string
POST /v1/feature-flags/{featureFlagId}/enable-by-admin
  • Path
  • featureFlagId path parameter Modified
    • Path parameter is now required
      Breaking
    • Type is now string
POST /v1/feature-flags/{featureFlagId}/enable-for-company
  • Path
  • featureFlagId path parameter Modified
    • Path parameter is now required
      Breaking
    • Type is now string
POST /v1/feature-flags/{featureFlagId}/enable-globally
  • Path
  • featureFlagId path parameter Modified
    • Path parameter is now required
      Breaking
    • Type is now string
7 structure changes including:
7 Additions
Added 7
GET /v1/feature-flags/
POST /v1/feature-flags/{featureFlagId}/disable-by-admin
POST /v1/feature-flags/{featureFlagId}/disable-for-company
POST /v1/feature-flags/{featureFlagId}/disable-globally
POST /v1/feature-flags/{featureFlagId}/enable-by-admin
POST /v1/feature-flags/{featureFlagId}/enable-for-company
POST /v1/feature-flags/{featureFlagId}/enable-globally
1 structure change including:
1 Modification
Modified 1 Breaking
POST /v1/basket/{familyId}/checkout
  • Body
  • application/json content type Modified
    • items property Modified
      • enrolments property Modified
        • Property is now required
          Breaking
        • pricingPlanId property Added
      • trials property Modified
        • Property is now required
          Breaking
1 structure change including:
1 Modification
Modified 1 Breaking
GET /v1/basket/{familyId}/quote
  • Response
  • 200 response Modified
    • application/json content type Modified
      • seasons property Modified
        • additionalFeeTotal property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
1 structure change including:
1 Modification
Modified 1
GET /v1/basket/{familyId}/quote
  • Response
  • 200 response Modified
    • application/json content type Modified
      • seasons property Modified
        • enabledPricingPlans property Added
1 structure change including:
1 Modification
Modified 1
GET /v1/billing/{familyId}
  • Query
  • pricingPlanId query parameter Added
1 structure change including:
1 Modification
Modified 1 Breaking
GET /v1/basket/{familyId}/quote
  • Response
  • 200 response Modified
    • application/json content type Modified
      • registrationFees property Modified
        • name, registrationFeeId properties Added
      • seasons property Modified
        • season, remainingInstalments properties Modified
          • Properties are now required
            Breaking
        • additionalFeeTotal, proRatedTotal properties Added
10 structure changes including:
10 Modifications
Modified 10
GET /v1/basket/{familyId}/quote
  • Response
  • 200 response Modified
    • application/json content type Modified
      • seasons property Modified
        • season property 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
        • enabled property Added
POST /v1/seasons/
  • Body
  • application/json content type Modified
    • pricingPlans property Modified
      • enabled property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pricingPlans property Modified
        • enabled property Added
POST /v1/seasons/{id}/archive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pricingPlans property Modified
        • enabled property Added
POST /v1/seasons/{id}/enrolment-status
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pricingPlans property Modified
        • enabled property Added
POST /v1/seasons/{id}/pricing-scheme
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pricingPlans property Modified
        • enabled property Added
POST /v1/seasons/{id}/restore
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pricingPlans property Modified
        • enabled property Added
POST /v1/seasons/{id}/unarchive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pricingPlans property Modified
        • enabled property Added
PUT /v1/seasons/{id}
  • Body
  • application/json content type Modified
    • pricingPlans property Modified
      • enabled property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pricingPlans property Modified
        • enabled property Added
1 structure change including:
1 Addition
Added 1
PUT /v1/enrolments
4 structure changes including:
4 Modifications
Modified 4
GET /v1/enrolments/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • enrolment property Modified
GET /v1/enrolments/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • startAt, endAt properties Added
POST /v1/enrolments/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • startAt, endAt properties Added
POST /v1/enrolments/{id}/restore
  • Response
  • 200 response Modified
    • application/json content type Modified
      • startAt, endAt properties Added
10 structure changes including:
10 Modifications
Modified 10
GET /v1/basket/{familyId}/quote
  • Response
  • 200 response Modified
    • application/json content type Modified
      • seasons property Modified
        • season property 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
        • BillingTiming property Modified
          • Type went from string to string | null
POST /v1/seasons/
  • Body
  • application/json content type Modified
    • pricingPlans property Modified
      • BillingTiming property Modified
        • Type went from string to string | null
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pricingPlans property Modified
        • BillingTiming property Modified
          • Type went from string to string | null
POST /v1/seasons/{id}/archive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pricingPlans property Modified
        • BillingTiming property Modified
          • Type went from string to string | null
POST /v1/seasons/{id}/enrolment-status
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pricingPlans property Modified
        • BillingTiming property Modified
          • Type went from string to string | null
POST /v1/seasons/{id}/pricing-scheme
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pricingPlans property Modified
        • BillingTiming property Modified
          • Type went from string to string | null
POST /v1/seasons/{id}/restore
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pricingPlans property Modified
        • BillingTiming property Modified
          • Type went from string to string | null
POST /v1/seasons/{id}/unarchive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pricingPlans property Modified
        • BillingTiming property Modified
          • Type went from string to string | null
PUT /v1/seasons/{id}
  • Body
  • application/json content type Modified
    • pricingPlans property Modified
      • BillingTiming property Modified
        • Type went from string to string | null
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pricingPlans property Modified
        • BillingTiming property Modified
          • Type went from string to string | null
10 structure changes including:
10 Modifications
Modified 10
GET /v1/basket/{familyId}/quote
  • Response
  • 200 response Modified
    • application/json content type Modified
      • seasons property Modified
        • season property 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
        • billingTiming property Added
POST /v1/seasons/
  • Body
  • application/json content type Modified
    • pricingPlans property Modified
      • billingTiming property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pricingPlans property Modified
        • billingTiming property Added
POST /v1/seasons/{id}/archive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pricingPlans property Modified
        • billingTiming property Added
POST /v1/seasons/{id}/enrolment-status
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pricingPlans property Modified
        • billingTiming property Added
POST /v1/seasons/{id}/pricing-scheme
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pricingPlans property Modified
        • billingTiming property Added
POST /v1/seasons/{id}/restore
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pricingPlans property Modified
        • billingTiming property Added
POST /v1/seasons/{id}/unarchive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pricingPlans property Modified
        • billingTiming property Added
PUT /v1/seasons/{id}
  • Body
  • application/json content type Modified
    • pricingPlans property Modified
      • billingTiming property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pricingPlans property Modified
        • billingTiming property Added