Table of Contents
Submit Preferred Name
Note: Prior to the 2018 endpoint, this service was referred to as Submit Student Preferred Name.
This service is used to identify which Student Name should be considered the Preferred Name for a Student in the PASI Core. The Student Preferred Name is the name that should be generally used to communicate with the student, however, it may not be the student’s legal name.
Security
This service can be accessed by systems with the Submit Student User role.
Request Information
The information provided as part of the request is a reference to the specific Student Name that should be treated as the preferred name for the student.
Request Validations
The following rules are used to validate the information provided in the request:
Service Functionality
Once the information is successfully validated, the information will be recorded within the PASI Core.
Health Version Updates
The PASI Core Version (Student Health Version) for the student will be updated if the update changes which name record is identified as the as the ‘preferred name'.
Elections Alberta Triggers
PASI will create/update the student’s Elections Alberta Trigger record if the submission changes which student name record is identified as the student's Preferred Name.
Validation Status Triggers
When the student's Preferred Name is changed to reference a new Student Name record, a Student Status Processor Trigger is created to trigger recalculation of the Validation Status for the Student.
Response Information
A response to a Submit Preferred Name request identifies if the request was successfully applied.
If not successful, the response identifies which validation rules failed.