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
3 structure changes including:
1 Breaking change
1 Addition
2 Modifications
Modified 2 Breaking
POST /v1/seasons/
  • Body
  • application/json content type Modified
    • allowUpfrontPricingPlan, paymentStartDate, discountPercent, allowMonthlyPricingPlan, billingDayOfMonth, BillingTiming, numberOfInstallments properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • pricingPlans property Added
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
Added 1
POST /v1/seasons/{id}/pricing-scheme
1 structure change including:
1 Modification
Modified 1 Breaking
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
1 structure change including:
1 Modification
Modified 1
POST /v1/enrolments/
  • Body
  • application/json content type Modified
    • pricingPlanId property Added
1 structure change including:
1 Modification
Modified 1 Breaking
POST /v1/seasons/
  • Body
  • application/json content type Modified
    • bilingDayOfMonth property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • billingDayOfMonth property Added
1 structure change including:
1 Modification
Modified 1
POST /v1/seasons/
  • Body
  • application/json content type Modified
    • additionalFees property Modified
      • id, companyId properties Added
1 structure change including:
1 Modification
Modified 1 Breaking
POST /v1/seasons/
  • Body
  • application/json content type Modified
    • additionalFees property Modified
      • amount property Modified
        • Type went from string to integer
          Breaking
      • maxAmountPerFamily, taxRateId properties Added
1 structure change including:
1 Modification
Modified 1 Breaking
GET /v1/basket/{familyId}/quote
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pricingPlan property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • season, remainingInstalments properties Added
0.3.0-dev.12
8 structure changes including:
8 Modifications
Modified 8 Breaking
GET /v1/seasons/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • enableRegistrationFees property Added
GET /v1/seasons/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • enableRegistrationFees property Added
PATCH /v1/seasons/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • enableRegistrationFees property Added
POST /v1/seasons/
  • Body
  • application/json content type Modified
    • registrationOpen, registrationFee, maxRegistrationFee, registrationFeeTaxRateId, firstPaymentDate, paymentDay properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • enableRegistrationFees, additionalFees, allowUpfrontPricingPlan, paymentStartDate, allowMonthlyPricingPlan, bilingDayOfMonth properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • enableRegistrationFees property Added
POST /v1/seasons/{id}/archive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • enableRegistrationFees property Added
POST /v1/seasons/{id}/enrolment-status
  • Response
  • 200 response Modified
    • application/json content type Modified
      • enableRegistrationFees property Added
POST /v1/seasons/{id}/restore
  • Response
  • 200 response Modified
    • application/json content type Modified
      • enableRegistrationFees property Added
POST /v1/seasons/{id}/unarchive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • enableRegistrationFees property Added
0.3.0-dev.11
8 structure changes including:
8 Modifications
Modified 8
GET /v1/seasons/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • additionalFees property Modified
GET /v1/seasons/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • additionalFees property Modified
        • maxAmountPerFamily, taxRateId properties Added
PATCH /v1/seasons/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • additionalFees property Modified
        • maxAmountPerFamily, taxRateId properties Added
POST /v1/seasons/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • additionalFees property Modified
        • maxAmountPerFamily, taxRateId properties Added
POST /v1/seasons/{id}/archive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • additionalFees property Modified
        • maxAmountPerFamily, taxRateId properties Added
POST /v1/seasons/{id}/enrolment-status
  • Response
  • 200 response Modified
    • application/json content type Modified
      • additionalFees property Modified
        • maxAmountPerFamily, taxRateId properties Added
POST /v1/seasons/{id}/restore
  • Response
  • 200 response Modified
    • application/json content type Modified
      • additionalFees property Modified
        • maxAmountPerFamily, taxRateId properties Added
POST /v1/seasons/{id}/unarchive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • additionalFees property Modified
        • maxAmountPerFamily, taxRateId properties Added