This service will return the responsible school status objects based on the responsible school Id(s) passed in.
Namespace: PASI.ServiceContract
Assembly: PASI.ServiceContract (in PASI.ServiceContract.dll) Version: 9.23.3.0 (9.23.3.0)
Syntax
List<ResponsibleSchoolStatusResponse> GetResponsibleSchoolStatus( ResponsibleSchoolStatusRequest request )
Parameters
- request
- Type: PASI.DataContract.V2019ResponsibleSchoolStatusRequest
The request contains a list of responsible school RefIds the client wishes to retrieve status object for.
Return Value
Type: ListResponsibleSchoolStatusResponseA list of ResponsibleSchoolStatusResponse object. Each response object may contain one or more CoreAlerts. Each CoreAlert represents a piece of 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.
11620, 11621, 11623, 11625Remarks
This service will return one or more ResponsibleSchoolStatus objects. These represent the current core alerts attached to each repsonbible school record in the PASI core. This information can then be used to create end user work items when data changes are required.
The process that generates the Status object in PASI core is asynchronous. This process is initiated by submitting an responsible school (calling SubmitResponsible) but the completion is dependent on the number of 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 enrolment a status object will still be generated.
Since the business rules surrounding an enrolment are dependent on more than just the information supplied by the enrolment an enrolment status object can change even if the enrolment doesn't. Below is a list of actions that can trigger an enrolment status to be updated in PASI core:
- Responsible School – Submitting an update to the Responsible School
- Enrolment – Submitting an update to the enrolment
- Deceased Student – the submit deceased student services are called
- Responsible School 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 |
| ResponsibleSchoolIds | List<StatusRefIdVersionInfo> | Yes | |
| ResponsibleSchoolIds.ExpectedVersion | Nullable`1 | No | |
| ResponsibleSchoolIds.KnownSourceVersion | Nullable`1 | No | |
| ResponsibleSchoolIds.RefId | Guid | Yes |
Response Fields
See Also