IPASIService2017GetGedExamMark Method Provincial Approach to Student Information API
This service is used to retrieve GED Exam Marks from PASI Core.

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

List<GedExamMarkResponse> GetGedExamMark(
	GedExamMarkRequest request
)

Parameters

request
Type: PASI.DataContract.V201602GedExamMarkRequest
A list of GED Exam Mark Reference IDs for the all GED Exam Mark records being requested.

Return Value

Type: ListGedExamMarkResponse
Information for each of the GED Exam Mark records identified in the request.

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

Information for each of the GED Exam Mark records identified in the request will be retrieved from the PASI Core and returned in the response. If a list of records has been requested, they will be processed in the order provided. If the Expected Version is provided, the GED Exam Mark will only be returned if the version of the record in PASI is equal to the Expected Version.If the version in PASI is greater than the Expected Version, the Exam Mark will not be returned, and no further records will be returned. The service will return responses on GED Exam Marks only on the students associated to the PASI Client via Recent School Enrolment or better.

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


Response Fields

Full Property NameTypeRequiredOther Attributes
List<GedExamMarkResponse>List<GedExamMarkResponse>No
List<GedExamMarkResponse>.AvailabilityStatusStringNo
List<GedExamMarkResponse>.ExamMarkInfoGedExamMarkInfoNo
List<GedExamMarkResponse>.ExamMarkInfo.CourseCodeStringYesValue must be 7 characters
List<GedExamMarkResponse>.ExamMarkInfo.EffectiveUtcDateTimeNo
List<GedExamMarkResponse>.ExamMarkInfo.ExamLanguageStringNoValue must be an appropriate LanguageOfExam code value
List<GedExamMarkResponse>.ExamMarkInfo.ExamSeriesStringNoValue must be an appropriate ExamSeries code value
List<GedExamMarkResponse>.ExamMarkInfo.ExamWrittenOnDateDateTimeNo
List<GedExamMarkResponse>.ExamMarkInfo.FormStringNoValue 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]
List<GedExamMarkResponse>.ExamMarkInfo.FormatStringNoValue must be an appropriate GEDTestFormat code value
List<GedExamMarkResponse>.ExamMarkInfo.IsDeletedBooleanNo
List<GedExamMarkResponse>.ExamMarkInfo.JurisdictionStringNoValue must be an appropriate GEDJurisdiction code value
List<GedExamMarkResponse>.ExamMarkInfo.MarkStatusStringNoValue must be an appropriate GEDExamMarkStatus code value
List<GedExamMarkResponse>.ExamMarkInfo.MarkValueStringNoValue must be no more than 3 characters
List<GedExamMarkResponse>.ExamMarkInfo.PASICoreVersionInt64Yes
List<GedExamMarkResponse>.ExamMarkInfo.RefIdGuidYes
List<GedExamMarkResponse>.ExamMarkInfo.SchoolYearInt16YesValue must be between 1900 and 2100
List<GedExamMarkResponse>.ExamMarkInfo.StateProvinceIdStringNoValue must be in the form of a number between '000000001' and '999999999'
List<GedExamMarkResponse>.ExamMarkInfo.WritingCentreStringNoValue must be a valid organization code (e.g. s.1312).
See Also

Reference