IPASIService2021GetDiplomaExam Method Provincial Approach to Student Information API
This service will return the Exam(s) based on the Exam Id(s) passed in.

Namespace: PASI.ServiceContract
Assembly: PASI.ServiceContract (in PASI.ServiceContract.dll) Version: 9.25.26.0 (9.25.26.0)
Syntax
Copy
List<DiplomaExamResponse> GetDiplomaExam(
	DiplomaExamRequest request
)

Parameters

request
Type: PASI.DataContract.V201602DiplomaExamRequest
The request contains a list of Exam Ids the client wishes to retrieve.

Return Value

Type: ListDiplomaExamResponse
The response contains a list of Exams.

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
This service is intended to be used during the data synchronization process using the IsDataAvailable service. See the Expected Versions section for important details on how this service will return data.

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
ExamIdsList<EntityRefIdVersionInfo>Yes
ExamIds.ExpectedVersionNullable`1No
ExamIds.RefIdGuidYes


Response Fields

Full Property NameTypeRequiredOther Attributes
List<DiplomaExamResponse>List<DiplomaExamResponse>No
List<DiplomaExamResponse>.AvailabilityStatusStringNo
List<DiplomaExamResponse>.ExamDiplomaExamInfoNo
List<DiplomaExamResponse>.Exam.CourseCodeStringYesValue must be 7 characters
List<DiplomaExamResponse>.Exam.EffectiveUtcDateTimeNo
List<DiplomaExamResponse>.Exam.EnglishFootnoteStringNoValue must be no more than 255 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Value must not contain empty lines and each line must be delimited with a carriage return and line feed. Content must not match regular expression: [\x00-\x08]|[\x0E-\x19]|[\x7F-\x9F]|[^\x00-\xFF]|(^|\n)\s*\r|\n\s*(\r|$)|[^\r]\n|\r[^\n]
List<DiplomaExamResponse>.Exam.ExamComponentsList<ExamComponentInfo>Yes
List<DiplomaExamResponse>.Exam.ExamComponents.ComponentCodeStringYesValue must be no more than 6 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] Value must be uppercase.
List<DiplomaExamResponse>.Exam.ExamComponents.ComponentNameStringYesValue must be no more than 40 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]
List<DiplomaExamResponse>.Exam.ExamComponents.FrenchComponentNameStringYesValue 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]
List<DiplomaExamResponse>.Exam.ExamComponents.IsMarkReportableBooleanYes
List<DiplomaExamResponse>.Exam.ExamComponents.ScheduledUtcTimeDateTimeNo
List<DiplomaExamResponse>.Exam.ExamComponents.WeightPercentageDecimalYes
List<DiplomaExamResponse>.Exam.ExamLanguageStringYesValue must be an appropriate LanguageOfExam code value
List<DiplomaExamResponse>.Exam.ExamPeriodStringYesValue must be an appropriate ExamPeriod code value
List<DiplomaExamResponse>.Exam.ExamTypeStringYesValue must be an appropriate ExamType code value
List<DiplomaExamResponse>.Exam.FrenchFootnoteStringNoValue must be no more than 255 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Value must not contain empty lines and each line must be delimited with a carriage return and line feed. Content must not match regular expression: [\x00-\x08]|[\x0E-\x19]|[\x7F-\x9F]|[^\x00-\xFF]|(^|\n)\s*\r|\n\s*(\r|$)|[^\r]\n|\r[^\n]
List<DiplomaExamResponse>.Exam.IsDeletedBooleanYes
List<DiplomaExamResponse>.Exam.MarkFormatStringYesValue must be an appropriate MarkFormat code value
List<DiplomaExamResponse>.Exam.PASICoreVersionInt64Yes
List<DiplomaExamResponse>.Exam.RefIdGuidYes
List<DiplomaExamResponse>.Exam.RegistrationDeadlineUtcDateTimeYes
List<DiplomaExamResponse>.Exam.RescoreDeadlineDateDateTimeYes
List<DiplomaExamResponse>.Exam.SchoolYearInt16YesValue must be between 1900 and 2100
See Also

Reference

IPASIService2021 Interface
PASI.ServiceContract Namespace