IPESCService201604BeginRetrieveTranscript Method

Provincial Approach to Student Information API

This method is called to retrieve a high school transcript or a set of high school transcripts. For an overview of how PASI provides electronic transcripts please see Electronic Transcript Integration. For more information about this method please see Retrieve Transcripts.

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

Syntax

Copy

IAsyncResult BeginRetrieveTranscript(
	RetrieveParameters parameters,
	AsyncCallback callback,
	Object asyncState
)

Function BeginRetrieveTranscript ( 
	parameters As RetrieveParameters,
	callback As AsyncCallback,
	asyncState As Object
) As IAsyncResult

Parameters

parameters: Type: PASI.DataContract.PescRetrieveParameters
The parameters specify the transcripts that should be returned
callback: Type: SystemAsyncCallback
asyncState: Type: SystemObject

Return Value

Type: IAsyncResult
The transcript or set of transcripts as requested or rejections

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

Since this is a server side asynchronous method the name exposed to the client is RetrieveTranscript. There are two 'extra' arguments to support the asynchronous service the PASI client will not see. The name from the documentation will appear as "BeginRetrieveTranscript" but the WSDL will only expose RetrieveTranscript and that is the method that clients should call.

Request and Response Class Diagram

Request Fields

Full Property Name	Type	Required	Other Attributes
CallerInfo	CallerInfo	Yes
CallerInfo.ClientMessageID	String	Yes	Value 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.SentUtcTime	DateTime	Yes
CallerInfo.Software	Software	Yes
CallerInfo.Software.BuildNumber	String	Yes	Value 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.Manufacturer	String	Yes	Value 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.Product	String	Yes	Value 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.Version	String	Yes	Value 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.User	User	Yes
CallerInfo.User.IPAddress	String	Yes	Value 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.LocalID	String	Yes	Value 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.Name	String	Yes	Value 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.OrganizationCode	String	Yes	Value must be no more than 6 characters
ElectronicFormat	String	No
MaxPASICoreVersion	Nullable`1	No
RequestInstitutionId	String	No
RequestTrackingId	String	No
WaitTimeInSeconds	Int32	Yes

Response Fields

Full Property Name	Type	Required
RetrieveResult.Rejections	List<Rejection>	No
RetrieveResult.Rejections.Code	String	Yes
RetrieveResult.Rejections.Description	String	Yes
RetrieveResult.Transcripts	List<Transcript>	Yes
RetrieveResult.Transcripts.ElectronicDocument	String	Yes
RetrieveResult.Transcripts.ElectronicDocumentId	String	Yes
RetrieveResult.Transcripts.ElectronicFormat	String	Yes
RetrieveResult.Transcripts.PASICoreVersion	Nullable`1	No

Reference

IPESCService201604 Interface

PASI.ServiceContract Namespace