Events

The Peek endpoint [UAT | PROD] returns a number of different events. The payload data for an event varies depending on its type.

Event Type	Direction	Description
ApplicationSubmitted	Inbound	The application has been submitted to the college for the first time
ApplicationWithdrawn	Inbound	The application that was previously submitted to the college has now been withdrawn by the applicant
ApplicationPending	Inbound	The application that was previously submitted to the college is now pending an incomplete payment by the applicant and should not be considered until such time as the application is paid
ApplicationResubmitted	Inbound	Application that was previously withdrawn or pending is submitted again to the college with a new effective date
ApplicationUpdated	Inbound	There was a change to the application’s effective date, basis of admission or current student status. This event is not triggered by changes to underlying `programChoices` or `applicant` data.
ApplicationNumberChanged	Inbound	There was a change to the application’s number. This is generally only required for colleges that send OCAS a new application number after creating an application in their SIS for Late Admit applications.
ApplicantDeceased	Inbound	The application that was previously submitted to the college has now been withdrawn by OCAS after being informed the applicant is deceased.
ApplicantProfileUpdated	Inbound	Applicant has updated personal profile data including demographic data, citizenship/residency data and/or contact information
OntarioAcademicDataAdded	Inbound	Applicant has added data related to their high school academic status in Ontario
OntarioAcademicDataUpdated	Inbound	Applicant has updated data related to their high school academic status in Ontario
OntarioAcademicDataDeleted	Inbound	Applicant has removed a record related to their high school academic status in Ontario
InternationalAcademicDataAdded	Inbound	Applicant has added data related to their international evaluation
InternationalAcademicDataUpdated	Inbound	Applicant has updated data related to their international evaluation
InternationalAcademicDataDeleted	Inbound	Applicant has removed a record related to their international evaluation
ProgramChoiceAdded	Inbound	Applicant has added a program choice to the college
ProgramChoiceUpdated	Inbound	Applicant has updated a program choice that was previously submitted to the college
ProgramChoiceDeleted	Inbound	Applicant has removed a program choice to the college that was previously transmitted
EducationAdded	Inbound	Applicant has added a declared education to their application
EducationUpdated	Inbound	Applicant has updated a declared education previously added to their application
EducationDeleted	Inbound	Applicant has removed a declared education previously added to their application
SupportingDocumentAdded	Inbound	Applicant has added a supporting document to their profile
SupportingDocumentUpdated	Inbound	Applicant has updated a supporting document previously sent to the college
SupportingDocumentDeleted	Inbound	Applicant has removed a supporting document from their profile
OfferAccepted	Inbound	Applicant has accepted an offer sent by the college
OfferDeclined	Inbound	Applicant has declined an offer sent by the college, or has accepted an offer at another college
ApplicantCredentialAdded	Inbound	Applicant has added a transcript their application
ApplicantCredentialUpdated	Inbound	Applicant has updated a transcript previously added to their application
ApplicantCredentialDeleted	Inbound	Applicant has removed a transcript previously added to their application
CourseAdded	Inbound	Applicant has added a Course to their application
CourseUpdated	Inbound	Applicant has updated a Course previously added to their application
CourseDeleted	Inbound	Applicant has removed a Course previously added to their application
ApplicantProficiencyAdded	Inbound	Applicant has added a test to their application
ApplicantProficiencyUpdated	Inbound	Applicant has updated a test previously added to their application
ApplicantProficiencyDeleted	Inbound	Applicant has removed a test previously added to their application
ApplicantProficiencySubScoreAdded	Inbound	Applicant has added a test score their application
ApplicantProficiencySubScoreUpdated	Inbound	Applicant has updated a test score previously added to their application
ApplicantProficiencySubScoreDeleted	Inbound	Applicant has removed a test score previously added to their application

For reference the following mapping is provided to help understand mapping of event data with Coltrane transactions. Event to Coltrane Event Mapping

ApplicationSubmitted

Property	Type	Notes
applicationNumber	string (min 1, max 20)
applicantNumber	string (min 1, max 20)
application	Application

