This service will return the Course Enrolment Status objects based on the Course Enrolment Id(s) passed in.
Namespace: PASI.ServiceContract
Assembly: PASI.ServiceContract (in PASI.ServiceContract.dll) Version: 9.25.26.0 (9.25.26.0)
Syntax
List<CourseEnrolmentStatusResponse> GetCourseEnrolmentStatus( CourseEnrolmentStatusRequest request )
Parameters
- request
- Type: PASI.DataContract.V2019CourseEnrolmentStatusRequest
The request contains a list of Course Enrolment Id (GUID) and a list of Course Enrolment version numbers the client is aware of (not Course Enrolment Status version).
Return Value
Type: ListCourseEnrolmentStatusResponseA list of CourseEnrolmentStatusResponse object. Each response object may contain one or more CoreAlerts, the source Course Enrolment version number that created this status, and the source Course Enrolment object itself. Each CoreAlert represents a piece of Course Enrolment information that may need correction. For more information on CoreAlerts see the overview section here.
Service Validations
The following codes can be returned from the service operation. This list also shows core alerts that could be generated as a result calling this service. These codes are in addition to the standard set of codes that can be returned defined as in the Approach to Error Reporting. Click the link for the details.
40150, 40202, 40203, 40205, 40206, 40207, 40208, 40210, 40211, 40212, 40214, 40215, 40216, 40221, 40222, 40229, 40233, 40238, 40239, 40240, 40241, 40242, 40243, 40244, 40245, 40246, 40249, 40251, 40252, 40257, 40261, 40264, 40265, 40266, 40267, 40268, 40269, 40274, 40275, 40276, 40277, 40278, 40287, 40288, 40298, 40347, 42000, 42001, 42002, 42003, 42004, 61010, 61011Remarks
This service will return one or more CourseEnrolmentStatus objects. These represent the current core alerts attached to each Course Enrolment record in the PASI core. This information can then be used to create end user work items when data changes are required.
The CourseEnrolmentStatusResponse object will contains the source Course Enrolment object if the KnownCourseEnrolmentVersion in the request is not equal to the version used to calculate the status (this may result in PASI retrieving the proper version of the Course Enrolment from the Shadow table). If the KnownCourseEnrolmentVersion is equal to the current version or the current version was not used (KnownEvaluatedMarkVersion is null) to create the current status (Course Enrolment is newer) than nothing is returned.
The process that generates the Status object in PASI core is asynchronous. This process is initiated by submitting an Course Enrolment (calling SubmitCourseEnrolment) but the completion is dependent on the number of Course Enrolments being submitted at the time by all PASI clients. With this in mind the best strategy for obtaining the status object as soon as available is through the use of the IsDataAvailable service. Even if there are no issues with an Course Enrolment a status object will still be generated.
Since the business rules surrounding an Course Enrolment are dependent on more than just the information supplied by the Course Enrolment an Course Enrolment Status object can change even if the Course Enrolment doesn't. Below is a list of actions that can trigger an Course Enrolment Status to be updated in PASI core:
- Course Enrolment – Submitting an update to the Course Enrolment
- Student School Enrolment – Any of the submit Student School Enrolment services are called
- SchoolCalendarYear – PASI core receives an update to a calendar from the Ministry
- School – PASI core receives an update to a School from the Ministry
- SchoolAuthority – PASI core receives an update to a School Authority from the Ministry
- Course Enrolment Status Acknowledgment - By Acknowledging a core alert the status object is regenerated so the version number is increase and it will be synchronized.
Request and Response Class Diagram
Request Fields
| Full Property Name | Type | Required | Other Attributes |
|---|---|---|---|
| CallerInfo | CallerInfo | Yes | |
| CallerInfo.ClientMessageID | String | Yes | Value must be no more than 50 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF] |
| CallerInfo.SentUtcTime | DateTime | Yes | |
| CallerInfo.Software | Software | Yes | |
| CallerInfo.Software.BuildNumber | String | Yes | Value must be no more than 30 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF] |
| CallerInfo.Software.Manufacturer | String | Yes | Value must be no more than 100 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF] |
| CallerInfo.Software.Product | String | Yes | Value must be no more than 100 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF] |
| CallerInfo.Software.Version | String | Yes | Value must be no more than 30 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF] |
| CallerInfo.User | User | Yes | |
| CallerInfo.User.IPAddress | String | Yes | Value must be no more than 50 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF] |
| CallerInfo.User.LocalID | String | Yes | Value must be no more than 50 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF] |
| CallerInfo.User.Name | String | Yes | Value must be no more than 100 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF] |
| CallerInfo.User.OrganizationCode | String | Yes | Value must be no more than 6 characters |
| CourseEnrolmentIds | List<StatusRefIdVersionInfo> | Yes | |
| CourseEnrolmentIds.ExpectedVersion | Nullable`1 | No | |
| CourseEnrolmentIds.KnownSourceVersion | Nullable`1 | No | |
| CourseEnrolmentIds.RefId | Guid | Yes |
Response Fields
See Also