Get Credential Definitions

This service provides a mechanism that allows the PASI Client to obtain the current definitions of the credentials, credential requirement sets and the embedded requirements, which PASI currently supports.

Security

This 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

A request to use this service will include (* 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 record 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 credential, a partial credential definition is never returned. There is no additional filtering of the results.

Response Information

A successful response to this service will include:

  • An alphabetically sorted list of Credentials each containing:
    • An alphabetically sorted list of Credential Requirement Sets each containing:
      • An alphabetically sorted list of Credential Requirements each potentially containing:
        • An alphabetically sorted list of Credential Requirement Exemption Reasons.

Elements in Response for each Credential

Each Credential in the response will include the following (* denotes mandatory information):

  • Credential Code Text*
  • Credential Code Short Description*
  • Credential Code Description*
  • Credential Code French Short Description*
  • Credential Code French Description*
  • PASICoreVersion* (comes from code table)
  • A list of Credential Requirement Sets*

Elements in Response for each Credential Requirement Set

Each Credential Requirement Set in the response will include the following (* denotes mandatory information):

  • Credential Requirement Set Code Text*
  • Credential Requirement Set Code Short Description*
  • Credential Requirement Set Code Description*
  • Credential Requirement Set Code French Short Description*
  • Credential Requirement Set Code French Description*
  • PASICoreVersion* (max from code table and mapping to credential)
  • A list of Credential Requirements*

Elements in Response for each Credential Requirement

Each Credential Requirement in the response will include the following (* denotes mandatory information):

  • Credential Requirement Code Text*
  • Credential Requirement Code Short Description*
  • Credential Requirement Code Description*
  • Credential Requirement Code French Short Description*
  • Credential Requirement Code French Description*
  • Display Sequence*
  • PASICoreVersion* (max from code table, credential requirement relationship, and security credential requirement)
  • Is Assessment Trigger
  • Is Manually Achieved
  • Client Can Manually Set Achievement
  • A list of Credential Requirement Exemption Reasons

Note: “Client Can Manually Set Achievement” is true if the client has the PASI Core security role that can manually set the achievement for the credential requirement. “Client Can Manually Set Achievement” is false for non-Ministry (O.1) users for the HSED Credential StudentRequested-81700 (Credential Requirement)

Elements in Response for each Credential Requirement Exemption Reason

Each Credential Requirement in the response will include the following (* denotes mandatory information):

  • Credential Requirement Exemption Reason Code Text*
  • Credential Requirement Exemption Reason Code Short Description*
  • Credential Requirement Exemption Reason Code Description*
  • Credential Requirement Exemption Reason Code French Short Description*
  • Credential Requirement Exemption Reason Code French Description*
  • PASICoreVersion* (max from code table, credential requirement exemption, and security exemption requirement)
  • Client Can Submit Exemption Request
    • Response will return “true” if the client has the PASI Core security role to submit the credential exemption reason with a status of 'Requested'.
  • Client Can Approve Exemption Request
    • Response will return “true” if the client has the PASI Core security role to update the credential exemption reason with a status of 'Requested' to 'Approved'.
  • Client Can Submit Approved Exemption
    • Response will return “true” if the client has the PASI Core security role to submit the credential exemption reason with a status of 'Approved' and the exemption reason can only be submitted in 'Approved' status (i.e. There is no permission associated to the 'Request' status for the exemption reason.

Notes:

  • Only active (non-expired) exemption reasons will be returned in the response.
  • See Rule 43005 for details as to how the data in the SecurityExemptionReason table defines the permission the client has.
    • There are no duplicate Exemption Reason records in the SecurityExemptionReason table. This means a client that 'Can Submit (an) Approved Exemption' may update the status of the exemption from Requested to Approved OR submit an the exemption reason with a status of Approved. A client cannot do both.
    No links found.
    No links found.

Integrated Consumers

This service is used in the following Integration Points.