ApplicationWithdrawn

Property	Type	Notes
applicationNumber	string (min 1, max 20)
applicantNumber	string (min 1, max 20)
applicationId	string guid

ApplicationPending

Property	Type	Notes
applicationNumber	string (min 1, max 20)
applicantNumber	string (min 1, max 20)
applicationId	string guid

ApplicationResubmitted

Property	Type	Notes
applicationNumber	string (min 1, max 20)
applicantNumber	string (min 1, max 20)
application	Application

ApplicationUpdated

Property	Type	Notes
applicationNumber	string (min 1, max 20)
applicantNumber	string (min 1, max 20)
application	ApplicationBrief

Remarks: If the submitted value changes resulting in an ApplicationUpdated event, the new date will be copied to the ProgramChoice records triggering ProgramChoiceUpdated events

ApplicationNumberChanged

Property	Type	Notes
applicationNumber	string (min 1, max 20)
applicantNumber	string (min 1, max 20)
newApplicationNumber	string (min 1, max 20)

ApplicantDeceased

Property	Type	Notes
applicationNumber	string (min 1, max 20)
applicantNumber	string (min 1, max 20)
applicantId	string guid

ApplicantProfileUpdated

Property	Type	Notes
applicationNumber	string (min 1, max 20)
applicantNumber	string (min 1, max 20)
applicant	ApplicantBrief

OntarioAcademicDataAdded

Property	Type	Notes
applicationNumber	string (min 1, max 20)
applicantNumber	string (min 1, max 20)
ontarioAcademicData	OntarioAcademicData

OntarioAcademicDataUpdated

Property	Type	Notes
applicationNumber	string (min 1, max 20)
applicantNumber	string (min 1, max 20)
ontarioAcademicData	OntarioAcademicData

OntarioAcademicDataDeleted

Property	Type	Notes
applicationNumber	string (min 1, max 20)
applicantNumber	string (min 1, max 20)
ontarioAcademicDataId	string guid

InternationalAcademicDataAdded

Property	Type	Notes
applicationNumber	string (min 1, max 20)
applicantNumber	string (min 1, max 20)
internationalAcademicData	InternationalAcademicData

InternationalAcademicDataUpdated

Property	Type	Notes
applicationNumber	string (min 1, max 20)
applicantNumber	string (min 1, max 20)
internationalAcademicData	InternationalAcademicData

InternationalAcademicDataDeleted

Property	Type	Notes
applicationNumber	string (min 1, max 20)
applicantNumber	string (min 1, max 20)
internationalAcademicDataId	string guid

ProgramChoiceAdded

Property	Type	Notes
applicationNumber	string (min 1, max 20)
applicantNumber	string (min 1, max 20)
programChoice	ProgramChoice

ProgramChoiceUpdated

Property	Type	Notes
applicationNumber	string (min 1, max 20)
applicantNumber	string (min 1, max 20)
programChoice	ProgramChoice

ProgramChoiceDeleted

Property	Type	Notes
applicationNumber	string (min 1, max 20)
applicantNumber	string (min 1, max 20)
programChoiceId	string guid

EducationAdded

Property	Type	Notes
applicationNumber	string (min 1, max 20)
applicantNumber	string (min 1, max 20)
education	Education

EducationUpdated

Property	Type	Notes
applicationNumber	string (min 1, max 20)
applicantNumber	string (min 1, max 20)
education	Education

EducationDeleted

Property	Type	Notes
applicationNumber	string (min 1, max 20)
applicantNumber	string (min 1, max 20)
educationId	string guid

SupportingDocumentAdded

Property	Type	Notes
applicationNumber	string (min 1, max 20)
applicantNumber	string (min 1, max 20)
supportingDocument	SupportingDocument

SupportingDocumentUpdated

Property	Type	Notes
applicationNumber	string (min 1, max 20)
applicantNumber	string (min 1, max 20)
supportingDocument	SupportingDocument

SupportingDocumentDeleted

