Changelog
For a list of upcoming changes, see What's New.
Fall 2024 (2024-09-30)
- Add
GZZ
Course code toCourseCode
Lookup - Remove
hoa
Test Type from theTestType
Lookup - Remove the values from
TestSubType
where theTestCode
ishoa
- Updates to Offer Validation Error Codes
- Update description of
R51
- Remove codes
R58
,S01
,S02
,S03
,S04
,S05
- Update description of
Spring 2024 (2024-03-19)
Offer.intakeId
,ProgramChoice.intakeId
, andProgramChoice.offerId
are deprecated- Bug Fixes
- Fix
province
field sometimes containing invalid data (e.g.Ontario
instead ofON
) on the following eventsApplicantCredentialAdded
ApplicantCredentialUpdated
ApplicationSubmitted
ApplicationResubmitted
EducationAdded
EducationUpdated
- Fix
country
field sometimes containing invalid data on the following eventsApplicantCredentialAdded
ApplicantCredentialUpdated
ApplicationSubmitted
ApplicationResubmitted
EducationAdded
EducationUpdated
- Fix
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 nullableminItems: 0
for the following arrays on the ApplicantDto modelcredentials
proficiencies
supportingDocuments
- For POST /offers, validate that
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
- Add Ontario Education Number properties to
- Split
AcademicData
model into separate models for Ontario and International data- Remove
AcademicDataType
lookup - Add
OntarioAcademicData
model - Add
InternationalAcademicData
model - Remove
academicData
property fromApplicant
model - Add
ontarioAcademicData
property toApplicant
model - Add
internationalAcademicData
property toApplicant
model
- Remove
- 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
andApplicantProficiencySubScore
- Add
applicantCredentialId
toCourse
model - Add
applicantProficiencyId
toApplicantProficiencySubScore
model
- Add
- Introduction of
ApplicantBrief
andApplicationBrief
models to simplify update event payloads- Use
ApplicationBrief
model onApplicationUpdated
events - Use
ApplicantBrief
model onApplicantProfileUpdated
events
- Use
- Bug Fixes
- Suppress non-printable characters from
Course
events'notes
array - Separate duplicate
diploma
Supporting Document lookup value:diplomasecondary
Diploma - Secondary Schooldiplomapostsecondary
Diploma – Post-Secondary
- Suppress non-printable characters from
Fall 2022 (2022-09-13)
- Removed
EditException
deprecated field fromCourseDto
- Removed the following deprecated fields from
SupportingDocumentDto
Complete
CredentialCode
LandingDate
LandingSignature
LevelAchieved
- Added
FileName
andMimeType
toSupportingDocumentDto
- Removed
BinaryDocument
model
Summer 2022 (2022-06-18)
- Initial release to UAT