IPASIService2019 InterfaceProvincial Approach to Student Information API
This service interface describes the service operations on the 2019 PASI Core endpoint.

Namespace: PASI.ServiceContract
Assembly: PASI.ServiceContract (in PASI.ServiceContract.dll) Version: 9.23.3.0 (9.23.3.0)
Syntax

public interface IPASIService2019

The IPASIService2019 type exposes the following members.

Methods

  NameDescription
Public methodBeginIsDataAvailable
The IsDataAvailable operation allows the caller to check for new data that is available to them.
Public methodCreateStudent
This service will create a new student and accept all data related to the student in a single service call. During this service the PASI core will create a State Province Id (Alberta Student Number) for the new student which uniquely identifies a student within the province.

After a student has been created in PASI core the additional services described in this document can be used to modify the student data. This service is only for initial creation.
Public methodEndIsDataAvailable
This is not visible to PASI clients. Only IsDataAvailable is visible. The end function of the asynchronous service operation.
Public methodGetAccommodationTypeRelationshipValues
This services returns all the Accommodation Types and related Accommodation Formats for each Accommodation Type code value.
Public methodGetAsnCertificate
This service is used to retrieve an ASN Certificate from PASI Core for a given student.

The service returns the ASN Certificate in base64 encoded PDF that can be distributed or printed for student.
Public methodGetClassroomAccommodation
This service will return the Classroom Accommodation(s) based on the Classroom Accommodation RefId(s) passed in.
Public methodGetClassroomAccommodationAuditEvents
This service returns the audit events for a particular classroom accommodation.
Public methodGetClassroomAccommodationStatus
This service operation will return a list of classroom accommodation status object that are requested by the client.
Public methodGetCodeValues
This service will allow a PASI Client to request a refresh of the code values that are stored within PASI Core.
Public methodGetCourse
This service is used to get Courses.
Public methodGetCourseEnrolment
This service will return the Course Enrolment(s) based on the Course Enrolment Id(s) passed in.
Public methodGetCourseEnrolmentAuditEvents
This service is used to retrieve audit history outlining all the changes made to a particular Course Enrolment.
Public methodGetCourseEnrolmentStatus
This service will return the Course Enrolment Status objects based on the Course Enrolment Id(s) passed in.
Public methodGetCredentialDefinitions
This service will allow a PASI Client to request a refresh of the credential definitions that are stored within PASI Core.
Public methodGetCredentialRequirementChecklist
This service is used to retrieve Credential Requirement Checklist PDFs from PASI Core for a given list of students. The user must have the View Transcript Role.
Public methodGetDetailedAcademicReport
This service is used to retrieve Detailed Academic Report PDF from PASI Core for a list of students. The security level requirement for using this service is the same as other transcript related information.

To request a Detailed Academic Report, the PASI Client will need to provide Alberta Student Number(s) (StateProvinceIds) for the students and the language of the document

The service return Detailed Academic Report in base64 encoded PDF that can be distributed or printed for student.
Public methodGetDiplomaExam
This service will return the Exam(s) based on the Exam Id(s) passed in.
Public methodGetDiplomaExamMark
This service will return the Diploma Exam Mark(s) based on the Exam Mark Id(s) passed in.
Public methodGetDiplomaExamMarkAuditEvents
This service enables a PASI Client to retrieve the audit history outlining all the changes made to a particular student's Diploma Exam Marks.
Public methodGetDiplomaExamRescoreRequest
Ministry only service. This service will return the exam rescore requests based on the exam mark Id(s) passed in
Public methodGetDiplomaExamResultsStatement
This service is used to retrieve Diploma Exam Results Statement PDF from PASI Core for a list of students. The security level requirement for using this service is the same as other transcript related information.

To request a Diploma Exam Results Statement, the PASI Client will need to provide Alberta Student Number(s) (StateProvinceIds) for the students and the language of the document

