MatchedStudent PropertiesProvincial Approach to Student Information API

The MatchedStudent type exposes the following members.

Properties

  NameDescription
Public propertyAddresses
A list of addresses for the student
Public propertyBirthDate
(Required) The date the student was born
Public propertyHasDisclosureRestriction
(Required) The student has a disclosure restriction, if one or more disclosure restrictions are active not considering the effective or expiry date of the record
Public propertyIsDeactivated
(Required) True if the StateProvinceId has been deactivated
Public propertyIsDeceased
(Required) True if the student is deceased
Public propertyLegalNameRefId
(Required) The unique identifier for the legal name on the student's identity
Public propertyPreferredNameRefId
(Required) The unique identifier for the name the person prefers to be called. This can be an alias or the student's identity.
Public propertyPrimaryStateProvinceId
The primary StateProvinceId this student profile is linked to
Public propertyRank
(Required) The probability of this match
Public propertySchoolEnrolments
The last two school enrolments for the student
Public propertySecondaryStateProvinceIds
A list of secondary StateProvinceIds linked to this student profile
Public propertyStateProvinceId
(Required) The primary StateProvinceId for the student, otherwise known as the Alberta Student Number (ASN)
Public propertyStudentNames
(Required) A list of names for the student
Top
See Also

Reference