IPASISystemSubmitStudentStateProvinceIdStatus Method Provincial Approach to Student Information API
Ministry only service. This service is used by the Ministry Client when the Alberta Student Number (ASN) assigned to a student record has become ambiguous. This service can be used link or unlink 2 ASNs, or to deactivate or reactivate an ASN.

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

SubmitResponse SubmitStudentStateProvinceIdStatus(
	SubmitStateProvinceIdStatusRequest request
)

Parameters

request
Type: PASI.DataContract.V2009SubmitStateProvinceIdStatusRequest
The request identifies the ASN whose status needs to be modified. This service can change the status of an ASN to: Primary, Secondary, or Deactivated.

Return Value

Type: SubmitResponse
The standard SubmitResponse is returned. The Id and PASICoreVersion will be the StateProvinceId of the Student that was acted on.

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.

9010, 9052, 9056, 11408, 11451, 11452, 11453, 11454, 11455, 11456, 11457, 11458, 11459, 11460, 11461, 11462, 11463, 11464, 11466, 11467, 11468, 11469, 11471, 11472, 11473, 11474, 11475, 11476
Remarks

StatusDescription
Primary

A Primary ASN is the ASN that should be used when referencing a particular student.

Secondary

A Secondary ASN is an ASN that has been linked to a particular student, but is not the ASN that should be used.

Deactivated

A Deactivated ASN is an ASN that should no longer be used for any reason.


Primary
Status

"Primary"

StateProvinceId

ASN being set to Primary

PASICoreVersion

Core version of the ASN being set to Primary

PrimaryStateProvinceId

[Not Applicable]

PrimaryStudentPASICoreVersion

[Not Applicable]


Secondary
Status

"Secondary"

StateProvinceId

ASN being set to Secondary.

PASICoreVersion

Core version of the ASN being set to Secondary.

PrimaryStateProvinceId

ASN which is currently the Primary.

PrimaryStudentPASICoreVersion

Core version of the Primary ASN.


Deactivated
Status

"Deactivated"

StateProvinceId

ASN being set to Deactivated

PASICoreVersion

Core version of the ASN being set to Deactivated.

PrimaryStateProvinceId

[Not Applicable]

PrimaryStudentPASICoreVersion

[Not Applicable]

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
PrimaryStateProvinceIdStringNoValue must be in the form of a number between '000000001' and '999999999'
PrimaryStudentPASICoreVersionInt64No
StateProvinceIdStringYesValue must be in the form of a number between '000000001' and '999999999'
StatusStringYesValue must be an appropriate StateProvinceIdStatus code value
StudentPASICoreVersionInt64Yes


Response Fields

Full Property NameTypeRequiredOther Attributes
SubmitResponse.IdStringNo
SubmitResponse.PASICoreVersionInt64No
SubmitResponse.RejectionsList<Rejection>No
SubmitResponse.Rejections.CodeStringYes
SubmitResponse.Rejections.DescriptionStringYes
See Also

Reference