IPASIService2021GetEducationAccountConnection Method Provincial Approach to Student Information API
Ministry only service. This service will return a list of Education Account Connections.

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

List<EducationAccountConnectionResponse> GetEducationAccountConnection(
	EducationAccountConnectionRequest request
)

Parameters

request
Type: PASI.DataContract.V201507EducationAccountConnectionRequest
The request contains a list of Education Account Connection RefIds.

Return Value

Type: ListEducationAccountConnectionResponse
The response contains a list of Education Account Connection information.

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
EducationAccountConnectionIdsList<EntityRefIdVersionInfo>Yes
EducationAccountConnectionIds.ExpectedVersionNullable`1No
EducationAccountConnectionIds.RefIdGuidYes


Response Fields

Full Property NameTypeRequiredOther Attributes
List<EducationAccountConnectionResponse>List<EducationAccountConnectionResponse>No
List<EducationAccountConnectionResponse>.AvailabilityStatusStringNo
List<EducationAccountConnectionResponse>.EducationAccountConnectionInfoEducationAccountConnectionInfoNo
List<EducationAccountConnectionResponse>.EducationAccountConnectionInfo.ConnectionExpiresOnNullable`1No
List<EducationAccountConnectionResponse>.EducationAccountConnectionInfo.EducationAccountIdentifierInt32Yes
List<EducationAccountConnectionResponse>.EducationAccountConnectionInfo.IsDisabledBooleanYes
List<EducationAccountConnectionResponse>.EducationAccountConnectionInfo.IsSelfConnectionBooleanYes
List<EducationAccountConnectionResponse>.EducationAccountConnectionInfo.PASICoreVersionInt64Yes
List<EducationAccountConnectionResponse>.EducationAccountConnectionInfo.RefIdGuidYes
List<EducationAccountConnectionResponse>.EducationAccountConnectionInfo.StateProvinceIdStringYes
See Also

Reference