IPASIService2020GetPatResultIsp Method Provincial Approach to Student Information API
This service returns Provincial Achievement Test Result Individual Student Profile (ISP) PDF reports.

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

PatResultIspResponse GetPatResultIsp(
	PatResultIspRequest request
)

Parameters

request
Type: PASI.DataContract.V2019PatResultIspRequest
Provides the set of ASNs for which the report should be generated along with the language and school year to use.

Return Value

Type: PatResultIspResponse
A set of Base64 encoded PDF reports for all ASNs that did not fail validation.

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, 9077, 60002, 60003, 60095
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
LanguageStringYesValue must be an appropriate DocumentLanguage code value
SchoolYearInt16Yes
StudentInfosList<PatResultIspStudentInfo>YesList must contain no more than 100 items
StudentInfos.StateProvinceIdStringYesValue must be in the form of a number between '000000001' and '999999999'


Response Fields

Full Property NameTypeRequiredOther Attributes
PatResultIspResponse.PatResultIspReportsList<PatResultIspReportInfo>No
PatResultIspResponse.PatResultIspReports.DocumentStringNo
PatResultIspResponse.PatResultIspReports.RejectionsList<Rejection>No
PatResultIspResponse.PatResultIspReports.Rejections.CodeStringYes
PatResultIspResponse.PatResultIspReports.Rejections.DescriptionStringYes
PatResultIspResponse.PatResultIspReports.StateProvinceIdStringNo
PatResultIspResponse.RejectionsList<Rejection>No
PatResultIspResponse.Rejections.CodeStringYes
PatResultIspResponse.Rejections.DescriptionStringYes
See Also

Reference