Table of Contents
Differences from the 2018 Service Endpoint
Moving to the 2019 Service Endpoint from the 2018 Service Endpoint introduces services changes that may impact:
Student Integration
The following changes will impact Student Integration.
Deprecated Services
The following services from the 2018 Service Endpoint are no longer available on the 2019 Service Endpoint.
| Service Name | Service Definition |
|---|---|
| Submit Preferred Mailing Address | Service Definition |
Renamed Services
The following services have been renamed on the 2019 Service Endpoint.
| 2018 Service Endpoint | 2019 Service Endpoint | ||
|---|---|---|---|
| Service Name | Service Definition | Service Name | Service Definition |
| Submit Mailing Address | Service Definition | Submit Student Address | Service Definition |
Service Changes
The implementation of the followings services available on the 2018 Service Endpoint has been updated on the 2019 Service Endpoint.
Get Student
The following changes have been made to the request/response of the Get Student (2019 Endpoint) service (2018 Service Defintion - 2019 Service Definition)
| Removed Attributes |
|---|
| PreferredMailingAddress including:
Replaced with StudentAddresses |
| OtherAddresses including:
Replaced with StudentAddresses |
The following attributes under ParentGuardians:
Replaced with ParentGuardians.PhysicalAddressSource |
| Updated Attributes |
|---|
| New Attributes |
|---|
StudentAddresses including:
|
The following CitizenshipStatuses attributes:
|
The following ParentGuardians attributes:
|
Get Student Personal Profile
The following changes have been made to the response of the Get Student Personal Profile service (2018 Service Defintion - 2019 Service Definition)
| Removed Attributes |
|---|
| PreferredMailingAddress including:
Replaced with StudentAddresses |
| OtherAddresses including:
Replaced with StudentAddresses |
The following attributes under ParentGuardians:
Replaced with ParentGuardians.PhysicalAddressSource |
| Updated Attributes |
|---|
| New Attributes |
|---|
StudentAddresses including:
|
The following CitizenshipStatuses attributes:
|
The following ParentGuardians attributes:
|
Get Student Status
The following changes have been made to the response of the Get Student Status service (2018 Service Defintion - 2019 Service Definition)
| Removed Attributes |
|---|
| MaxSourcePASIVersion |
| SourceStudent. PreferredMailingAddress including:
Replaced with StudentAddresses |
| SourceStudent. OtherAddresses including:
Replaced with StudentAddresses |
The following attributes under SourceStudent. ParentGuardians:
Replaced with ParentGuardians.PhysicalAddressSource |
| Updated Attributes |
|---|
| New Attributes |
|---|
SourceStudent. StudentAddresses including:
|
The following SourceStudent. CitizenshipStatuses attributes:
|
The following SourceStudent. ParentGuardians attributes:
|
Identify Student
The following changes have been made to the response of the Identify Student service (2018 Service Defintion - 2019 Service Definition)
| Removed Attributes |
|---|
CurrentIdentity including:
|
The following SchoolEnrolments attributes:
|
| Updated Attributes | ||
|---|---|---|
| CurrentIdentity. BirthDate | renamed to | BirthDate |
| StateProvinceId | is now Mandatory | |
| PreferredNameRefId | is now Mandatory | |
| StudentNames | is now Mandatory | |
| HasDisclosureRestrictions | is now Mandatory | |
| IsDeactivated | is now Mandatory | |
| IsDeceased | is now Mandatory | |
| Rank | is now Mandatory | |
| New Attributes |
|---|
| LegalNameRefId |
Submit Student Citizenship Status
The following changes have been made to the request of the Submit Student Citizenship Status service (2018 Service Defintion - 2019 Service Definition)
| Removed Attributes |
|---|
| CitizenshipStatus. LastUpdateUtcTime |
| Updated Attributes | ||
|---|---|---|
| CitizenshipStatus. RefId | renamed to | RefId |
| CitizenshipStatus. CitizenshipStatus | renamed to | CitizenshipStatus |
| CitizenshipStatus. CountryOfCitizenship | renamed to | CountryOfCitizenship |
| CitizenshipStatus. DocumentExpiryDate | renamed to | DocumentExpiryDate |
| CitizenshipStatus. EffectiveDate | renamed to | EffectiveDate |
| New Attributes |
|---|
| StudentCitizenshipDocumentRefId |
| ParentGuardianId |
| ParentGuardianCitizenshipStatus |
| ParentGuardianCitizenshipDocumentRefId |
Submit Parent Guardian
The following changes have been made to the request of the Submit Parent Guardian service (2018 Service Defintion - 2019 Service Definition)
| Removed Attributes |
|---|
| HasSamePhysicalAddressAsStudent (Replaced with PhysicalAddressSource) |
| HasSamePhysicalAddressAsParentMailing (Replaced with PhysicalAddressSource) |
| HasSamePhysicalAddressAsStudentPhysical (Replaced with PhysicalAddressSource) |
| Updated Attributes |
|---|
| New Attributes |
|---|
| PhysicalAddressSource |
The following MailingAddress attributes:
|
The following PhysicalAddress attributes:
|
Student School Enrolment Integration
The following services will impact Student School Enrolment Integration.
Deprecated Services
The following services from the 2018 Service Endpoint are no longer available on the 2019 Service Endpoint.
| Service Name | Service Definition |
|---|---|
| Get Accepted Registration Status (2019 End Point and prior) | Service Definition |
New Services
The following services are new to the 2019 Service Endpoint.
Service Changes
The implementation of the followings services available on the 2018 Service Endpoint has been updated on the 2019 Service Endpoint.
Get Student Academic Profile
The following changes have been made to the request/response of the Get Student Academic Profile service (2018 Service Defintion - 2019 Service Definition)
| Removed Attributes |
|---|
| SchoolEnrolmentRecords.RegistrationStatus |
| SchoolEnrolmentRecords.RegistrationType (Replaced with ProgrammingType and ProgrammingTimeframe) |
| ExamMarkRecords.Exam.ExamSeries |
| GedExamMarkRecords.ExamSeries |
| Updated Attributes | ||
|---|---|---|
| SchoolEnrolmentRecords. RegistrationExitDate | Is now Mandatory | |
| SchoolEnrolmentRecords. ExtendedSchoolEnrolmentInfo | Is now Optional | |
| New Attributes |
|---|
The following SchoolEnrolmentRecords attributes:
|
The following ExamMarkRecords.Exam.ExamComponents attributes:
|
ProvincialAchievementTestResults including:
|
ResponsibleSchools including:
|
Get Student School Enrolment
The following changes have been made to the response of the Get Student School Enrolment service (2018 Service Defintion - 2019 Service Definition)
| Removed Attributes |
|---|
| RegistrationStatus |
| RegistrationType |
| Updated Attributes | ||
|---|---|---|
| RegistrationExitDate | Is now Mandatory | |
| ExtendedSchoolEnrolmentInfo | Is now Optional | |
| New Attributes |
|---|
| ExitDateType |
| ProgrammingType |
| ProgrammingTimeframe |
| IsDeleted |
| AssessResponsibleSchool |
Get Student School Enrolment Audit Events
The following changes have been made to the response of the Get Student School Enrolment Audit Events service (2018 Service Defintion - 2019 Service Definition)
| Removed Attributes |
|---|
| RegistrationStatus |
| RegistrationType |
| Updated Attributes | ||
|---|---|---|
| RegistrationExitDate | Is now Mandatory | |
| ExtendedSchoolEnrolmentInfo | Is now Optional | |
| New Attributes |
|---|
| ExitDateType |
| ProgrammingType |
| ProgrammingTimeframe |
| IsDeleted |
| AssessResponsibleSchool |
Get Student School Enrolment Status
The following changes have been made to the response of the Get Student School Enrolment Status service (2018 Service Defintion - 2019 Service Definition)
| Removed Attributes |
|---|
| MaxSourcePASIVersion |
| SourceStudentSchoolEnrolment. RegistrationStatus |
| SourceStudentSchoolEnrolment. RegistrationType |
| Updated Attributes | ||
|---|---|---|
| SourceStudentSchoolEnrolment. RegistrationExitDate | Is now Mandatory | |
| SourceStudentSchoolEnrolment. ExtendedSchoolEnrolmentInfo | Is now Optional | |
| New Attributes |
|---|
| SourceStudentSchoolEnrolment. ExitDateType |
| SourceStudentSchoolEnrolment. ProgrammingType |
| SourceStudentSchoolEnrolment. ProgrammingTimeframe |
| SourceStudentSchoolEnrolment. IsDeleted |
| SourceStudentSchoolEnrolment. AssessResponsibleSchool |
Student Learning Profile Integration
The following changes may impact Student Learning Profile Integration.
Service Changes
The implementation of the followings services available on the 2018 Service Endpoint has been updated on the 2019 Service Endpoint.
Get Classroom Accommodation Status
The following changes have been made to the response of the Get Classroom Accommodation Status service (2018 Service Defintion - 2019 Service Definition)
| Removed Attributes |
|---|
| MaxSourcePASIVersion |
| Updated Attributes |
|---|
| New Attributes |
|---|
Submit Student School Enrolment
The following changes have been made to the request of the Submit Student School Enrolment service (2018 Service Defintion - 2019 Service Definition)
| Removed Attributes |
|---|
| RegistrationStatus |
| RegistrationType (Replaced with ProgrammingType and ProgrammingTimeframe) |
| Updated Attributes | ||
|---|---|---|
| RegistrationExitDate | is now Mandatory | |
| ExtendedSchoolEnrolmentInfo | is now Optional | |
| New Attributes |
|---|
| ExitDateType |
| ProgrammingType |
| ProgrammingTimeframe |
| IsDeleted |
| AssessResponsibleSchool |
Course Integration
The following changes may impact Course Integration.
Service Changes
The implementation of the followings services available on the 2018 Service Endpoint has been updated on the 2019 Service Endpoint.
Get Course
The following changes have been made to the response of the Get Course service (2018 Service Definition - 2019 Service Definition:
| Removed Attributes |
|---|
| Category |
| CourseSequence including:
|
CreditEquivalents including:
Replaced with CourseRelationships |
Credits including:
Replaced by CourseAuthorizations |
| CtsCourse including:
|
| Descriptions including:
Replaced by EnglishFullName and FrenchFullName |
| EffectiveDate (replaced by FirstSchoolYear) |
| ExpiryDate (replaced by LastSchoolYear) |
| IsLocallyDeveloped (replaced by DevelopedBy) |
| LastModifiedDate (replaced by LastPublishedUtcTime) |
LocallyDevelopedAuthorizations including:
Replaced with Course Permissions |
Pilots including:
Replaced with CoursePermissions |
PrerequisiteRules including:
Replaced with CourseRelationships |
| Updated Attributes | ||
|---|---|---|
| Subject | renamed to | SubjectCode |
| IntendedGrade | renamed to | IntendedGradeLevel |
| Evaulation | renamed to | EvaluationMethod |
| New Attributes |
|---|
| EnglishShortName |
| FrenchShortName |
| EnglishFullName |
| FrenchFullName |
| LastPublishedUtcTime |
| LastPublishedVersion |
| DisciplineCode |
| FundingTier |
| AccumulatedCreditMaximum |
| FirstPilotSchoolYear |
| LastPilotSchoolYear |
| FirstSchoolYear |
| LastSchoolYear |
| DevelopedBy |
CourseCompletionMethods including:
|
CourseAuthorizations including:
|
CoursePermissions including:
|
CourseRelationships including:
|
| CourseSeries |
High School Course Marks Integration
The following changes may impact High School Course Mark Integration.
Service Changes
The implementation of the followings services available on the 2018 Service Endpoint has been updated on the 2019 Service Endpoint.
Get Course Enrolment Status
The following changes have been made to the response of the Get Course Enrolment Status service (2018 Service Defintion - 2019 Service Definition)
| Removed Attributes |
|---|
| MaxSourcePASIVersion |
| Updated Attributes |
|---|
| New Attributes |
|---|
Get Evaluated Mark Status
The following changes have been made to the response of the Get Evaluated Mark Status service (2018 Service Defintion - 2019 Service Definition)
| Removed Attributes |
|---|
| MaxSourcePASIVersion |
| Updated Attributes |
|---|
| New Attributes |
|---|
Get Section Status
The following changes have been made to the response of the Get Section Status service (2018 Service Defintion - 2019 Service Definition)
| Removed Attributes |
|---|
| MaxSourcePASIVersion |
| Updated Attributes |
|---|
| New Attributes |
|---|
Diploma Exam Integration
The following changes may impact Diploma Exam Integration.
Service Changes
The implementation of the followings services available on the 2018 Service Endpoint has been updated on the 2019 Service Endpoint.
Get Diploma Exam
The following changes have been made to the response of the Get Diploma Exam service (2018 Service Defintion - 2019 Service Definition)
| Removed Attributes |
|---|
| Updated Attributes |
|---|
| New Attributes |
|---|
| FrenchComponentName |
Get Diploma Exam Results Statement
The following changes have been made to the request of the Get Diploma Exam Results Statement service (2018 Service Defintion - 2019 Service Definition)
| Removed Attributes |
|---|
| StudentInfos.AddressRefId |
| Updated Attributes |
|---|
| New Attributes |
|---|
Submit Diploma Exam
The following changes have been made to the request of the Submit Diploma Exam service (2018 Service Defintion - 2019 Service Definition)
| Removed Attributes |
|---|
| Updated Attributes |
|---|
| New Attributes |
|---|
| ExamComponents. FrenchComponentName |
Transcript Integration
The following changes may impact Transcript Integration.
Service Changes
The implementation of the followings services available on the 2018 Service Endpoint has been updated on the 2019 Service Endpoint.
Get Detailed Academic Report
The following changes have been made to the request of the Get Detailed Academic Report service (2018 Service Defintion - 2019 Service Definition)
| Removed Attributes |
|---|
| StudentInfos.AddressRefId |
| Updated Attributes |
|---|
| New Attributes |
|---|
Credential Integration
The following changes may impact Credential Integration.
Service Changes
The implementation of the followings services available on the 2018 Service Endpoint has been updated on the 2019 Service Endpoint.
Get Credential Requirement Checklist
The following changes have been made to the request of the Get Credential Requirement Checklist service (2018 Service Defintion - 2019 Service Definition)
| Removed Attributes |
|---|
| StudentInfos.AddressRefId |
| Updated Attributes |
|---|
| New Attributes |
|---|
Provincial Achievement Test Integration
Integration for Provincial Achievement Test information is new to the 2019 Service Endpoint.
New Services
The following services are new to the 2019 Service Endpoint.
Other Changes
The following changes do not impact any of the above areas of integration.
Deprecated Services
The following services from the 2018 Service Endpoint are no longer available on the 2019 Service Endpoint.