IAPOPService2024GetStudentAcademicProfile Method Provincial Approach to Student Information API
This service returns academic information for a student.

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

StudentAcademicProfileResponse GetStudentAcademicProfile(
	StudentAcademicProfileRequest request
)

Parameters

request
Type: PASI.DataContract.Apop.V2024StudentAcademicProfileRequest
Contains AccessCode that is used to identify the student.

Return Value

Type: StudentAcademicProfileResponse
The requested student's academic profile.

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.

66000, 66001, 66002, 66003
Remarks

This service returns the student academic profile for a given AccessCode.

Academic Profile - The academic profile includes all academic records including School Enrolments at schools participating in APOP, Official Marks, and Pathways. time.

Request and Response Class Diagram



Request Fields

Full Property NameTypeRequiredOther Attributes
AccessCodeStringYesValue must be 16 characters Value must only contain alphanumeric characters. Content must match regular expression: ^[a-zA-Z0-9]*$
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


Response Fields

Full Property NameTypeRequiredOther Attributes
StudentAcademicProfileResponse.StudentAcademicProfileStudentAcademicProfileInfoYes
StudentAcademicProfileResponse.StudentAcademicProfile.AccessCodeStringYesValue must be 16 characters Value must only contain alphanumeric characters. Content must match regular expression: ^[a-zA-Z0-9]*$
StudentAcademicProfileResponse.StudentAcademicProfile.LastUpdateUtcTimeDateTimeYes
StudentAcademicProfileResponse.StudentAcademicProfile.OfficialMarksList<OfficialMarkInfo>No
StudentAcademicProfileResponse.StudentAcademicProfile.OfficialMarks.CourseCodeStringYes
StudentAcademicProfileResponse.StudentAcademicProfile.OfficialMarks.CreditsAwardedInt16Yes
StudentAcademicProfileResponse.StudentAcademicProfile.OfficialMarks.EffectiveUtcDateTimeNo
StudentAcademicProfileResponse.StudentAcademicProfile.OfficialMarks.MarkCalculationMethodStringNo
StudentAcademicProfileResponse.StudentAcademicProfile.OfficialMarks.MarkFormatStringNo
StudentAcademicProfileResponse.StudentAcademicProfile.OfficialMarks.MarkStatusStringNo
StudentAcademicProfileResponse.StudentAcademicProfile.OfficialMarks.MarkValueStringNo
StudentAcademicProfileResponse.StudentAcademicProfile.OfficialMarks.PASICoreVersionInt64Yes
StudentAcademicProfileResponse.StudentAcademicProfile.OfficialMarks.SchoolYearInt16No
StudentAcademicProfileResponse.StudentAcademicProfile.OfficialMarks.SelectedMarksList<OfficialMarkSelectionInfo>No
StudentAcademicProfileResponse.StudentAcademicProfile.OfficialMarks.SelectedMarks.MarkSelectionReasonStringYesValue must be an appropriate MarkSelectionReason code value Value must be no more than 50 characters
StudentAcademicProfileResponse.StudentAcademicProfile.OfficialMarks.SelectedMarks.MarkTypeStringYesValue must be an appropriate MarkType code value Value must be no more than 50 characters
StudentAcademicProfileResponse.StudentAcademicProfile.OfficialMarks.SelectedMarks.PASICoreVersionInt64Yes
StudentAcademicProfileResponse.StudentAcademicProfile.OfficialMarks.SelectedMarks.SelectedMarkRefIdGuidYes
StudentAcademicProfileResponse.StudentAcademicProfile.PASICoreVersionInt64No
StudentAcademicProfileResponse.StudentAcademicProfile.PathwayCompletionsList<PathwayCompletionInfo>No
StudentAcademicProfileResponse.StudentAcademicProfile.PathwayCompletions.CompletionDateDateTimeYes
StudentAcademicProfileResponse.StudentAcademicProfile.PathwayCompletions.CompletionSchoolYearInt16Yes
StudentAcademicProfileResponse.StudentAcademicProfile.PathwayCompletions.ContributingCoursesStringNo
StudentAcademicProfileResponse.StudentAcademicProfile.PathwayCompletions.IsDeletedBooleanYes
StudentAcademicProfileResponse.StudentAcademicProfile.PathwayCompletions.LastUpdateUtcTimeDateTimeYes
StudentAcademicProfileResponse.StudentAcademicProfile.PathwayCompletions.PASICoreVersionInt64Yes
StudentAcademicProfileResponse.StudentAcademicProfile.PathwayCompletions.PathwayCodeStringYes
StudentAcademicProfileResponse.StudentAcademicProfile.SchoolEnrolmentRecordsList<StudentSchoolEnrolment>No
StudentAcademicProfileResponse.StudentAcademicProfile.SchoolEnrolmentRecords.EffectiveUtcDateTimeNo
StudentAcademicProfileResponse.StudentAcademicProfile.SchoolEnrolmentRecords.ExitDateTypeStringYesValue must be an appropriate ExitDateType code value
StudentAcademicProfileResponse.StudentAcademicProfile.SchoolEnrolmentRecords.GradeStringYesValue must be an appropriate GradeCode code value
StudentAcademicProfileResponse.StudentAcademicProfile.SchoolEnrolmentRecords.PASICoreVersionInt64Yes
StudentAcademicProfileResponse.StudentAcademicProfile.SchoolEnrolmentRecords.ProgrammingTimeframeStringYesValue must be an appropriate ProgrammingTimeframe code value
StudentAcademicProfileResponse.StudentAcademicProfile.SchoolEnrolmentRecords.ProgrammingTypeStringYesValue must be an appropriate ProgrammingType code value
StudentAcademicProfileResponse.StudentAcademicProfile.SchoolEnrolmentRecords.RefIdGuidYes
StudentAcademicProfileResponse.StudentAcademicProfile.SchoolEnrolmentRecords.RegistrationExitDateDateTimeYes
StudentAcademicProfileResponse.StudentAcademicProfile.SchoolEnrolmentRecords.RegistrationStartDateDateTimeYes
StudentAcademicProfileResponse.StudentAcademicProfile.SchoolEnrolmentRecords.SchoolCodeStringYesValue must be in the form of a number between '0001' and '9999'
StudentAcademicProfileResponse.StudentAcademicProfile.SchoolEnrolmentRecords.SchoolYearInt16YesValue must be between 1900 and 2100
See Also

Reference