The service returns a Diploma Exam Results Statement in base64 encoded PDF that can be distributed or printed for student.
Public methodGetDiplomaExamSitting
This service will return the Diploma Exam Sitting(s) based on the Exam Sitting Id(s) passed in.
Public methodGetDocumentTypes
This service is used to retrieve document types.
Public methodGetEducationAccountConnection
Ministry only service. This service will return a list of Education Account Connections.
Public methodGetEvaluatedMark
This service will return the Evaluated Mark(s) based on the Evaluated Mark Id(s) passed in.
Public methodGetEvaluatedMarkAuditEvents
This service is used to retrieve audit history outlining all the changes made to a particular evaluated Mark.
Public methodGetEvaluatedMarkStatus
This service will return the Evaluated Mark Status objects based on the Evaluated Mark Id(s) passed in.
Public methodGetExamSittingAuditEvents
Retrieve the audit history outlining all the changes made to a particular Exam Sitting record.
Public methodGetExternalCredentials
This service will allow a PASI Client to request a full listing of the available external credential values that are stored within PASI Core.
Public methodGetGedExamMark
This service is used to retrieve GED Exam Marks from PASI Core.
Public methodGetGedExamMarkAuditEvents
Retrieve the audit history outlining all the changes made to a particular GED Exam Mark.
Public methodGetOfficialMarkAuditEvents
This service is used to retrieve audit history outlining all the changes made to a particular official Mark.
Public methodGetOrganizationAssociation
This service allows an organization to determine its association to a specified list of students or all the students for a School.
Public methodGetPartnerPostSecondaryInstitutions
This service is used to retrieve a list of all post secondary institutions that participate in dual credit offerings.
Public methodGetPathwayCompletionAuditEvents
Retrieve the audit history outlining all the changes made to completion record for a student's pathway.
Public methodGetPathways
This service is used to retrieve a list of all pathway information.
Public methodGetPatResultIsp
This service returns Provincial Achievement Test Result Individual Student Profile (ISP) PDF reports.
Public methodGetProvincialAchievementTest
This service will return the Provincial Achievement Test(s) based on the Provincial Achievement Test RefId(s) passed in.
Public methodGetProvincialAchievementTestResult
This service will return the Provincial Achievement Test result(s) based on the Provincial Achievement Test result RefId(s) passed in.
Public methodGetProvincialAchievementTestResultAuditEvents
This service returns the audit events for a particular provincial achievement test result.
Public methodGetResponsibleSchool
This service will return the Responsible School(s) based on the Responsible School RefId(s) passed in.
Public methodGetResponsibleSchoolAuditEvents
This service returns the audit events for a particular responsible school.
Public methodGetResponsibleSchoolStatus
This service will return the responsible school status objects based on the responsible school Id(s) passed in.
Public methodGetSchoolAuthorityInformation
This service will retrieve school authority information that matches the school authority code(s) provided in the request.
Public methodGetSchoolCalendarYearInformation
This service will retrieve school calendar year information that matches the school calendar keys (school code, school year) provided in the request.
Public methodGetSchoolInformation
This service operation will retrieve school information that matches the school code(s) provided in the request.
Public methodGetSection
This service will return the Section(s) based on the Section Id(s) passed in.
Public methodGetSectionAuditEvents
This service is used to retrieve audit history outlining all the changes made to a particular section. PASI Clients who can update the section information will also be able to retrieve audit history.
Public methodGetSectionStatus
This service will return the Section Status objects based on the Section Id(s) passed in.
Public methodGetSourceDocumentTypeQualityValues
This service will allow a PASI Client to request a refresh of the Source Document Quality values that are related to the Source Document Type code values stored within PASI Core.
Public methodGetStateProvinceIdPool
Ministry only service. This service returns a list of all StateProvinceId ranges currently available in the database.
Public methodGetStudent
This service operation will return a list of students that are requested by the client.
Public methodGetStudentAcademicProfile
This service returns limited or full academic information for a student.
Public methodGetStudentAuditEvents
This service returns the audit events for a particular student.
Public methodGetStudentCredentialAuditEvents
This service is used to retrieve audit history outlining all the changes made to a particular Credential.
Public methodGetStudentCredentialRequirementAuditEvents
This service is used to retrieve student credential requirement audit information for a single student based on the provided ASN and credential requirement code. Student Credential Requirement audit information will only be returned if the requestor is associated to the student.
Public methodGetStudentCredentialRequirementSet
This service is used to retrieve student credential requirement information for a single student based on the provided ASN and Requirement Set type.
Public methodGetStudentCredentialRequirementSetAuditEvents
This service is used to retrieve audit history outlining all the changes made to a particular Credential Requirement Set.
Public methodGetStudentExternalCredentialAuditEvents
Retrieves audit information for an identified Student External Credential record.
Public methodGetStudentLearningProfile
This service is used to retrieve the learning profile for a single student based on the provided ASN. Learning profile includes exam accommodations and (in the future) other information for the student that is not academic or personal information, but is pertinent to improving educational opportunities for the student.
Public methodGetStudentPersonalProfile
This service returns limited or full personal information for a student.
Public methodGetStudentRecordDocument
This service is used to get the data for a specific document in the Student Record for a specific student. The image of the document is not returned. All attached Problem Report(s) and Quality Assurance Result is returned.
Public methodGetStudentRecordDocumentDetailAuditEvents
This service returns the audit events for a particular student document.
Public methodGetStudentRecordDocumentImage
Retrieve the PDF image of a student record document by Reference ID.
Public methodGetStudentRecordDocumentList
This service is used to retrieve a list of record document for a single student based on the provided ASN. Record document include details of the document and information on applicable problem reports and quality assurance result.
Public methodGetStudentRecordDocumentProblemReportAuditEvents
Retrieve the audit history outlining all the changes made to a particular Student Record Document Problem Report.
Public methodGetStudentRecordDocumentQAResultAuditEvents
Retrieves quality assurance audit information for an identified Student Record Document.
Public methodGetStudentSchoolEnrolment
This service will return the enrolment(s) based on the enrolment Id(s) passed in.
Public methodGetStudentSchoolEnrolmentAuditEvents
This service enables a PASI Client to retrieve the audit history outlining all the changes made to a particular School Enrolment. PASI Clients who can update the SSE information will also be able to view student school enrolment audit history.
Public methodGetStudentSchoolEnrolmentStatus
This service will return the enrolment status objects based on the enrolment Id(s) passed in.
Public methodGetStudentStatus
This service operation will return a list of student status object that are requested by the client.
Public methodGetStudentTranscriptDetail
This service will be used by PASI client to synchronize the details of student's transcript. This service is the corresponding "get" service to the StudentTranscriptDetail notification type on the IsDataAvailable service.
Public methodHelloWorld
The HelloWorld service returns a greeting to the PASI Client and indicates which PASI endpoint is being called. Example: PASI Client calls the HelloWorld service passing in "John", the message "Hello John from the PASI Core Helloworld Service!" will be returned.
Public methodIdentifyStudent
The Identify Student Service enables PASI Clients representing School Authorities and/or Schools to lookup a student's State Province Id (Alberta Student Number) along with some basic student information when the student's Given Name and Birth Date are provided
Public methodSubmitClassroomAccommodation
This service is used to manage Classroom Accommodations in PASI Core. This service can be used to: * Add a new Classroom Accommodation, or * Update an existing Classroom Accommodation
Public methodSubmitClassroomAccommodationStatusAcknowledgement
This service updates the acknowledgement of a core alert for a classroom accommodation.
Public methodSubmitCourseEnrolment
This service is used to manage Course Enrolment information in the PASI Core. It is used to add a new Course Enrolment, update an existing Course Enrolment or delete/undelete an existing Course Enrolment. This service work with either a single record, or a list of Course Enrolment information thus allowing a PASI Client to record information in PASI through submitting one batch at a time.

