IPASIService2020IdentifyStudent Method Provincial Approach to Student Information API
The Identify Student Service enables PASI Clients representing School Authorities and/or Schools to lookup a student's State Province Id (Alberta Student Number) along with some basic student information when the student's Given Name and Birth Date are provided

Namespace: PASI.ServiceContract
Assembly: PASI.ServiceContract (in PASI.ServiceContract.dll) Version: 9.25.26.0 (9.25.26.0)
Syntax
Copy
IdentifyStudentMatchedResponse IdentifyStudent(
	IdentifyStudentRequest searchCriteria
)

Parameters

searchCriteria
Type: PASI.DataContract.V201204IdentifyStudentRequest
The SearchCriteria is a class containing a student personal information such as student name, birthdate, approximate age, address, phone, and stateprovinceId.

Return Value

Type: IdentifyStudentMatchedResponse
Contains limited information about the students found during the search. This information includes: legal name(s), aliases, partial address(es), birth date, gender and some enrolment information.

Service Validations

The following codes can be returned from the service operation. This list also shows core alerts that could be generated as a result calling this service. These codes are in addition to the standard set of codes that can be returned defined as in the Approach to Error Reporting. Click the link for the details.

No additional errors for this service.
Remarks
The Identify Student service uses a PASI search algorithm which performs searches on several types of matches such as exact match, phonetic match, partial name match and alternate name match. Further details on the search operation can be found here.

Note: enrolment information will not be available for students that have had no enrolments in the past two school years.

Request and Response Class Diagram



Request Fields

