IPASIService2017GetCredentialDefinitions Method Provincial Approach to Student Information API
This service will allow a PASI Client to request a refresh of the credential definitions that are stored within PASI Core.

Namespace: PASI.ServiceContract
Assembly: PASI.ServiceContract (in PASI.ServiceContract.dll) Version: 9.23.3.0 (9.23.3.0)
Syntax

CredentialDefinitionsResponse GetCredentialDefinitions(
	CredentialDefinitionsRequest request
)

Parameters

request
Type: PASI.DataContract.V201305CredentialDefinitionsRequest
The request contains a value indicating the Last Known Source Version of the credential definitions 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 credential definition 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: CredentialDefinitionsResponse
The response contains a list of credential definition 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 NameTypeRequiredOther Attributes
CallerInfoCallerInfoYes
CallerInfo.ClientMessageIDStringYesValue 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.SentUtcTimeDateTimeYes
CallerInfo.SoftwareSoftwareYes
CallerInfo.Software.BuildNumberStringYesValue 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.ManufacturerStringYesValue 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.ProductStringYesValue 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.VersionStringYesValue 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.UserUserYes
CallerInfo.User.IPAddressStringYesValue 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.LocalIDStringYesValue 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.NameStringYesValue 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.OrganizationCodeStringYesValue must be no more than 6 characters
LastKnownSourceVersionInt64Yes


Response Fields

Full Property NameTypeRequiredOther Attributes
CredentialDefinitionsResponse.CredentialDefinitionsList<CredentialDefinitionInfo>Yes
CredentialDefinitionsResponse.CredentialDefinitions.CodeTextStringYes
CredentialDefinitionsResponse.CredentialDefinitions.CredentialRequirementSetsList<CredentialDefinitionRequirementSetInfo>Yes
CredentialDefinitionsResponse.CredentialDefinitions.CredentialRequirementSets.CodeTextStringYes
CredentialDefinitionsResponse.CredentialDefinitions.CredentialRequirementSets.CredentialRequirementsList<CredentialDefinitionRequirementInfo>Yes
CredentialDefinitionsResponse.CredentialDefinitions.CredentialRequirementSets.CredentialRequirements.ClientCanManuallySetAchievementBooleanYes
CredentialDefinitionsResponse.CredentialDefinitions.CredentialRequirementSets.CredentialRequirements.CodeTextStringYes
CredentialDefinitionsResponse.CredentialDefinitions.CredentialRequirementSets.CredentialRequirements.CredentialRequirementExemptionReasonsList<CredentialDefinitionRequirementExemptionReasonInfo>Yes
CredentialDefinitionsResponse.CredentialDefinitions.CredentialRequirementSets.CredentialRequirements.CredentialRequirementExemptionReasons.ClientCanApproveExemptionRequestBooleanYes
CredentialDefinitionsResponse.CredentialDefinitions.CredentialRequirementSets.CredentialRequirements.CredentialRequirementExemptionReasons.ClientCanSubmitApprovedExemptionBooleanYes
CredentialDefinitionsResponse.CredentialDefinitions.CredentialRequirementSets.CredentialRequirements.CredentialRequirementExemptionReasons.ClientCanSubmitExemptionRequestBooleanYes
CredentialDefinitionsResponse.CredentialDefinitions.CredentialRequirementSets.CredentialRequirements.CredentialRequirementExemptionReasons.CodeTextStringYes
CredentialDefinitionsResponse.CredentialDefinitions.CredentialRequirementSets.CredentialRequirements.CredentialRequirementExemptionReasons.DescriptionStringYes
CredentialDefinitionsResponse.CredentialDefinitions.CredentialRequirementSets.CredentialRequirements.CredentialRequirementExemptionReasons.FrenchDescriptionStringNo
CredentialDefinitionsResponse.CredentialDefinitions.CredentialRequirementSets.CredentialRequirements.CredentialRequirementExemptionReasons.FrenchShortDescriptionStringYes
CredentialDefinitionsResponse.CredentialDefinitions.CredentialRequirementSets.CredentialRequirements.CredentialRequirementExemptionReasons.PASICoreVersionInt64Yes
CredentialDefinitionsResponse.CredentialDefinitions.CredentialRequirementSets.CredentialRequirements.CredentialRequirementExemptionReasons.ShortDescriptionStringYes
CredentialDefinitionsResponse.CredentialDefinitions.CredentialRequirementSets.CredentialRequirements.DescriptionStringYes
CredentialDefinitionsResponse.CredentialDefinitions.CredentialRequirementSets.CredentialRequirements.DisplaySequenceInt32Yes
CredentialDefinitionsResponse.CredentialDefinitions.CredentialRequirementSets.CredentialRequirements.FrenchDescriptionStringYes
CredentialDefinitionsResponse.CredentialDefinitions.CredentialRequirementSets.CredentialRequirements.FrenchShortDescriptionStringYes
CredentialDefinitionsResponse.CredentialDefinitions.CredentialRequirementSets.CredentialRequirements.IsAssessmentTriggerBooleanYes
CredentialDefinitionsResponse.CredentialDefinitions.CredentialRequirementSets.CredentialRequirements.IsManuallyAchievedBooleanYes
CredentialDefinitionsResponse.CredentialDefinitions.CredentialRequirementSets.CredentialRequirements.PASICoreVersionInt64Yes
CredentialDefinitionsResponse.CredentialDefinitions.CredentialRequirementSets.CredentialRequirements.ShortDescriptionStringYes
CredentialDefinitionsResponse.CredentialDefinitions.CredentialRequirementSets.DescriptionStringYes
CredentialDefinitionsResponse.CredentialDefinitions.CredentialRequirementSets.FrenchDescriptionStringYes
CredentialDefinitionsResponse.CredentialDefinitions.CredentialRequirementSets.FrenchShortDescriptionStringYes
CredentialDefinitionsResponse.CredentialDefinitions.CredentialRequirementSets.PASICoreVersionInt64Yes
CredentialDefinitionsResponse.CredentialDefinitions.CredentialRequirementSets.ShortDescriptionStringYes
CredentialDefinitionsResponse.CredentialDefinitions.DescriptionStringYes
CredentialDefinitionsResponse.CredentialDefinitions.FrenchDescriptionStringYes
CredentialDefinitionsResponse.CredentialDefinitions.FrenchShortDescriptionStringYes
CredentialDefinitionsResponse.CredentialDefinitions.PASICoreVersionInt64Yes
CredentialDefinitionsResponse.CredentialDefinitions.ShortDescriptionStringYes
See Also

Reference