Obtaining PASI Code Values

When Integrating with PASI, integrated solutions will need to understand the code values used in the services.

Services

Architectural Considerations

The following questions should be considered when Obtaining PASI Code Values.

What approach will the solution use to obtain code values from PASI?

The PASI Get Code Values service allows an integrated solution to obtain all PASI current code value definitions. Synchronization of PASI Code values is NOT accomplished via Is Data Available. Only the Get Code Values service is required to synchronize PASI Code Values.

The Get Code Values service allows an integrated solution to specify a Last Known Source Version parameter. When this parameter is used, the Get Code Values service will only return new or updated Code Values that have a higher version number.

After PASI Code Value data is initially synchronized (Last Known Source Version set to zero), an integrated solution must call the Get Code Values service once a day setting the Last Known Source Version accordingly to obtain Code Value changes. If for whatever reason a complete refresh of PASI Code Value data is required, the Last Known Source Version parameter must be set to zero.

PASI recommends:

  • PASI Code Values data be fully synchronized so integrated solutions has a full list of valid code values.
  • PASI Code Values data be used for UI code value selection and when such data changes it will be automatically reflected in the UI code value selection.
  • A daily refresh of PASI code values in the local copy of PASI data using the Get Code Values service.

What approach will be used by the solution to manage accepted school years?

In addition to Code values, the Get Code Value service also returns PASI configuration information such as which are PASI’s current, historical, and future school years. These school years can be used to determing which school years PASI is accepting School Enrolment submissions.

What approach will be used by the solution to identify the Quality Level of Source Document Types?

The PASI Get Source Document Type Quality Values service allows an integrated solution to obtain quality level information for all source document types accepted by PASI. Quality level information identifies which document types may require a document number to be supplied when updating PASI. Quality level information also is also used to help prevent entry of a lower quality level document type than currently recorded for a student. PASI will reject attempted updates to a lower quality level document type than currently recorded for a student.

Synchronization of PASI Source Document Type Quality Values is NOT accomplished via IsDataAvailable. The Get Source Document Type Quality Values service must be used to synchronize PASI Source Document Type Quality Values.

The Get Source Document Type Quality Values service allows an integrated solution to specify a Last Known Source Version parameter. When this parameter is used, the Get Source Document Type Quality Values service will only return new or updated Source Document Type Quality Values that have a higher version number.

After PASI Get Source Document Type Quality Values data is initially synchronized (Last Known Source Version set to zero), an integrated solution must call the Get Source Document Type Quality Values service once a day setting the Last Known Source Version accordingly to obtain Source Document Type Quality Values changes. If for whatever reason a complete refresh of PASI Get Source Document Type Quality Values data is required, the Last Known Source Version parameter must be set to zero.

PASI recommends PASI Get Source Document Type Quality Values data be fully synchronized so a full list of Source Document Type Quality Values is available.

PASI recommends daily refresh of PASI Source Document Quality Values in the local copy of PASI data using the Get Source Document Quality Values service.

What approach will be used by the solution to identify the Acceptable Formats for each Accommodation Type?

The PASI Get Accommodation Type Relationship Values service allows an integrated solution to obtain a list of Accommodation Format codes applicable to each Accommodation Type. Such will be required to help ensure valid Accommodation Type and Format data is submitted to PASI.

Synchronization of Accommodation Type Format data is NOT accomplished via IsDataAvailable. The Get Accommodation Type Relationship Values service must be used to synchronize PASI Accommodation Type Format data.

PASI recommends daily refresh of PASI Accommodation Type Format data in the local copy of PASI data using the Get Accommodation Type Relationship Values service.

What approach will be used by the solution to identify the acceptable Partner Post-Secondary Institutions?

The PASI Get Partner Post Secondary Institutions service allows an integrated solution to obtain a list of Post-Secondary Institutions with which student can have dual school/post-secondary course enrolments.

Synchronization of Partner Post Secondary Institutions data is NOT accomplished via Is Data Available. The Get Partner Post Secondary Institutions service must be used to synchronize Partner Post Secondary Institutions.

PASI recommends daily refresh of PASI Partner Post Secondary Institutions data in the local copy of PASI data using the Get Partner Post Secondary Institutions service.