IPASISystemSubmitCredentialAwardingSingle Method Provincial Approach to Student Information API
Ministry only service. This service will award a unique Credential Number to a Student for a single credential type that is Achieved, but not Awarded. Only one Credential Number shall be awarded for the Student within the Submit Credential Awarding Single request.

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

SubmitCredentialResponse SubmitCredentialAwardingSingle(
	SubmitCredentialAwardingSingleRequest request
)

Parameters

request
Type: PASI.DataContract.SystemSubmitCredentialAwardingSingleRequest
The request contains an Alberta Student Number, School Year, Credential, and optional Legacy Credential Number.

Return Value

Type: SubmitCredentialResponse
The response identifies whether a change was successfully applied including information on Credential Number, PASI Version Number, and ASN. If not, the response returns a list of rejections.

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.

9002, 44000, 44004, 44009, 44010, 44013, 44014
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
CredentialStringYesValue must be an appropriate Credential code value
LegacyCredentialNumberStringNoValue must be no more than 14 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]
PASICoreVersionInt64Yes
SchoolYearInt16YesValue must be between 1900 and 2100
StateProvinceIdStringYesValue must be in the form of a number between '000000001' and '999999999'


Response Fields

Full Property NameTypeRequiredOther Attributes
SubmitCredentialResponse.AwardedSchoolYearNullable`1No
SubmitCredentialResponse.CredentialNumberInt64Yes
SubmitCredentialResponse.CredentialTypeStringNo
SubmitCredentialResponse.PASICoreVersionInt64No
SubmitCredentialResponse.RejectionsList<Rejection>No
SubmitCredentialResponse.Rejections.CodeStringYes
SubmitCredentialResponse.Rejections.DescriptionStringYes
SubmitCredentialResponse.StateProvinceIdStringYes
See Also

Reference