Full Property NameTypeRequiredOther Attributes
CallerInfoCallerInfoYes
CallerInfo.ClientMessageIDStringYesValue must be no more than 50 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
CallerInfo.SentUtcTimeDateTimeYes
CallerInfo.SoftwareSoftwareYes
CallerInfo.Software.BuildNumberStringYesValue must be no more than 30 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
CallerInfo.Software.ManufacturerStringYesValue must be no more than 100 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
CallerInfo.Software.ProductStringYesValue must be no more than 100 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
CallerInfo.Software.VersionStringYesValue must be no more than 30 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
CallerInfo.UserUserYes
CallerInfo.User.IPAddressStringYesValue must be no more than 50 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
CallerInfo.User.LocalIDStringYesValue must be no more than 50 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
CallerInfo.User.NameStringYesValue must be no more than 100 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
CallerInfo.User.OrganizationCodeStringYesValue must be no more than 6 characters
CallerReasonCodeStringYesValue must be 'StudentEnrolment'
IncludeAllQualityLevelsBooleanNo
IncludeStudentWithDisclosureRestrictionBooleanNo
StudentLocatorStudentLocatorYes
StudentLocator.AgeAgeCriteriaYesExactly one property value must be provided
StudentLocator.Age.ApproximateAgeInt32No
StudentLocator.Age.BirthDateDateTimeNo
StudentLocator.Age.GradeLevelStringNoValue must be an appropriate GradeCode code value
StudentLocator.ExtendedStudentCriteriaDictionary`2No
StudentLocator.NameNameCriteriaYes
StudentLocator.Name.FirstNameStringYes
StudentLocator.Name.LastNameStringYes
StudentLocator.Name.MiddleNameStringNo
StudentLocator.Name.SuffixNameStringNo
StudentLocator.StateProvinceIdStringNoValue must be in the form of a number between '000000001' and '999999999'


Response Fields

Full Property NameTypeRequiredOther Attributes
IdentifyStudentMatchedResponse.HighQualityMatchesList<MatchedStudent>No
IdentifyStudentMatchedResponse.HighQualityMatches.AddressesList<AddressSummary>No
IdentifyStudentMatchedResponse.HighQualityMatches.Addresses.AddressTypeStringYesValue must be an appropriate AddressType code value
IdentifyStudentMatchedResponse.HighQualityMatches.Addresses.CityStringYes
IdentifyStudentMatchedResponse.HighQualityMatches.Addresses.PostalCodeStringNo
IdentifyStudentMatchedResponse.HighQualityMatches.BirthDateDateTimeYes
IdentifyStudentMatchedResponse.HighQualityMatches.HasDisclosureRestrictionBooleanYes
IdentifyStudentMatchedResponse.HighQualityMatches.IsDeactivatedBooleanYes
IdentifyStudentMatchedResponse.HighQualityMatches.IsDeceasedBooleanYes
IdentifyStudentMatchedResponse.HighQualityMatches.LegalNameRefIdInt32Yes
IdentifyStudentMatchedResponse.HighQualityMatches.PreferredNameRefIdInt32Yes
IdentifyStudentMatchedResponse.HighQualityMatches.PrimaryStateProvinceIdStringNo
IdentifyStudentMatchedResponse.HighQualityMatches.RankDoubleYes
IdentifyStudentMatchedResponse.HighQualityMatches.SchoolEnrolmentsList<StudentSchoolEnrolmentSummary>No
IdentifyStudentMatchedResponse.HighQualityMatches.SchoolEnrolments.GradeStringYes
IdentifyStudentMatchedResponse.HighQualityMatches.SchoolEnrolments.RegistrationExitDateDateTimeYes
IdentifyStudentMatchedResponse.HighQualityMatches.SchoolEnrolments.RegistrationStartDateDateTimeYes
IdentifyStudentMatchedResponse.HighQualityMatches.SchoolEnrolments.SchoolSchoolSummaryYes
IdentifyStudentMatchedResponse.HighQualityMatches.SchoolEnrolments.School.CityStringYes
IdentifyStudentMatchedResponse.HighQualityMatches.SchoolEnrolments.School.NameStringYes
IdentifyStudentMatchedResponse.HighQualityMatches.SchoolEnrolments.School.SchoolCodeStringYes
IdentifyStudentMatchedResponse.HighQualityMatches.SchoolEnrolments.SchoolYearInt16No
IdentifyStudentMatchedResponse.HighQualityMatches.SecondaryStateProvinceIdsList<String>No
IdentifyStudentMatchedResponse.HighQualityMatches.StateProvinceIdStringYes
IdentifyStudentMatchedResponse.HighQualityMatches.StudentNamesList<Name>Yes
IdentifyStudentMatchedResponse.HighQualityMatches.StudentNames.FirstNameStringYesValue must be no more than 50 characters Value must only contain letters (A-Z), hyphens (-), apostrophes ('), periods (.), spaces ( ), or accented letters (ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ)
IdentifyStudentMatchedResponse.HighQualityMatches.StudentNames.LastNameStringYesValue must be no more than 50 characters Value must only contain letters (A-Z), hyphens (-), apostrophes ('), periods (.), spaces ( ), or accented letters (ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ)
IdentifyStudentMatchedResponse.HighQualityMatches.StudentNames.LastUpdateUtcTimeDateTimeNo
IdentifyStudentMatchedResponse.HighQualityMatches.StudentNames.MiddleNameStringNoValue must be no more than 50 characters Value must only contain letters (A-Z), hyphens (-), apostrophes ('), periods (.), spaces ( ), or accented letters (ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ)
IdentifyStudentMatchedResponse.HighQualityMatches.StudentNames.RefIdInt32Yes
IdentifyStudentMatchedResponse.HighQualityMatches.StudentNames.SuffixStringNoValue must be no more than 15 characters Value must only contain letters (A-Z), hyphens (-), apostrophes ('), periods (.), spaces ( ), or accented letters (ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ)
IdentifyStudentMatchedResponse.LowQualityMatchesList<MatchedStudent>No
IdentifyStudentMatchedResponse.LowQualityMatches.AddressesList<AddressSummary>No
IdentifyStudentMatchedResponse.LowQualityMatches.Addresses.AddressTypeStringYesValue must be an appropriate AddressType code value
IdentifyStudentMatchedResponse.LowQualityMatches.Addresses.CityStringYes
IdentifyStudentMatchedResponse.LowQualityMatches.Addresses.PostalCodeStringNo
IdentifyStudentMatchedResponse.LowQualityMatches.BirthDateDateTimeYes
IdentifyStudentMatchedResponse.LowQualityMatches.HasDisclosureRestrictionBooleanYes
IdentifyStudentMatchedResponse.LowQualityMatches.IsDeactivatedBooleanYes
IdentifyStudentMatchedResponse.LowQualityMatches.IsDeceasedBooleanYes
IdentifyStudentMatchedResponse.LowQualityMatches.LegalNameRefIdInt32Yes
IdentifyStudentMatchedResponse.LowQualityMatches.PreferredNameRefIdInt32Yes
IdentifyStudentMatchedResponse.LowQualityMatches.PrimaryStateProvinceIdStringNo
IdentifyStudentMatchedResponse.LowQualityMatches.RankDoubleYes
IdentifyStudentMatchedResponse.LowQualityMatches.SchoolEnrolmentsList<StudentSchoolEnrolmentSummary>No
IdentifyStudentMatchedResponse.LowQualityMatches.SchoolEnrolments.GradeStringYes
IdentifyStudentMatchedResponse.LowQualityMatches.SchoolEnrolments.RegistrationExitDateDateTimeYes
IdentifyStudentMatchedResponse.LowQualityMatches.SchoolEnrolments.RegistrationStartDateDateTimeYes
IdentifyStudentMatchedResponse.LowQualityMatches.SchoolEnrolments.SchoolSchoolSummaryYes
IdentifyStudentMatchedResponse.LowQualityMatches.SchoolEnrolments.School.CityStringYes
IdentifyStudentMatchedResponse.LowQualityMatches.SchoolEnrolments.School.NameStringYes
IdentifyStudentMatchedResponse.LowQualityMatches.SchoolEnrolments.School.SchoolCodeStringYes
IdentifyStudentMatchedResponse.LowQualityMatches.SchoolEnrolments.SchoolYearInt16No
IdentifyStudentMatchedResponse.LowQualityMatches.SecondaryStateProvinceIdsList<String>No
IdentifyStudentMatchedResponse.LowQualityMatches.StateProvinceIdStringYes
IdentifyStudentMatchedResponse.LowQualityMatches.StudentNamesList<Name>Yes
IdentifyStudentMatchedResponse.LowQualityMatches.StudentNames.FirstNameStringYesValue must be no more than 50 characters Value must only contain letters (A-Z), hyphens (-), apostrophes ('), periods (.), spaces ( ), or accented letters (ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ)
IdentifyStudentMatchedResponse.LowQualityMatches.StudentNames.LastNameStringYesValue must be no more than 50 characters Value must only contain letters (A-Z), hyphens (-), apostrophes ('), periods (.), spaces ( ), or accented letters (ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ)
IdentifyStudentMatchedResponse.LowQualityMatches.StudentNames.LastUpdateUtcTimeDateTimeNo
IdentifyStudentMatchedResponse.LowQualityMatches.StudentNames.MiddleNameStringNoValue must be no more than 50 characters Value must only contain letters (A-Z), hyphens (-), apostrophes ('), periods (.), spaces ( ), or accented letters (ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ)
IdentifyStudentMatchedResponse.LowQualityMatches.StudentNames.RefIdInt32Yes
IdentifyStudentMatchedResponse.LowQualityMatches.StudentNames.SuffixStringNoValue must be no more than 15 characters Value must only contain letters (A-Z), hyphens (-), apostrophes ('), periods (.), spaces ( ), or accented letters (ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ)
IdentifyStudentMatchedResponse.MediumQualityMatchesList<MatchedStudent>No
IdentifyStudentMatchedResponse.MediumQualityMatches.AddressesList<AddressSummary>No
IdentifyStudentMatchedResponse.MediumQualityMatches.Addresses.AddressTypeStringYesValue must be an appropriate AddressType code value
IdentifyStudentMatchedResponse.MediumQualityMatches.Addresses.CityStringYes
IdentifyStudentMatchedResponse.MediumQualityMatches.Addresses.PostalCodeStringNo
IdentifyStudentMatchedResponse.MediumQualityMatches.BirthDateDateTimeYes
IdentifyStudentMatchedResponse.MediumQualityMatches.HasDisclosureRestrictionBooleanYes
IdentifyStudentMatchedResponse.MediumQualityMatches.IsDeactivatedBooleanYes
IdentifyStudentMatchedResponse.MediumQualityMatches.IsDeceasedBooleanYes
IdentifyStudentMatchedResponse.MediumQualityMatches.LegalNameRefIdInt32Yes
IdentifyStudentMatchedResponse.MediumQualityMatches.PreferredNameRefIdInt32Yes
IdentifyStudentMatchedResponse.MediumQualityMatches.PrimaryStateProvinceIdStringNo
IdentifyStudentMatchedResponse.MediumQualityMatches.RankDoubleYes
IdentifyStudentMatchedResponse.MediumQualityMatches.SchoolEnrolmentsList<StudentSchoolEnrolmentSummary>No
IdentifyStudentMatchedResponse.MediumQualityMatches.SchoolEnrolments.GradeStringYes
IdentifyStudentMatchedResponse.MediumQualityMatches.SchoolEnrolments.RegistrationExitDateDateTimeYes
IdentifyStudentMatchedResponse.MediumQualityMatches.SchoolEnrolments.RegistrationStartDateDateTimeYes
IdentifyStudentMatchedResponse.MediumQualityMatches.SchoolEnrolments.SchoolSchoolSummaryYes
IdentifyStudentMatchedResponse.MediumQualityMatches.SchoolEnrolments.School.CityStringYes
IdentifyStudentMatchedResponse.MediumQualityMatches.SchoolEnrolments.School.NameStringYes
IdentifyStudentMatchedResponse.MediumQualityMatches.SchoolEnrolments.School.SchoolCodeStringYes
IdentifyStudentMatchedResponse.MediumQualityMatches.SchoolEnrolments.SchoolYearInt16No
IdentifyStudentMatchedResponse.MediumQualityMatches.SecondaryStateProvinceIdsList<String>No
IdentifyStudentMatchedResponse.MediumQualityMatches.StateProvinceIdStringYes
IdentifyStudentMatchedResponse.MediumQualityMatches.StudentNamesList<Name>Yes
IdentifyStudentMatchedResponse.MediumQualityMatches.StudentNames.FirstNameStringYesValue must be no more than 50 characters Value must only contain letters (A-Z), hyphens (-), apostrophes ('), periods (.), spaces ( ), or accented letters (ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ)
IdentifyStudentMatchedResponse.MediumQualityMatches.StudentNames.LastNameStringYesValue must be no more than 50 characters Value must only contain letters (A-Z), hyphens (-), apostrophes ('), periods (.), spaces ( ), or accented letters (ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ)
IdentifyStudentMatchedResponse.MediumQualityMatches.StudentNames.LastUpdateUtcTimeDateTimeNo
IdentifyStudentMatchedResponse.MediumQualityMatches.StudentNames.MiddleNameStringNoValue must be no more than 50 characters Value must only contain letters (A-Z), hyphens (-), apostrophes ('), periods (.), spaces ( ), or accented letters (ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ)
IdentifyStudentMatchedResponse.MediumQualityMatches.StudentNames.RefIdInt32Yes
IdentifyStudentMatchedResponse.MediumQualityMatches.StudentNames.SuffixStringNoValue must be no more than 15 characters Value must only contain letters (A-Z), hyphens (-), apostrophes ('), periods (.), spaces ( ), or accented letters (ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ)
IdentifyStudentMatchedResponse.StatusStringYes
See Also

Reference

IPASIService2020 Interface
PASI.ServiceContract Namespace