This service will allow a PASI Client to request a refresh of the code values that are stored
within PASI Core.
Namespace: PASI.ServiceContract
Assembly: PASI.ServiceContract (in PASI.ServiceContract.dll) Version: 9.25.26.0 (9.25.26.0)
Syntax
Parameters
- request
- Type: PASI.DataContract.V201305CodeValuesRequest
The request contains a value indicating the Last Known Source Version of the code values for the client. If a non-zero Last Known Source Version is specified, then a non-empty result will be returned if and only if there is at least one code value that has a newer PASI Core Version than the Last Known Source Version. If a zero Last Known Source Version is specified then a result is always returned.
Return Value
Type: CodeValuesResponseThe response contains a list of code value items.
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 |
| LastKnownSourceVersion | Int64 | Yes |
Response Fields
| Full Property Name | Type | Required | Other Attributes |
|---|---|---|---|
| CodeValuesResponse.CodeValues | List<CodeValueInfo> | Yes | |
| CodeValuesResponse.CodeValues.CodeClassName | String | Yes | |
| CodeValuesResponse.CodeValues.CodeText | String | Yes | |
| CodeValuesResponse.CodeValues.Description | String | No | |
| CodeValuesResponse.CodeValues.DisplaySequence | Int32 | Yes | |
| CodeValuesResponse.CodeValues.EffectiveSchoolYear | Nullable`1 | No | |
| CodeValuesResponse.CodeValues.ExpirySchoolYear | Nullable`1 | No | |
| CodeValuesResponse.CodeValues.FrenchDescription | String | No | |
| CodeValuesResponse.CodeValues.FrenchShortDescription | String | Yes | |
| CodeValuesResponse.CodeValues.PASICoreVersion | Int64 | Yes | |
| CodeValuesResponse.CodeValues.ShortDescription | String | Yes |
See Also