The IsMarkApproved property of CourseEnrolmentMarkInfo is ignored when this service is called. To approve a mark value the SubmitMarkApproval service must be used.
Public methodSubmitCourseEnrolmentStatusAcknowledgement
This service updates the acknowledgment of a core alert for a course enrolment.
Public methodSubmitCredentialRequirementAchievement
This service is used to manage student's credential requirement information in PASI Core. It is used to add a new credential requirement or update an existing one. Multiple records for a single student may be processed in a single call.
Public methodSubmitCredentialRequirementExemption
This service is used to manage student's credential requirement exemption information in PASI Core. It is used to add a new credential requirement exemption or update an existing one.
Public methodSubmitDiplomaExam
Ministry only service. This service is used to add exams to PASI. This service will only ever be called by Ministry Systems.
Public methodSubmitDiplomaExamMark
This service is used to add, update and delete Exam Marks. Diploma registrations can be submitted by using the "Registered" ExamMarkStatus. This service can be used to manage a single record, or a list of records at the same time. This allows a PASI Client to record its information in PASI by submitting the information in batches.
Public methodSubmitDiplomaExamSitting
This service is used to add, update and delete Diploma Exam Sittings. Diploma Exam Sittings describe the time and place where students may write a specific exam.
Public methodSubmitEmailAddress
This service will allow setting of the details for email address.
Public methodSubmitEvaluatedMark
This service is used to manage Evaluated Mark information in the PASI Core. It is used to add a new Evaluated Mark, update an existing Evaluated Mark, or delete/undelete an existing Evaluated Mark. This service work with either a single record, or a list of Evaluated Mark information thus allowing a PASI client to record information in PASI through submitting one batch at a time.

