Skip to main content

Changelog

For a list of upcoming changes, see What's New.

Fall 2024 (2024-09-30)

  • Add GZZ Course code to CourseCode Lookup
  • Remove hoa Test Type from the TestType Lookup
  • Remove the values from TestSubType where the TestCode is hoa
  • Updates to Offer Validation Error Codes
    • Update description of R51
    • Remove codes R58, S01, S02, S03, S04, S05

Spring 2024 (2024-03-19)

  • Offer.intakeId, ProgramChoice.intakeId, and ProgramChoice.offerId are deprecated
  • Bug Fixes
    • Fix province field sometimes containing invalid data (e.g. Ontario instead of ON) on the following events
      • ApplicantCredentialAdded
      • ApplicantCredentialUpdated
      • ApplicationSubmitted
      • ApplicationResubmitted
      • EducationAdded
      • EducationUpdated
    • Fix country field sometimes containing invalid data on the following events
      • ApplicantCredentialAdded
      • ApplicantCredentialUpdated
      • ApplicationSubmitted
      • ApplicationResubmitted
      • EducationAdded
      • EducationUpdated

Winter 2024 (2023-11-30)

  • Bug Fixes
    • For POST /offers, validate that OfferDto.startDate falls within the start and end date of the application cycle
    • swagger.json changes
      • ApplicantDto.militaryConnected is nullable
      • minItems: 0 for the following arrays on the ApplicantDto model
        • credentials
        • proficiencies
        • supportingDocuments

Fall 2023 (2023-10-01)

  • Map Course.completionDate to the last day of the month instead of the first
  • Update documentation of HTTP response codes to explain 429 concurrent limit

Summer 2023 (2023-06-14)

  • Add error code S06 to api/v1/offers when request is malformed
  • Add api/v1/applications/{number}/offeridentifier

Spring 2023 (2023-03-06)

  • Migrate API Management Gateway to ocas.ca domains
  • Relocate Ontario Education Number properties
    • Add Ontario Education Number properties to Applicant model
    • Remove Ontario Education Number poperies from AcademicData model
  • Split AcademicData model into separate models for Ontario and International data
    • Remove AcademicDataType lookup
    • Add OntarioAcademicData model
    • Add InternationalAcademicData model
    • Remove academicData property from Applicant model
    • Add ontarioAcademicData property to Applicant model
    • Add internationalAcademicData property to Applicant model
  • Allow IsLateAdmit to be true on offer create or update

Winter 2023 (2022-12-06)

  • Introduction of API Management Gateway
    • Updated endpoint hostname
    • Introduce Subscription-Key header
  • Include parent identifiers for child records in Course and ApplicantProficiencySubScore
    • Add applicantCredentialId to Course model
    • Add applicantProficiencyId to ApplicantProficiencySubScore model
  • Introduction of ApplicantBrief and ApplicationBrief models to simplify update event payloads
    • Use ApplicationBrief model on ApplicationUpdated events
    • Use ApplicantBrief model on ApplicantProfileUpdated events
  • Bug Fixes
    • Suppress non-printable characters from Course events' notes array
    • Separate duplicate diploma Supporting Document lookup value:
      • diplomasecondary Diploma - Secondary School
      • diplomapostsecondary Diploma – Post-Secondary

Fall 2022 (2022-09-13)

  • Removed EditException deprecated field from CourseDto
  • Removed the following deprecated fields from SupportingDocumentDto
    • Complete
    • CredentialCode
    • LandingDate
    • LandingSignature
    • LevelAchieved
  • Added FileName and MimeType to SupportingDocumentDto
  • Removed BinaryDocument model

Summer 2022 (2022-06-18)

  • Initial release to UAT