Get Student Status 2021 End Point

This page describes the implementation of the service starting with the 2021 End Point.

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.

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.

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
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.
	Student Names	Prior to the 2017 Service End-Point, this was referred to as Aliases
	Preferred Name
	Original Name
	Identity Information Current Identity Name Birth Date Is Name Exact Student Identity Document Student Identity Source Document Number Student Identity Source Document Issued Date Student Identity Source Document Type	Prior to the 2017 Service End-Point, Gender was included in the Student Identity Starting with the 2018 Service End-Point, a Student Document may be returned as the source of the Student Identity
	Gender
	Maturity Date
	Maturity Reason
	Is Deceased
	Date of Death
Personal Information
	Citizenship Statuses	A list of Student Citizenship records
	Information Disclosure Restrictions	Only Information Disclsoure Restriction records that the PASI Client is allowed to access (based on the Information Disclosure Restriction Data Access Rules) are returned. Inactive Information Disclosure Rescrition records are only returned to PASI Clients with the Ministry Client User role.
	Medical Alert Reference ID Medical Alert Type Medical Alert Message Last Updated On	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: the PASI Client is allowed to access (based on the Medical Alert Data Access Rules) not not been deleted ( Is Deleted is False)
	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
	Primary Language Spoken at Home	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
	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 ¹⁾. 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.

Related Functionality

No links found.

CoreService, Functionality, DataSynchronization

¹⁾

Has association by By Ministry, By Student Creation, By Current School Enrolment, or By Last School Enrolment

PASI Knowledge Base

Table of Contents