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.23.3.0 (9.23.3.0)
Syntax
Parameters
- request
- Type: PASI.DataContract.V201602DiplomaExamRequest
The request contains a list of Exam Ids the client wishes to retrieve.
Return Value
Type: ListDiplomaExamResponseThe 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
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 |
| ExamIds | List<EntityRefIdVersionInfo> | Yes | |
| ExamIds.ExpectedVersion | Nullable`1 | No | |
| ExamIds.RefId | Guid | Yes |
Response Fields
| Full Property Name | Type | Required | Other Attributes |
|---|---|---|---|
| List<DiplomaExamResponse> | List<DiplomaExamResponse> | No | |
| List<DiplomaExamResponse>.AvailabilityStatus | String | No | |
| List<DiplomaExamResponse>.Exam | DiplomaExamInfo | No | |
| List<DiplomaExamResponse>.Exam.CourseCode | String | Yes | Value must be 7 characters |
| List<DiplomaExamResponse>.Exam.EffectiveUtc | DateTime | No | |
| List<DiplomaExamResponse>.Exam.ExamComponents | List<ExamComponentInfo> | Yes | |
| List<DiplomaExamResponse>.Exam.ExamComponents.ComponentCode | String | Yes | Value 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.ComponentName | String | Yes | Value 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.FrenchComponentName | String | Yes | Value 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.IsMarkReportable | Boolean | Yes | |
| List<DiplomaExamResponse>.Exam.ExamComponents.ScheduledUtcTime | DateTime | No | |
| List<DiplomaExamResponse>.Exam.ExamComponents.WeightPercentage | Decimal | Yes | |
| List<DiplomaExamResponse>.Exam.ExamLanguage | String | Yes | Value must be an appropriate LanguageOfExam code value |
| List<DiplomaExamResponse>.Exam.ExamPeriod | String | Yes | Value must be an appropriate ExamPeriod code value |
| List<DiplomaExamResponse>.Exam.ExamType | String | Yes | Value must be an appropriate ExamType code value |
| List<DiplomaExamResponse>.Exam.IsDeleted | Boolean | Yes | |
| List<DiplomaExamResponse>.Exam.MarkFormat | String | Yes | Value must be an appropriate MarkFormat code value |
| List<DiplomaExamResponse>.Exam.PASICoreVersion | Int64 | Yes | |
| List<DiplomaExamResponse>.Exam.RefId | Guid | Yes | |
| List<DiplomaExamResponse>.Exam.RegistrationDeadlineUtc | DateTime | Yes | |
| List<DiplomaExamResponse>.Exam.RescoreDeadlineDate | DateTime | Yes | |
| List<DiplomaExamResponse>.Exam.SchoolYear | Int16 | Yes | Value must be between 1900 and 2100 |
See Also