Property	Type	Notes
applicationNumber	string (min 1, max 20)
applicantNumber	string (min 1, max 20)
supportingDocumentId	string guid

OfferAccepted

Property	Type	Notes
applicationNumber	string (min 1, max 20)
applicantNumber	string (min 1, max 20)
programChoice	ProgramChoice

OfferDeclined

Property	Type	Notes
applicationNumber	string (min 1, max 20)
applicantNumber	string (min 1, max 20)
programChoiceId	string guid

ApplicantCredentialAdded

Property	Type	Notes
applicationNumber	string (min 1, max 20)
applicantNumber	string (min 1, max 20)
applicantCredential	ApplicantCredential

ApplicantCredentialUpdated

Property	Type	Notes
applicationNumber	string (min 1, max 20)
applicantNumber	string (min 1, max 20)
applicantCredential	ApplicantCredential

ApplicantCredentialDeleted

Property	Type	Notes
applicationNumber	string (min 1, max 20)
applicantNumber	string (min 1, max 20)
applicantCredentialId	string guid

CourseAdded

Property	Type	Notes
applicationNumber	string (min 1, max 20)
applicantNumber	string (min 1, max 20)
course	Course

CourseUpdated

Property	Type	Notes
applicationNumber	string (min 1, max 20)
applicantNumber	string (min 1, max 20)
course	Course

CourseDeleted

Property	Type	Notes
applicationNumber	string (min 1, max 20)
applicantNumber	string (min 1, max 20)
courseId	string guid

ApplicantProficiencyAdded

Property	Type	Notes
applicationNumber	string (min 1, max 20)
applicantNumber	string (min 1, max 20)
applicantProficiency	ApplicantProficiency

ApplicantProficiencyUpdated

Property	Type	Notes
applicationNumber	string (min 1, max 20)
applicantNumber	string (min 1, max 20)
applicantProficiency	ApplicantProficiency

ApplicantProficiencyDeleted

Property	Type	Notes
applicationNumber	string (min 1, max 20)
applicantNumber	string (min 1, max 20)
applicantProficiencyId	string guid

ApplicantProficiencySubScoreAdded

Property	Type	Notes
applicationNumber	string (min 1, max 20)
applicantNumber	string (min 1, max 20)
ApplicantProficiencySubScore	ApplicantProficiencySubScore

ApplicantProficiencySubScoreUpdated

Property	Type	Notes
applicationNumber	string (min 1, max 20)
applicantNumber	string (min 1, max 20)
ApplicantProficiencySubScore	ApplicantProficiencySubScore

ApplicantProficiencySubScoreDeleted

Property	Type	Notes
applicationNumber	string (min 1, max 20)
applicantNumber	string (min 1, max 20)
ApplicantProficiencySubScoreId	string guid

ApplicationSubmitted​

ApplicationWithdrawn​

ApplicationPending​

ApplicationResubmitted​

ApplicationUpdated​

ApplicationNumberChanged​

ApplicantDeceased​

ApplicantProfileUpdated​

OntarioAcademicDataAdded​

OntarioAcademicDataUpdated​

OntarioAcademicDataDeleted​

InternationalAcademicDataAdded​

InternationalAcademicDataUpdated​

InternationalAcademicDataDeleted​

ProgramChoiceAdded​

ProgramChoiceUpdated​

ProgramChoiceDeleted​

EducationAdded​

EducationUpdated​

EducationDeleted​

SupportingDocumentAdded​

SupportingDocumentUpdated​

SupportingDocumentDeleted​

OfferAccepted​

OfferDeclined​

ApplicantCredentialAdded​

ApplicantCredentialUpdated​

ApplicantCredentialDeleted​

CourseAdded​

CourseUpdated​

CourseDeleted​

ApplicantProficiencyAdded​

ApplicantProficiencyUpdated​

ApplicantProficiencyDeleted​

ApplicantProficiencySubScoreAdded​

ApplicantProficiencySubScoreUpdated​

ApplicantProficiencySubScoreDeleted​