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

Apr 17, 2025

prod
0.4.1
Compare
0.4.1

API structure has changed

44 structure changes including:
1 Breaking change
18 Additions
26 Modifications
Modified 26 Breaking
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
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
GET /v1/seasons/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • registrationFeeTaxRateId, maxRegistrationFee, createdAt, updatedAt, archivedAt properties Modified
          • Properties are now required
            Breaking
        • additionalFees property Modified
        • enableRegistrationFees, RegistrationFeeDto, pricingPlans properties Added
GET /v1/seasons/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • registrationFeeTaxRateId, maxRegistrationFee, createdAt, updatedAt, archivedAt properties Modified
        • Properties are now required
          Breaking
      • additionalFees property Modified
        • maxAmountPerFamily, taxRateId properties Added
      • enableRegistrationFees, RegistrationFeeDto, pricingPlans properties Added
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/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
POST /v1/enrolments/
  • Body
  • application/json content type Modified
    • pricingPlanId property Added
  • 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
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
POST /v1/payment-links/{paymentLinkId}/process
  • Response
  • 200 response Modified
    • application/json content type Modified
      • company property Modified
        • settings property Modified
POST /v1/seasons/
  • Body
  • application/json content type Modified
    • registrationOpen, registrationFee, maxRegistrationFee, registrationFeeTaxRateId properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • enableRegistrationFees, PricingModel, additionalFees, pricingPlans properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • registrationFeeTaxRateId, maxRegistrationFee, createdAt, updatedAt, archivedAt properties Modified
        • Properties are now required
          Breaking
      • additionalFees property Modified
        • maxAmountPerFamily, taxRateId properties Added
      • enableRegistrationFees, RegistrationFeeDto, pricingPlans properties Added
POST /v1/seasons/{id}/archive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • registrationFeeTaxRateId, maxRegistrationFee, createdAt, updatedAt, archivedAt properties Modified
        • Properties are now required
          Breaking
      • additionalFees property Modified
        • maxAmountPerFamily, taxRateId properties Added
      • enableRegistrationFees, RegistrationFeeDto, pricingPlans properties Added
POST /v1/seasons/{id}/enrolment-status
  • Response
  • 200 response Modified
    • application/json content type Modified
      • registrationFeeTaxRateId, maxRegistrationFee, createdAt, updatedAt, archivedAt properties Modified
        • Properties are now required
          Breaking
      • additionalFees property Modified
        • maxAmountPerFamily, taxRateId properties Added
      • enableRegistrationFees, RegistrationFeeDto, pricingPlans properties Added
POST /v1/seasons/{id}/restore
  • Response
  • 200 response Modified
    • application/json content type Modified
      • registrationFeeTaxRateId, maxRegistrationFee, createdAt, updatedAt, archivedAt properties Modified
        • Properties are now required
          Breaking
      • additionalFees property Modified
        • maxAmountPerFamily, taxRateId properties Added
      • enableRegistrationFees, RegistrationFeeDto, pricingPlans properties Added
POST /v1/seasons/{id}/unarchive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • registrationFeeTaxRateId, maxRegistrationFee, createdAt, updatedAt, archivedAt properties Modified
        • Properties are now required
          Breaking
      • additionalFees property Modified
        • maxAmountPerFamily, taxRateId properties Added
      • enableRegistrationFees, RegistrationFeeDto, pricingPlans properties Added
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
PUT /v1/seasons/{id}
  • Verb went from PATCH to PUT (same operationId)
    Breaking
  • Body
  • application/json content type Modified
    • name, startAt, endAt, pricingScheme properties Modified
      • Properties are now required
        Breaking
    • registrationOpen, registrationFee, maxRegistrationFee, registrationFeeTaxRateId properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • enableRegistrationFees, PricingModel, additionalFees, pricingPlans properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • registrationFeeTaxRateId, maxRegistrationFee, createdAt, updatedAt, archivedAt properties Modified
        • Properties are now required
          Breaking
      • additionalFees property Modified
        • maxAmountPerFamily, taxRateId properties Added
      • enableRegistrationFees, RegistrationFeeDto, pricingPlans properties Added
GET /v1/billing/{familyId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • discounts property Modified
  • Query
  • pricingPlanId query parameter Added
GET /v1/basket/{familyId}/quote
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Type went from array[object] to object
        Breaking
      • registrationFees, seasons, summary properties Added
GET /v1/auth/accounts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • CompanyDto property Modified
GET /v1/attendees
  • Response
  • 200 response Modified
    • application/json content type Modified
      • makeUpLessons property Added
Added 18
GET /v1/feature-flags/
GET /v1/feature-flags/all
GET /v1/make-up-lessons/
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
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
POST /v1/seasons/{id}/pricing-scheme
PUT /v1/enrolments