IPASISystemGetAPOPStudent Method Provincial Approach to Student Information API
This service return an APOPStudent record

Namespace: PASI.ServiceContract
Assembly: PASI.ServiceContract (in PASI.ServiceContract.dll) Version: 9.28.37.5 (9.28.37.5)
Syntax
Copy
APOPStudentInfo GetAPOPStudent(
	APOPStudentGetRequest request
)

Parameters

request
Type: PASI.DataContract.SystemAPOPStudentGetRequest

Return Value

Type: APOPStudentInfo

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
APOPStudentIDNullable`1No
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
StudentIDNullable`1No


Response Fields

Full Property NameTypeRequiredOther Attributes
APOPStudentInfo.AccessCodeStringYes
APOPStudentInfo.APOPStudentIDInt32Yes
APOPStudentInfo.EducationAccountIdentifierInt32Yes
APOPStudentInfo.IsSharingBooleanYes
APOPStudentInfo.LastAccessOnUtcTimeNullable`1No
APOPStudentInfo.LastUpdateUtcTimeDateTimeYes
APOPStudentInfo.LastVerifiedUtcTimeNullable`1No
APOPStudentInfo.PASICoreVersionInt64Yes
APOPStudentInfo.StudentIDInt32Yes
See Also

Reference

IPASISystem Interface
PASI.ServiceContract Namespace