Skip to main content

Changelog

Releases

IR23 (TBD)

Date	Author	Notes
2024-11-27	Farzam Mohammadi	Added `pgwp-eligibility` lookup option to Offer Decline Reasons to track offers declined due to changes in Post-Graduation Work Permit (PGWP) eligibility status.
2024-11-27	Farzam Mohammadi	Added `pgwpeligibility` lookup option to Withdraw Type to track withdrawals due to changes in Post-Graduation Work Permit (PGWP) eligibility status.
2024-11-27	Dan Ayson	Added `pgwpeligibility` lookup option to Offer Revoke Type to track offer revocations due to changes in Post-Graduation Work Permit (PGWP) eligibility status.

IR21.2 (2024-08-28)

Date	Author	Notes
2024-07-23	Farzam Mohammadi	Added ApplicantAttestationLetter model.
2024-07-23	Farzam Mohammadi	Updated the inbound ApplicantProfileUpdated event to include the most recent Provincial Attestation Letters (PAL) in a new Applicant.AttestationLetters field. This list contains only the latest available PAL corresponding to the receiving college.

IR21.1 (2024-07-16)

Date	Author	Notes
2024-06-18	Farzam Mohammadi	Corrected the Philippines province name in countries.csv from `Keson` to `Quezon`. This adjustment solely affects the external documentation that was displaying the incorrect name and does not impact any internal processes, as they were already set to `Quezon`. The lookup value for `Quezon` was internally corrected in 2022. This change is purely aesthetic, and no further actions are required from users regarding this update.

IR18.2 (2023-11-06)

Date	Author	Notes
2023-11-06	Mathew Knott	Decline and Waitlist Decisions will no longer attempt to update if the decision has not changed.

IR18.1 (2023-10-25)

Date	Author	Notes
2023-09-13	Felipe Jensen	Offers may now include up to Six Payments/Deposits Dates and Amounts. Affected Models: NewOfferInfo OfferBase OfferDetails UpdateOffer Fields Added: Payments: thirdPaymentAmount thirdPaymentDate fourthPaymentAmount fourthPaymentDate fifthPaymentAmount fifthPaymentDate sixthPaymentAmount sixthPaymentDate Deposit: firstDepositAmount firstDepositDate secondDepositAmount secondDepositDate thirdDepositAmount thirdDepositDate fourthDepositAmount fourthDepositDate fifthDepositAmount fifthDepositDate sixthDepositAmount sixthDepositDate

IR18 (2023-09-19)

Date	Author	Notes
2023-08-15	Mathew Knott	Add ForeignWorkerWorkPermit SupportingDocumentType Lookups.
2023-07-19	Mathew Knott	Add 'Active' and 'Hide' Columns to Country and Province and Languages Lookups.
2023-07-17	Mathew Knott	Change program selection to use IntakeId. As part of the effort to modify program selections to now utilize the full intake, we've updated the DeclineProgramSelection and WaitlistProgramSelection schemas. For more details, refer to the API Reference documentation.

IR17 (2023-06-21)

Date	Author	Notes
2023-06-02	Farzam Mohammadi	Add new provinces to `Nepal`.
2023-03-10	Jaime Valencia	Add sendNotification flag to `RevokeOffer`.

IR16 (2023-04-04)

Date	Author	Notes
2022-12-07	Farzam Mohammadi	Add `ProgramMajor`, `ProgramMasterType`, `ProgramTeachingSubject` to `OfferAccepted`,`OfferDeclined`, `OfferDeferralRequested`, `OfferPreRegistered`, `OfferRefundRequested`, `OfferRevoked`, `OfferWithdrawn`.

IR15 (2022-12-06)

Date	Author	Notes
2022-11-23	Farzam Mohammadi	Add `TrainingSite` to `NewOfferInfo`.
2022-11-17	Farzam Mohammadi	Add `TrainingSite` to `ProgramRecommendations`.
2022-11-14	Farzam Mohammadi	Add `TrainingSite` to `offerDetails` and `ProgramSelection`.
2022-11-02	Jaime Valencia	Added West Bank, Netherlands Antilles and Gaza Strip to `CountryProvince`.

IR14 (2022-10-04)

