Get Student Academic Profile (2017)

This service is used to retrieve the academic history for a single student based on the provided ASN. The amount of information returned will be controlled based on the requestor’s association to the student as well as the requestor’s ownership of academic records e.g. course enrolment.

This version of the service is available on the 2017 Service Endpoint1)

Official Marks and Credential information will be omitted if the student has an active student hold with a hold type of OfficialMarkHold (Student Hold Type).

Security

The service can be accessed by systems with the View Enrolment User or the View Academic Record User role.

Request Information

The following information is provided when using this service:

  • A single Alberta Student Number (Student) for the student being requested *
  • Limited Profile Requested *
  • Include Deleted Records *
  • Minimum Expected PASI Core Version *

When an associated PASI Client makes a Limited Profile request the response will be treated as though the PASI client is not associated.

Request Validations

The following rules are used to validate the information provided in the request:

Service Functionality

The ASN supplied to the service is validated and upon completion of validation the service returns academic information related to the supplied ASN. The returned information is filtered by the requestor’s Student Association and ownership of records.

Request Mapping

The request information on the two service endpoints are the same.

Response Mapping

The Student School Enrolment information will be updated using the following mapping:

The Course Enrolment information will be updated using the following mapping:

The PAT Result are not returned on the 2017 Endpoint Service:

The Responsible School are not returned on the 2017 Endpoint Service:

Response Information

The response to a successful Get Student Academic Profile request will be the appropriate Academic Profile based on:

  • The PASI Client System Role assigned to the requesting PASI Client
  • The user’s association to the student (i.e. School Enrolment);
  • The user’s ownership of records (i.e. Was the record created by the organization?); and
  • The state of the record (e.g. Is the mark approved?).
  • Student’s hold status

The response will identify the Profile Type, limited vs. full, being returned. This value is leveraged by PASIprep, to indicate to the user the level of detail PASI Core returned.

Note: For Limited Access Schools/Authorities, Rule 9002 - Invalid ASN ensures that only authorized clients are able to access the student's information.

Data Returned Limiting Factors
General Information Always returned
Student School Enrolments All Student School Enrolment records the user is allowed to access as per the Student School Enrolment Data Access Rules
Course Enrolments All Course Enrolment records the user is allowed to access as per the Course Enrolment Data Access Rules
Evaluated Marks All Evaluated Mark records the user is allowed to access as per the Evaluated Mark Data Access Rules
GED Exam Marks All GED Exam Mark records the user is allowed to access as per the GED Exam Mark Data Access Rules
Diploma Exam Marks All Diploma Exam Mark records the user allowed to access as per the Diploma Exam Marks Data Access Rules.
Official Marks All Official Mark records the user is allowed to access as per the Official Mark Data Access Rules.
Student Credentials
  • If the PASI Client requested a limited profile when calling the service, no Student Credentials are returned
  • If the PASI client has the View Transcript User role, all Student Credential records they have access to (as per the data_access_rules) are returned.
  • If they don’t have the View Transcript User role, no student credential information returned.
Student Credential Requirement Set
Student Credential Requirements
  • If the PASI Client requested a limited profile when calling the service, no Student Credentials are returned
  • Otherwise, all Student Credential records the user is allowed to access as per the data_access_rules are included.
Student External Credentials All Student External Credentials records the user is allowed to access as per the Student External Credential Data Access Rules.
CTS Credentialed Pathway Completions All CTS Credentialed Pathway Completion records the user is allowed to access as per the Student CTS Credentialed Pathway Data Access Rules.

Note: The 'last 2 years' can be determined based on the current school year. If the current school year is 2015 (i.e. the 2014/2015 school year) then records from the 2013 school year (i.e. the 2012/2013 school year) and later are returned.

General Information

The following information is included in each response:

Student School Enrolment Information

The following information is included for each Student School Enrolment record returned:

Course Enrolment Information

The following information is included for each Course Enrolment record returned:

The <CourseEnrolmentMark> segment is only returned if any one of the following situations occur:

  1. The mark value on the course enrolment record has been approved and the requesting organization is associated By Recent School Enrolment or better.
  2. The course enrolment has a Mark value and either the calling client “owns” the record or the calling client has a Ministry association to the student.

The <CourseEnrolmentMark> segment is not returned 2) if any one of the following situations occur:

  1. There is no Mark Value.
  2. The calling client is not associated By Recent School Enrolment or better.
  3. The calling client does not “own” the record, does not have Ministry association to the student, there is a Mark Value and the mark value has not been approved.

Evaluated Mark Information

The following information is included for each Evaluated Mark record returned:

GED Exam Mark Information

Diploma Exam Mark Information

Official Mark Information

The following information is included for each Official Mark record returned:

Student Credential Information

Student External Credentials

The following information is included for each Student External Credential record returned:

CTS Credentialed Pathway Completions information

No links found.
No links found.
1)
for the current version of this service, refer to Get Student Academic Profile (2018).
2)
and IsMarkApproved will appear as 'false'