IPASISystemSubmitRequestForRecordAccess Method Provincial Approach to Student Information API
Submits a request to gain access to a student's digital record.

Namespace: PASI.ServiceContract
Assembly: PASI.ServiceContract (in PASI.ServiceContract.dll) Version: 9.23.3.0 (9.23.3.0)
Syntax
Copy
SubmitResponse SubmitRequestForRecordAccess(
	SubmitRecordAccessRequest request
)

Parameters

request
Type: PASI.DataContract.SystemSubmitRecordAccessRequest

Return Value

Type: SubmitResponse
A SubmitResponse with the new PASICoreVersion value after a successful update and the Id, or with Rejections after an unsuccessful update.

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, 9011, 11037, 60002, 60003, 65076, 65077, 65078, 65082, 65083, 65084, 65086, 65094, 65140
Remarks

If the service encounters any errors during the submission process, it returns a list of rejections and no changes are saved.

Request and Response Class Diagram



Request Fields

Full Property NameTypeRequiredOther Attributes
ApproximateSchoolYearNullable`1No
BirthdateDateTimeYes
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
ConfirmedStateProvinceIdStringNo
DeclineReasonCodeStringNoValue must be an appropriate StudentRecordDeclineReason code value
IncludedDocumentsSubmitRecordAccessDocumentInfoNo
IncludedDocuments.IncludeDetailedAcademicReportBooleanNo
IncludedDocuments.ProvincialAchievementTestSchoolYearsList<Int16>No
IncludedDocuments.StudentDocumentRefIdsList<Guid>No
LastAttendedAlbertaSchoolCodeStringYesValue must be in the form of a number between '0001' and '9999'
LastGradeCodeStringNoValue must be an appropriate GradeCode code value
PASICoreVersionInt64Yes
ReasonCodeStringYesValue must be an appropriate StudentRecordRequestReason code value
RecordAccessRequestIdInt32Yes
RequestedByEducationAccountIdentiferInt32Yes
RequestorEmailAddressStringYesValue must be no more than 255 characters Value must not contain invalid characters
RequestorExtensionStringNoValue must be no more than 7 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]
RequestorFirstNameStringYesValue 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]
RequestorJobTitleStringYesValue 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]
RequestorLastNameStringYesValue 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]
RequestorMiddleNameStringNoValue 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]
RequestorOrganizationStringYesValue must be no more than 255 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]
RequestorPhoneNumberStringYesValue must be no more than 16 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]
SchoolCityStringNoValue must be no more than 60 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]
SchoolCountryStringNoValue must be no more than 60 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]
SchoolStateProvinceStringNoValue must be no more than 20 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]
StateProvinceIdStringNo
StatusCodeStringYesValue must be an appropriate StudentRecordRequestStatus code value
StudentFirstNameStringYesValue 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]
StudentLastNameStringYesValue 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]
StudentMiddleNameStringNoValue 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]


Response Fields

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

Reference

IPASISystem Interface
PASI.ServiceContract Namespace