Date	Author	Notes
2022-09-22	Felipe Jensen	Add new items to `OfferConditionType` lookup.
2022-09-22	Felipe Jensen	Add "Mx" to `NamePrefix` lookup.
2022-09-12	Jaime Valencia	Add new items to `visa` category of `SupportingDocumentType` lookup.
2022-09-12	Jaime Valencia	Change max length of first and last name in `ApplicantName` model.
2022-09-14	Jaime Valencia	Add API implementation for `GET Applications`.
2022-09-01	Farzam Mohammadi	Add new lookup `OfferDeclineReasons`.
2022-08-25	Jaime Valencia	Add `OfferDeclineReasons` to `OfferDeclined` model and additional metadata.

IR13 (2022-08-04)

Date	Author	Notes
2022-07-25	Jaime Valencia	Add additional status codes for all endpoints.
2022-07-25	Farzam Mohammadi	Add `proofofenglishasmediumofinstruction` to `SupportingDocumentType` lookup.
2022-07-09	Farzam Mohammadi	Add `campusCode` and `startDate` to `ProgramSelectionDecisionUpdated` model.
2022-05-31	Jaime Valencia	Add some documentation to use PS 7.x with Sender and Receiver clients.

IR12 (2022-03-22)

Date	Author	Notes
2022-02-28	Jaime Valencia	Add new intake availability-status endpoint (allows to change the availability status to an intake).
2022-02-17	Jaime Valencia	Add additional items to `SupportingDocumentType` lookup.
2022-02-09	Jaime Valencia	Add program metadata to `OfferDetails` model.
2022-02-09	Jaime Valencia	Add program metadata to the Applications `ProgramSelection` model.
2022-01-18	Jaime Valencia	Add additional items to `ProgramCredentialTypes` lookup.

IR11 (2021-12-07)

Date	Author	Notes
2021-11-17	Parth Mishra	Add additional item to `ProgramCredentialTypes` lookup.
2021-11-11	Jaime Valencia	Add `uniqueClientIdentifier` and `studyPermitExpiryDate` to `Applicant` model.
2021-09-29	Parth Mishra	Add hide previous offer letter flag to `UpdateOffer` model.

IR10 (2021-10-16)

Date	Author	Notes
2021-09-23	Michael Aldworth	Add `studentId` to `Offer Revoked` event.
2021-08-09	Eliza Jeyakumar	Add new lookup `ProfileUpdateType`.
2021-08-06	Jaime Valencia	Change `internationalbaccalaureate` from `university` to `secondary` on `SupportingDocumentType` lookup.
2021-07-15	Sukhpreet Bedi	Added new lookup `GradeType`.
2021-07-15	Sukhpreet Bedi	Add new item to `EducationCredentialType` lookup.
2021-07-15	Sukhpreet Bedi	Updated pathway references in `SupportingDocumentType`, `SchoolType`, `EducationCredentialType` lookups.
2021-07-08	Eliza Jeyakumar	Add `TestCodes` to `EducationAssessment` model.
2021-07-05	Eliza Jeyakumar	Add new item to `WithdrawType` lookup.
2021-06-14	Jaime Valencia	Add `AssessmentTestCodes` to `UpdateIntake`, `CreateIntake` and `IntakeFull` models.
2021-06-11	Michael Aldworth	Add `providehighschooltranscript` and `provideuniversitytranscript` to `OfferConditionType` lookup.
2021-06-07	Jaime Valencia	Add `sisSchoolIdentifier` to `ApplicantCredential` model.
2021-05-27	Jaime Valencia	Add `CustomFields` to `NewOfferInfo` and `UpdateOffer` models.
2021-05-27	Jaime Valencia	Add new pathway credential supporting documents to `SupportingDocumentType` lookup.
2021-05-17	Jaime Valencia	Add new supporting document types to `SupportingDocumentType` lookup.
2021-05-13	Daniel Ayson	Add soft deleted flag to `ApplicantCredential`, `ApplicantProficiency`, `ApplicantSupportingDocument` and `BinaryDocument` models.

IR9 (2021-06-02)

