Table of Contents
Get Student Personal Profile (2020 Endpoint and Prior)
This PASI Core Service is used to retrieve demographic information for a single student based on the provided Alberta Student Number. The amount of information returned will be controlled based on the requestor's Student Association.
This version of the service is available starting with the 2020 Service Endpoint1).
Security
This Get Student Personal Profile service can be accessed by systems with the K-12 Organization Client role.
Request Information
A request to use this service will include (* denotes mandatory information):
- Is a Limited Profile Request
- The Alberta Student Number for the student being requested
Request Validations
The following rules are used to validate the information provided in the request:
Service Functionality
The Alberta Student Number supplied to the service is validated and upon completion of validation the service returns the demographic information for the requested ASN.
The service will return the type of Student Association used for the PASI Client's Organization to return information on the student. The returned information is filtered by the requestor's association.
- If the request did not specifically request a Limited Profile and is associated By Ministry, By Student Creation, By Current School Enrolment or By Last School Enrolment to the student then a Full Profile will be returned.
- If the request specifically requested a Limited Profile then a Limited Profile will be returned regardless of the type of association to the student.
- If the request is not associated to the student or associated By Recent School Enrolment or By Exam Registration a limited profile will be returned.
Response Information
The following Student data is returned in the response to the service:
| Alberta Student Number Information | ||
|---|---|---|
| Alberta Student Number | ||
| Primary Alberta Student Number | The Alberta Student Number of the Student referenced as the Primary Student | |
| Secondary Alberta Student Numbers | A list of the Alberta Student Numbers of the Students referenced as Secondary Students | |
| Is Deactivated | ||
| Organization Association Information | ||
| Is Associated | ||
| Association Type To Student | The Association Type of the Associated Organization record for PASI Client. | |
| Demographic Information | ||
| Student Names | A list of Student Name records. | |
| Prior to the 2017 Service End-Point, this was referred to as Aliases | ||
| Preferred Name | ||
| Original Name | ||
|
||
| Gender | ||
| Maturity Date | ||
| Maturity Reason | ||
| Is Deceased | ||
| Date of Death | ||
| Personal Information | ||
| Citizenship Statuses | A list of Student Citizenship records | |
| Has Disclosure Restrictions | ||
| Information Disclosure Restrictions |
|
|
| Medical Alerts are only returned if the PASI Client has the Medical Alert User role. When returned, only Medical Alert records meeting the following criteria are included:
|
||
| Guardian | A list of Parent/Guardian records | |
| Only returned when the PASI Client as an Association Type of By Last School Enrolment, By Current School Enrolment, By Student Creation, or By Ministry | ||
| Only available starting with the 2018 Service End-Point | ||
| Section 23 Eligibility | ||
| Contact Information | ||
| Student Addresses | A list of Student Addresses. All Address Formats are returned. | |
| Validation Rules | Only Student Email records the PASI Client is allowed to access (based on the Student Email Address Data Access Rules) are returned. | |
| Preferred Phone Number | The Student Phone Number record referenced as the student's Preferred Phone Number | |
| Only returned if the PASI Client is allowed to access the Student Phone Number record based on the Student Phone Number Data Access Rules | ||
| Prior to the 2016 Service End-Point, this phone number will always be returned with a Phone Number Type of Home, even if the actual phone number type is Mobile | ||
| Other Phone Numbers | The student's Phone Numbers excluding the Student Phone Number record referenced as the student's Preferred Phone Number | |
| Only Student Phone Number records the PASI Client is allowed to access (based on the Student Phone Number Data Access Rules) are returned. | ||
| Prior to the 2016 Service End-Point, all phone numbers will be returned with a Phone Number Type of Home, even if the actual phone number type is Mobile | ||
| Audit Information | ||
| Is Connected to myPass | ||
| Created On | ||
| Last Updated On | ||
| PASI Core Version | ||
Related Business Process
- No links found.
Related Functionality
1)
for the earlier version of this service, refer to
get_student_personal_profile_2018_endpoint_prior