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

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

List<EvaluatedMarkResponse> GetEvaluatedMark(
	EvaluatedMarkRequest request
)

Parameters

request
Type: PASI.DataContract.V201204EvaluatedMarkRequest
The request contains a list of Evaluated Mark Ids the client wishes to retrieve.

Return Value

Type: ListEvaluatedMarkResponse
The response contains a list of Evaluated Marks.

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.

This service allows the PASI Client to retrieve their students' Evaluated Mark(s) by passing in the Evaluated Mark RefId(s).The Evaluated Marks that can be retrieved are limited to the Evaluated Marks created by schools that PASI client represents.

The PASI Client must be associated to the Organization who owns the record. The PASI Client must be assigned the ViewAcademicRecordUser role before they are able to call this service.

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


Response Fields

Full Property NameTypeRequiredOther Attributes
List<EvaluatedMarkResponse>List<EvaluatedMarkResponse>No
List<EvaluatedMarkResponse>.AvailabilityStatusStringNo
List<EvaluatedMarkResponse>.EvaluatedMarkEvaluatedMarkInfoNo
List<EvaluatedMarkResponse>.EvaluatedMark.CourseCodeStringYesValue must be 7 characters
List<EvaluatedMarkResponse>.EvaluatedMark.CreditsAttemptedInt16Yes
List<EvaluatedMarkResponse>.EvaluatedMark.EffectiveUtcDateTimeNo
List<EvaluatedMarkResponse>.EvaluatedMark.EvaluationDateDateTimeYes
List<EvaluatedMarkResponse>.EvaluatedMark.EvaluationMethodStringYesValue must be an appropriate EvaluationMethod code value
List<EvaluatedMarkResponse>.EvaluatedMark.IsDeletedBooleanYes
List<EvaluatedMarkResponse>.EvaluatedMark.IsFundingRequestedBooleanYes
List<EvaluatedMarkResponse>.EvaluatedMark.IsMarkApprovedBooleanYes
List<EvaluatedMarkResponse>.EvaluatedMark.MarkFormatStringYesValue must be an appropriate MarkFormat code value
List<EvaluatedMarkResponse>.EvaluatedMark.MarkValueStringYesValue must be no more than 3 characters
List<EvaluatedMarkResponse>.EvaluatedMark.OrganizationCodeStringYesValue must be a valid organization code (e.g. s.1312).
List<EvaluatedMarkResponse>.EvaluatedMark.PASICoreVersionInt64Yes
List<EvaluatedMarkResponse>.EvaluatedMark.RefIdGuidYes
List<EvaluatedMarkResponse>.EvaluatedMark.SchoolYearInt16YesValue must be between 1900 and 2100
List<EvaluatedMarkResponse>.EvaluatedMark.StateProvinceIdStringYesValue must be in the form of a number between '000000001' and '999999999'
See Also

Reference