Table of Contents
Get Student Status (2018)
This page describes the implementation of the service on the 2018 Service Endpoint. For a description of the current implementation visit the Get Student Status service page.
A Student Status object identifies any business rule validations that have failed in the form of a Core Alert. Refer to any Validation Rules implemented by the Student Status Processor for a list of the business rules. These issues need to be resolved by an end-user to ensure that the data in PASI remains of high quality.
This service is used to acquire Student Status records in PASI Core and if requested, this service can also return the Student information. This service can be used as required, or as part of the data synchronization processes.
This service returns same information as Get Student Status except that the Student Citizenship and Parent/Guardian information is different. Before returning the information, the service updates the Student Citizenship and Parent/Guardian information using data mapping as outlined in Service Functionality section below.
Security
This service can be accessed by systems with the K-12 Organization Client role.
Request Information
The information provided as part of the Get Student Status request is a list of Alberta Student Numbers for the Student records whose status is being requested.
Optionally, for each Student Status requested, the client can supply an:
- Expected Version: The version of the Student Status record that the PASI Client is expected.
- Known Source Version: The version of the underlying Student record that the PASI Client has currently synchronized. Using the Known Source Version provides the ability to synchronize both Student Status and Student at the same time which may help to simplify client data synchronization.
Request Validations
There are no validations performed on the service request.
Functionality
Information for each of the Validation Status for each Student identified in the request will be retrieved from the PASI Core and returned in the response. If a list of records has been requested, they will be processed in the order provided.
The Alberta Student Numbers provided in the request are validated and the result is returned in the Availability Status:
- Unknown if the Alberta Student Numbers provided is unknown in the PASI Core
- Unknown if the Organization is a Authority and does not have one of the following:
- Association By Last School Enrolment (or higher) to the ASN being requested
- Authority Classification of Not in Alberta - National Contracted with a previous historical school enrolment for the student that is not Cancelled or Created in Error
- No Access if the Organization is not a Authority and does not have access to the record being requested
- No Access if the Organization is a authority with Authority Classification of Not in Alberta - National Contracted and a previous historical school enrolment for the student that is not Cancelled or Created in Error
- Normal if the record has been returned
- Recalculating if the status is being recalculated.
When an Expected Version is provided in the request for a record:
- If the Expected Version requested is ‘0’, the current PASI Version of the record will be returned.
- If the Expected Version requested is the same as the PASI Version of the record, the record will be returned.
- If the Expected Version requested is not the same as the PASI Version of the record, the record will not be returned and no further requested records will be processed.
When providing the Known Source Version, if the version of the underlying Student record is greater than the Known Source Version provided, the updated Student record will also be included in the response.
The Parent/Guardian information will be updated using the following mapping and then returned by the service when it is called from 2018 End Point and Earlier:
-
- If the Parent/Guardian Physical Address Format is equal to RuralAlbertaAddress (Address Format) or ATS (Address Format) then return Parent/Guardian Physical Address Details with blank values.
-
- If the Parent/Guardian Physical Address Details fields are blank then set Has Same Mailing Address as Student equal to ‘True’.
-
- If Parent/Guardian Physical Address Source is equal to ‘MailingAddress’, then set Has Same Physical Address as Parent Mailing equal to ‘True’.
- If Parent/Guardian Physical Address Source is equal to ‘PhysicalAddress’ or ‘StudentPhysicalAddress’, then set Has Same Physical Address as Parent Mailing equal to ‘False’.
-
- If Parent/Guardian Physical Address Source is equal to ‘StudentMailingAddress’, then set Has Same Physical Address as Student equal to ‘True’.
- If Parent/Guardian Physical Address Source is equal to ‘PhysicalAddress’ or ‘StudentPhysicalAddress’, then set Has Same Physical Address as Student equal to ‘False’.
The Student Citizenship information will be updated using the following mapping and then returned by the service when it is called from 2018 End Point and Earlier:
- When returning the Student Citizenship Status, return the value from the Student Legacy Citizenship Status stored in the database. Note: Student Legacy Citizenship Status is stored in the database by the Submit Student Citizenship Status Service.
Response Information
Availability Status will be returned for each requested Student record.
The response will contain a list of the Validation Status records requested with an Availability Status of Normal:
- List of Core Alerts
- Max Source PASI Version
- PASI Core Version
When using the Known Source Version, the response may also include the Student record associated to the status:
| 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 | ||
| 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 | |
| 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 include:
|
||
| Guardian | A list of Parent/Guardian records. Refer to Service Functionality section for data mapping required for Parent/Guardian information. | |
| 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 | ||
| Primary Language Spoken at Home | Only available starting with the 2018 Service End-Point | |
| Section 23 Eligibility | ||
| Contact Information | ||
| Preferred Mailing Address | This data element only exists on the 2018 (and prior) endpoint to support backwards compatibility. Refer to the Preferred Mailing Address to see how it is calculated. |
|
| Student Addresses 1) | The student's Student Addresses excluding the Student Address record referenced as the student's Preferred Mailing Address. This will also exclude Latitude and Longitude data elements. Only the Address Type = Mailing (Address Type) 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 | ||
| Created On | ||
| Last Updated On | ||
| PASI Core Version | ||
If the service is being called by a school/authority that is an Authority then the service will look to see if the school/authority has an Association By Last School Enrolment or higher 2). If they do not have the needed association, then an Availability Status of “Unknown” will be returned and the service will populate the response as though the ASN does not exist.
Related Business Process
- No links found.