PASI Knowledge Base

Table of Contents

Get Student (2020 Endpoint)

The Get Student (2020 Endpoint) service is used to retrieve Student information from PASI Core. This service can be used to:

  1. Retrieve information about a Student from the PASI Core, and
  2. Obtain updates about a Student from the PASI Core as part of the data synchronization processes.

This service can be used to get a single record or a list of records.

This version of the service is available starting with the 2020 Service Endpoint1).

=

Security

This service can be accessed by systems with the K-12 Organization Client role.

Request Information

A request to use this service will include a list of (* denotes mandatory information):

Request Validations

There are no validations performed on the service request.

Service Functionality

Information for each of the Student records 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 Number 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
  • No Access if the Organization is O.1, the PASI Client has the High School Student Sync User role and the Synchronization Status of the requested ASN is Off or Disabled.
  • Normal if the record(s) has been returned.

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.

Response Information

Availability Status will be returned for each requested Student record.

For each student with an Availability Status of Normal the following information will be returned:

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

Identity Information

  • 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

Medical Alert

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
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
Student Citizenship Created By Organization effective 2020 End Point
Audit User Name effective 2020 End Point
    No links found.

Update History

  • Release 9.03 - Feature 10810 updated
  • Release 8.12 - Feature 9832 - update
, ,
1)
for the earlier version of this service, refer to Get Student (2019 Endpoint)
©2024 Government of Alberta Contact Us | Copyright and Disclaimer | Privacy