Table of Contents
Get Code Values
- Will be updated in by F10586
This service provides a mechanism that allows the PASI Client to request a refresh of the code values that are stored within PASI Core.
Security
The service can be accessed by systems with the Hello World User role. Essentially any system that can access PASI Core can utilize this service.
Request Information
The following information is provided when using this service (* denotes mandatory information):
- Last Known Source Version*
Request Validations
There are no validations performed on the service request.
Service Functionality
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.
If a result is returned then it is a full result. There is no additional filtering of the results.
Inclusion of CIA Code Types
CIA code class data stored in PASI is returned as part of the Get Code Values response. The data elements in the CIA Code Tables are mapped to existing Get Code Values Response data elements as shown below:
| Get Code Values Response Elements | CIA Type Table Data Elements | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Code Class Name (30) | CIA Code Class Names map to the following Code Class Names:
|
||||||||||||||||||||||||
| Code Text (50) | cd | ||||||||||||||||||||||||
| Short Description (50) | Desc | ||||||||||||||||||||||||
| Description (160) | use_desc | ||||||||||||||||||||||||
| French Short Description (50) | french_desc, otherwise blank. | ||||||||||||||||||||||||
| French Description (160) | Blank | ||||||||||||||||||||||||
| Display Sequence | 0 | ||||||||||||||||||||||||
| PASICore Version | Set to allow the School to be able to subsequently request incremental changes for CIA Type data. | ||||||||||||||||||||||||
| Effective School Year | Start School Year from the value. | ||||||||||||||||||||||||
| Expiry School Year | End School Year from the value. |
Response Information
The structure of the response has been modeled after the xml structure that was in the previously used CodeTypeList.xml file with some additions.
A successful response to this service will include a list of code types with each code type including the following (* denotes mandatory information):
- Code Class Name*
- Code Text*
- Short Description*
- Description*
- French Short Description*
- French Description
- Display Sequence*
- PASICoreVersion*
- Effective School Year
- Expiry School Year
Related Business Process
- No links found.
Related Functionality
- No links found.