This service will return the Section Status objects based on the Section Id(s) passed in.
Namespace: PASI.ServiceContract
Assembly: PASI.ServiceContract (in PASI.ServiceContract.dll) Version: 9.23.3.0 (9.23.3.0)
Syntax
Parameters
- request
- Type: PASI.DataContract.V201204SectionStatusRequest
The request contains a list of Section Id (GUID) and a list of Section version numbers the client is aware of (not Section Status version).
Return Value
Type: ListSectionStatusResponseA list of SectionStatusResponse object. Each response object may contain one or more CoreAlerts, the source Section version number that created this status, and the source Section object itself. Each CoreAlert represents a piece of Section 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.
40101, 40103, 40109, 40110, 40111, 40117, 40119, 40120, 40121, 40122, 40123, 40126, 40128, 40129, 40140, 61012Remarks
This service will return one or more SectionStatus objects. These represent the current core alerts attached to each Section record in the PASI core. This information can then be used to create end user work items when data changes are required.
The SectionStatusResponse object will contains the source Section object if the KnownSectionVersion 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 Section from the Shadow table). If the KnownSectionVersion is equal to the current version or the current version was not used (KnownEvaluatedMarkVersion is null) to create the current status (Section is newer) than nothing is returned.
This service is to be used during the data synchronization process. For more information on the data synchronization process see this section .
The process that generates the Status object in PASI core is asynchronous. This process is initiated by submitting an Section (calling SubmitSection) but the completion is dependent on the number of Sections 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 Section a status object will still be generated.
Since the business rules surrounding an Section are dependent on more than just the information supplied by the Section an Section Status object can change even if the Section doesn't. Below is a list of actions that can trigger an Section Status to be updated in PASI core:
- Section – Submitting an update to the Section
- 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
- Section 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 |
| SectionIds | List<StatusRefIdVersionInfo> | Yes | |
| SectionIds.ExpectedVersion | Nullable`1 | No | |
| SectionIds.KnownSourceVersion | Nullable`1 | No | |
| SectionIds.RefId | Guid | Yes |
Response Fields
See Also