Date	Author	Notes
2021-01-12	Eliza Jeyakumar	Add new event `OfferRefundUpdated`.
2021-01-10	Jaime Valencia	Add new event `OfferDeferralUpdated`.
2020-12-10	Jaime Valencia	Add additional items to `WithdrawType` lookup.
2020-12-02	Jaime Valencia	Add new deferral and refund state.
2020-11-27	Daniel Ayson	Add additional items to `SupportingDocumentType` lookup.
2020-11-27	Jaime Valencia	Add `intakeType` and `programRecommendationReasonCode` to `EducationAssessment` model.
2020-11-27	Michael Aldworth	Add Filipino to `Language` lookup.
2020-11-12	Jaime Valencia	Add `duolingo` to `TestType` lookup.
2020-11-24	Jaime Valencia	Rename some fields in `IntakeFull` model.

IR8 (2021-03-16)

Date	Author	Notes
2020-11-12	Jaime Valencia	Add Test Type (duolingo).
2020-11-24	Jaime Valencia	Rename some columns IntakeFull model.
2020-10-21	Jaime Valencia	Add Education assessment model and lookups.
2020-10-16	Michael Aldworth	Add new fields to Intakes (IRCC).
2020-10-16	Jaime Valencia	Add Education Assessment to Application and ApplicationFull.
2020-10-16	Jaime Valencia	Add new ApplicationUserAssignment to Application and ApplicationFull models.
2020-10-16	Jaime Valencia	Add new reason to Program Recommendations.
2020-09-10	Jaime Valencia	Add docs about new static lookups.
2020-09-01	Michael Aldworth	Add SkipForDeferral to IntakeFilter.
2020-09-01	Jaime Valencia	Add StudentId to OfferDeferralRequested, OfferPreRegistered and OfferRefundRequested.

IR7 (2020-11-12)

Date	Author	Notes
2020-09-01	Jaime Valencia	Add new columns to ProgramFull and IntakeFull and some lookups.
2020-08-14	Jaime Valencia	Add StudentId to OfferAccepted, OfferDeclined, OfferWithdrawn, PreAdmitOfferAccepted and ProgramSelectionDecisionUpdated.
2020-07-23	Jaime Valencia	Application to ApplicationFull in ApplicationUpdated event and UpsertProgramRecommendation to NewProgramRecommendation.
2020-06-08	Jaime Valencia	Add new columns to ProgramRecommendation, ProgramFull and ProgramsIntakesFields.
2020-06-02	Michael Aldworth	Update endpoint specific error codes.

IR6 (2020-09-17)

Date	Author	Notes
2020-09-01	Jaime Valencia	Add new columns to ProgramFull and IntakeFull and some lookups.
2020-08-14	Jaime Valencia	Add StudentId to OfferAccepted, OfferDeclined, OfferWithdrawn, PreAdmitOfferAccepted and ProgramSelectionDecisionUpdated.
2020-07-23	Jaime Valencia	Application to ApplicationFull in ApplicationUpdated event and UpsertProgramRecommendation to NewProgramRecommendation.
2020-06-08	Jaime Valencia	Add new columns to ProgramRecommendation, ProgramFull and ProgramsIntakesFields.
2020-06-02	Michael Aldworth	Update endpoint specific error codes.

IR5 (2020-06-18)

Date	Author	Notes
2020-05-26	Jaime Valencia	Add new column to EmergencyContact model.
2020-05-26	Parth Mishra	Add SendNotification flag to WaitlistProgramSelection and DeclineProgramSelection.
2020-05-21	Jaime Valencia	Add hidden to intakes and admissionRequirementsUrl and admissionRequirementsContent to programs.
2020-05-08	Jay Dobson	Add actualCompletionDate, lengthOfStudy, province and startDate to applicantCredential.
2020-05-08	Jay Dobson	Add passportExpiryDate and passportCountryOfIssue to applicant.
2020-05-08	Parth Mishra	Add new test type (MET).
2020-04-09	Jaime Valencia	Add new EducationCredentialType items.
2020-04-03	Michael Aldworth	Add application program recommendation UpsertProgramRecommendation event and endpoint.
2020-03-25	Jay Dobson	Add campusRule for `IntakeFilterRule` and `IntakeFilterRuleBase` models; - Add `unavailable` to `EffectiveIntakeAvailabilityStatus` lookup.
2020-03-13	Mehdi Mirza	Add new OfferDeferralRequested Inbound Event.
2020-03-11	Mehdi Mirza	Add new OfferRefundRequested Inbound Event.
2020-03-06	Jaime Valencia	Adding Proof Of Payment Documents to OfferDetails.

For release details prior to IR5 please refer to our legacy Change History.