The IsMarkApproved property is ignored when this service is called. To approve a mark value the SubmitMarkApproval service must be used.
Public methodSubmitEvaluatedMarkStatusAcknowledgement
This service updates the acknowledgment of a core alert for an evaluated mark.
Public methodSubmitIdentificationInformation
This service will allow the modification of a person's legal name and/or birth date while capturing the information about the documentation that supports the name and birth date.
Public methodSubmitLanguageAtHome
This service is used to specify primary language spoken at home for a student.
Public methodSubmitMarkApproval
This service is used to change the approve the mark value of a Evaluated Mark or Course Enrolment Mark.
Public methodSubmitMedicalAlert
This service is used to create or update a medical alert
Public methodSubmitName
This service is used to submit a new alias for a student to the PASI Core or to update an existing student alias within the PASI Core.
Public methodSubmitParentGuardian
This service is used to create or update a parent/guardian
Public methodSubmitPhoneNumber
This service is used to submit (add, correct, delete) a phone number for a student.
Public methodSubmitPreferredName
This service is used to submit a student's preferred name to PASI
Public methodSubmitPreferredPhoneNumber
This service will allow a phone numbers to be marked as a preferred phone number.
Public methodSubmitProvincialAchievementTest
This service is used to manage Provincial Achievement Test definitions in PASI Core. This service can be used to: * Add a new Provincial Achievement Test definition, or * Update an existing Provincial Achievement Test definition
Public methodSubmitProvincialAchievementTestResult
This service is used to manage Provincial Achievement Test Results in PASI Core. This service can be used to: * Add a new Provincial Achievement Test Result, or * Update an existing Provincial Achievement Result
Public methodSubmitResponsibleSchool
This service is used to manage a Student's Responsible School in PASI. This service can be used to: * Add a new Responsible School for a student, or * Update an existing Responsible School for a Student
Public methodSubmitResponsibleSchoolStatusAcknowledgement
This service updates the acknowledgment of a core alert for a responsible school.
Public methodSubmitSchoolAuthorityInformation
Ministry only service. This service will allow the Ministry Client to update School Authority information in the PASI Core.
Public methodSubmitSchoolCalendarYear
Ministry only service. This service will allow the Ministry Client to update School Calendar Year information in the PASI Core.
Public methodSubmitSchoolInformation
Ministry only service. This service will allow the Ministry Client to update School information in the PASI Core.
Public methodSubmitSection
This service is used to manage Section information in the PASI Core. It is used to add a new Section, update an existing Section or delete/undelete an existing Section. This service works with either a single record, or a list of Section information thus allowing a school to record information in PASI by submitting one batch at a time.
Public methodSubmitSectionStatusAcknowledgement
This service updates the acknowledgment of a core alert for a section.
Public methodSubmitStudentAddress
This service will allow setting of the details for a students address.
Public methodSubmitStudentCitizenshipStatus
This service will allow the student's Citizenship Status to be updated. Historical records are maintained in PASI core for this information so corrections can be made to existing data by specifying the CitizenshipStatusRefId. If a record is created in error it can be removed by specifying the CitizenshipStatusRefId and setting the DeleteCitizenshipStatus flag to True.
Public methodSubmitStudentDeceasedStatus
This service will update a Student's status indicating they have passed away.
Public methodSubmitStudentDisclosureRestriction
This service will allow setting of the details for a student disclosure restriction. This includes the date the disclosure restriction starts, expires, the details of the restriction and disclosure restriction code.
Public methodSubmitStudentExternalCredential
The service, Submit Student External Credential, will submit and update details regarding an External Credential awarded to a Student.
Public methodSubmitStudentFeeCoupon
A service to create or update a coupon for a student fee
Public methodSubmitStudentGender
This service will update a Student's gender.
Public methodSubmitStudentRecordDocument
This service enables adding, updating and deleting student documents
Public methodSubmitStudentRecordDocumentProblemReport
This service enable adding and updating student record document problem report.
Public methodSubmitStudentRecordDocumentQualityAssurance
This service enables update student document quality assurance results
Public methodSubmitStudentSchoolEnrolment
This service will allow the PASI Client to submit an student school enrolment to the PASI Core.
Public methodSubmitStudentSchoolEnrolmentStatusAcknowledgement
This service updates the acknowledgment of a core alert for a student school enrolment.
Public methodSubmitStudentSection23EligibilityStatus
This service will allow the update of the student's Section 23 eligibility status. When calling this service the value passed in will replace the single value in the PASI core (there are not historical records that can be modified for this information).
Public methodSubmitStudentStatusAcknowledgement
This service will submit an acknowledgement for a student core alert.
Public methodValidateStudentByMarks
This service validates the StateProvinceId provided in the request has a school mark value in the given School Code and the mark value matches for any one of the courses provided in the list of course codes.

The mark value passed into the service is compared to the PASI value as a string. For example if the caller passed 80% and PASI has 80 for the mark value this comparison will fail.

Mark values in PASI will be the numbers from 0 to 100 or letters A, B, C, D, F, P.

The caller should consider limiting the input to avoid missed matches.
Top
See Also

Reference