This service interface describes the service operations on the 2017 PASI Core endpoint.
Namespace: PASI.ServiceContract
Assembly: PASI.ServiceContract (in PASI.ServiceContract.dll) Version: 9.25.26.0 (9.25.26.0)
Syntax
The IPASIService2017 type exposes the following members.
Methods
Name | Description | |
---|---|---|
BeginGetOrderedDocument |
The implementation of this service has been removed
| |
BeginIsDataAvailable |
The IsDataAvailable operation allows the caller to check for new data that is available to them.
| |
CreateSLAExpressSignUpLetter |
The implementation of this service has been removed
| |
CreateStudent |
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. | |
CreateStudentConnectionUsingEmailAddress |
The implementation of this service has been removed
| |
EndGetOrderedDocument |
The implementation of this service has been removed
| |
EndIsDataAvailable |
This is not visible to PASI clients. Only IsDataAvailable is visible. The end function of the asynchronous
service operation.
| |
GetAcceptedRegistrationStatus |
This service is used to retrieve a list of registration statuses that are accepted for the
passed in school year. If no school year is passed in (or zero is passed in) then all school years
that are currently accepted along with their statuses are returned.
| |
GetAsnCertificate |
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. | |
GetCodeValues |
This service will allow a PASI Client to request a refresh of the code values that are stored
within PASI Core.
| |
GetCourse |
This service is used to get Courses.
| |
GetCourseEnrolment |
This service will return the Course Enrolment(s) based on the Course Enrolment Id(s) passed in.
| |
GetCourseEnrolmentAuditEvents |
This service is used to retrieve audit history outlining all the changes made to a particular
Course Enrolment.
| |
GetCourseEnrolmentStatus |
This service will return the Course Enrolment Status objects based on the Course Enrolment Id(s) passed in.
| |
GetCredentialDefinitions |
This service will allow a PASI Client to request a refresh of the credential definitions that are stored
within PASI Core.
| |
GetCredentialRequirementChecklist |
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.
| |
GetDetailedAcademicReport |
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. | |
GetDiplomaExam |
This service will return the Exam(s) based on the Exam Id(s) passed in.
| |
GetDiplomaExamMark |
This service will return the Diploma Exam Mark(s) based on the Exam Mark Id(s) passed in.
| |
GetDiplomaExamMarkAuditEvents |
This service enables a PASI Client to retrieve the audit history outlining
all the changes made to a particular student's Diploma Exam Marks.
| |
GetDiplomaExamRescoreRequest | Ministry only service. This service will return the exam rescore requests based on the exam mark Id(s) passed in
| |
GetDiplomaExamResultsStatement |
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. | |
GetDiplomaExamSitting |
This service will return the Diploma Exam Sitting(s) based on the Exam Sitting Id(s) passed in.
| |
GetEducationAccountConnection | Ministry only service. This service will return a list of Education Account Connections.
| |
GetEvaluatedMark |
This service will return the Evaluated Mark(s) based on the Evaluated Mark Id(s) passed in.
| |
GetEvaluatedMarkAuditEvents |
This service is used to retrieve audit history outlining all the changes made to a particular
evaluated Mark.
| |
GetEvaluatedMarkStatus |
This service will return the Evaluated Mark Status objects based on the Evaluated Mark Id(s) passed in.
| |
GetExamAccommodation |
The implementation of this service has been removed
| |
GetExamAccommodationAuditEvents |
The implementation of this service has been removed
| |
GetExamExemptionAuditEvents |
The implementation of this service has been removed
| |
GetExamExemptionRequest |
The implementation of this service has been removed
| |
GetExamSittingAuditEvents |
Retrieve the audit history outlining all the changes made to a particular Exam Sitting record.
| |
GetExternalCredentials |
This service will allow a PASI Client to request a full listing of the available external credential values that
are stored within PASI Core.
| |
GetGedExamMark |
This service is used to retrieve GED Exam Marks from PASI Core.
| |
GetGedExamMarkAuditEvents |
Retrieve the audit history outlining all the changes made to a particular GED Exam Mark.
| |
GetOfficialMarkAuditEvents |
This service is used to retrieve audit history outlining all the changes made to a particular
official Mark.
| |
GetOrganizationAssociation |
This service allows an organization to determine its association to a specified
list of students or all the students for a School.
| |
GetPartnerPostSecondaryInstitutions |
This service is used to retrieve a list of all post secondary institutions that participate in dual credit offerings.
| |
GetPathwayCompletionAuditEvents |
Retrieve the audit history outlining all the changes made to completion record for a student's pathway.
| |
GetPathways |
This service is used to retrieve a list of all pathway information.
| |
GetSchoolAuthorityInformation |
This service will retrieve school authority information that matches the school authority code(s) provided in the
request.
| |
GetSchoolCalendarYearInformation |
This service will retrieve school calendar year information that matches the school calendar keys (school code,
school year) provided in the request.
| |
GetSchoolInformation |
This service operation will retrieve school information that matches the school code(s) provided in the request.
| |
GetSection |
This service will return the Section(s) based on the Section Id(s) passed in.
| |
GetSectionAuditEvents |
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.
| |
GetSectionStatus |
This service will return the Section Status objects based on the Section Id(s) passed in.
| |
GetSourceDocumentTypeQualityValues |
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.
| |
GetStateProvinceIdPool |
This service returns a list of all StateProvinceId ranges currently available in the database. This service
is only callable by a PASI client representing the Ministry of Education.
| |
GetStudent |
This service operation will return a list of students that are requested by the client.
| |
GetStudentAcademicProfile |
This service returns limited or full academic information for a student.
| |
GetStudentAuditEvents |
This service returns the audit events for a particular student.
| |
GetStudentConnectionsForAsn |
The implementation of this service has been removed
| |
GetStudentCredentialAuditEvents |
This service is used to retrieve audit history outlining all the changes made to a particular
Credential.
| |
GetStudentCredentialRequirementAuditEvents |
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.
| |
GetStudentCredentialRequirementSet |
This service is used to retrieve student credential requirement information for a single student based on the
provided ASN
and Requirement Set type.
| |
GetStudentCredentialRequirementSetAuditEvents |
This service is used to retrieve audit history outlining all the changes made to a particular
Credential Requirment Set.
| |
GetStudentExternalCredentialAudit |
Retrieves audit information for an identified Student External Credential record.
| |
GetStudentLearningProfile |
The implementation of this service has been removed
| |
GetStudentPersonalProfile |
This service returns limited or full personal information for a student.
| |
GetStudentSchoolEnrolment |
This service will return the enrolment(s) based on the enrolment Id(s) passed in.
| |
GetStudentSchoolEnrolmentAuditEvents |
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.
| |
GetStudentSchoolEnrolmentStatus |
This service will return the enrolment status objects based on the enrolment Id(s) passed in.
| |
GetStudentStatus |
This service operation will return a list of student status object that are requested by the client.
| |
GetStudentTranscriptDetail |
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.
| |
HelloWorld |
The HelloWorld service returns a greeting to the PASI Client.
Example: PASI Client calls the HelloWorld service passing in "John", the message "Hello John from the PASI Core
Helloworld Service!" will be returned.
| |
IdentifyStudent |
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
| |
SubmitCourseEnrolment |
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. | |
SubmitCourseEnrolmentStatusAcknowledgement |
This service updates the acknowledgement of a core alert for a course enrolment.
| |
SubmitCredentialRequirementAchievement |
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.
| |
SubmitCredentialRequirementExemption |
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.
| |
SubmitDiplomaExam |
The implementation of this service has been removed
| |
SubmitDiplomaExamMark |
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.
| |
SubmitDiplomaExamSitting |
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.
| |
SubmitEvaluatedMark |
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. | |
SubmitEvaluatedMarkStatusAcknowledgement |
This service updates the acknowledgement of a core alert for an evaluated mark.
| |
SubmitExamAccommodationDecision |
The implementation of this service has been removed
| |
SubmitExamExemptionRequest |
The implementation of this service has been removed
| |
SubmitMarkApproval |
This service is used to change the approve the mark value of a Evaluated Mark or Course Enrolment Mark.
| |
SubmitSchoolAuthorityInformation |
This service will allow the Ministry Client to update School Authority information in the PASI Core.
| |
SubmitSchoolCalendarYear |
This service will allow the Ministry Client to update School Calendar Year information in the PASI Core.
| |
SubmitSchoolInformation |
This service will allow the Ministry Client to update School information in the PASI Core.
| |
SubmitSection |
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.
| |
SubmitSectionStatusAcknowledgement |
This service updates the acknowledgement of a core alert for a section.
| |
SubmitStudent |
The implementation of this service has been removed
| |
SubmitStudentCitizenshipStatus |
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.
| |
SubmitStudentConnection |
The implementation of this service has been removed
| |
SubmitStudentDeceasedStatus |
This service will update a Student's status indicating they have passed away.
| |
SubmitStudentDisclosureRestriction |
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.
| |
SubmitStudentEmailAddress |
This service will allow setting of the details for a student's email address.
| |
SubmitStudentExternalCredential |
The service, Submit Student External Credential, will submit and update details regarding an External Credential
awarded to a Student.
| |
SubmitStudentFeeCoupon |
A service to create or update a coupon for a student fee
| |
SubmitStudentGender |
This service will update a Student's gender.
| |
SubmitStudentIdentificationInformation |
This service will allow the modification of a Student's legal name and/or birth date while capturing
the information about the documentation that supports the name and birth date.
| |
SubmitStudentMailingAddress |
This service will allow setting of the details for a students address.
| |
SubmitStudentName |
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.
| |
SubmitStudentPhoneNumber |
This service is used to submit (add, correct, delete) a phone number for a student.
| |
SubmitStudentPreferredMailingAddress |
This service is used to submit a students preferred mailing address to PASI
| |
SubmitStudentPreferredName |
This service is used to submit a student's preferred name to PASI
| |
SubmitStudentPreferredPhoneNumber |
This service will allow one of the student's phone numbers to be marked as their preferred phone number.
| |
SubmitStudentSchoolEnrolment |
This service will allow the PASI Client to submit an student school enrolment to
the PASI Core.
| |
SubmitStudentSchoolEnrolmentStatusAcknowledgement |
This service updates the acknowledgement of a core alert for a student school enrolment.
| |
SubmitStudentSection23EligibilityStatus |
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).
| |
SubmitStudentStateProvinceIdStatus |
The implementation of this service has been removed
| |
SubmitStudentStatusAcknowledgement |
This service will submit an acknowledgement for a student core alert.
| |
SubmitTranscriptRequest |
The implementation of this service has been removed
| |
ValidateStudentByMarks |
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. |
See Also