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.
Namespace: PASI.ServiceContract
Assembly: PASI.ServiceContract (in PASI.ServiceContract.dll) Version: 9.25.26.0 (9.25.26.0)
Syntax
AcceptedRegistrationStatusResponse GetAcceptedRegistrationStatus( AcceptedRegistrationStatusRequest request )
Parameters
- request
- Type: PASI.DataContract.V2009AcceptedRegistrationStatusRequest
The request containing the school year being requested. All school years can be retrieved by passing zero for the school year.
Return Value
Type: AcceptedRegistrationStatusResponseA list of AcceptedRegistrationStatusInfo objects. If a single year was requested this list will have one value. If the requested school year is not being accepted the school year will be returned but the list of statuses will be empty. If no school year was passed into the request multiple AcceptedRegistrationStatusInfo objects can be returned.
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.
No additional errors for this service.Remarks
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 |
SchoolYear | Int16 | No |
Response Fields
Full Property Name | Type | Required | Other Attributes |
---|---|---|---|
AcceptedRegistrationStatusResponse.RegistrationStatusInfo | List<AcceptedRegistrationStatusInfo> | No | |
AcceptedRegistrationStatusResponse.RegistrationStatusInfo.AcceptedStatuses | List<String> | No | |
AcceptedRegistrationStatusResponse.RegistrationStatusInfo.SchoolYear | Int16 | No |
See Also