IPASISystemGetDiplomaExamRegistrationRequest Method Provincial Approach to Student Information API
Ministry only service. This service is used to retrieve Diploma Exam Registration Requests from PASI Core.

To request Diploma Exam Registration Requests, the PASI Client will need to provide Alberta Student Number (StateProvinceId) for the student or an Education Account Identifier

The service returns a list of Diploma Exam Registration Requests.

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

DiplomaExamRegistrationRequestGetResponse GetDiplomaExamRegistrationRequest(
	DiplomaExamRegistrationGetRequest request
)

Parameters

request
Type: PASI.DataContract.V201507DiplomaExamRegistrationGetRequest
The request contains a Alberta Student Number (StateProvinceId) or an Education Account Identifier to retrieve Diploma Exam Registration Requests

Return Value

Type: DiplomaExamRegistrationRequestGetResponse
This service returns a list of Diploma Exam Registration Requests.

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.

9002, 9009, 62010
Remarks

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
EducationAccountIdentifierInt32NoValue must be greater than or equal to 0
StateProvinceIdStringNoValue must be in the form of a number between '000000001' and '999999999'


Response Fields

Full Property NameTypeRequiredOther Attributes
DiplomaExamRegistrationRequestGetResponse.ExamRegistrationRequestsList<DiplomaExamRegistrationRequestGetInfo>Yes
DiplomaExamRegistrationRequestGetResponse.ExamRegistrationRequests.BillingInformationIdInt32No
DiplomaExamRegistrationRequestGetResponse.ExamRegistrationRequests.EducationAccountIdentifierInt32No
DiplomaExamRegistrationRequestGetResponse.ExamRegistrationRequests.EducationAccountOrganizationStringNo
DiplomaExamRegistrationRequestGetResponse.ExamRegistrationRequests.ExamRegistrationRequestIdInt32No
DiplomaExamRegistrationRequestGetResponse.ExamRegistrationRequests.ExamRegistrationsList<DiplomaExamRegistrationRequestGetItemInfo>No
DiplomaExamRegistrationRequestGetResponse.ExamRegistrationRequests.ExamRegistrations.AmountCollectedDecimalNo
DiplomaExamRegistrationRequestGetResponse.ExamRegistrationRequests.ExamRegistrations.CouponCouponIdentifierInfoNo
DiplomaExamRegistrationRequestGetResponse.ExamRegistrationRequests.ExamRegistrations.Coupon.CouponReferenceIdGuidYes
DiplomaExamRegistrationRequestGetResponse.ExamRegistrationRequests.ExamRegistrations.Coupon.CouponVersionInt64Yes
DiplomaExamRegistrationRequestGetResponse.ExamRegistrationRequests.ExamRegistrations.ExamReferenceIdGuidYes
DiplomaExamRegistrationRequestGetResponse.ExamRegistrationRequests.ExamRegistrations.ExamSittingsGuid[]Yes
DiplomaExamRegistrationRequestGetResponse.ExamRegistrationRequests.ExamRegistrations.FeeAmountDecimalNo
DiplomaExamRegistrationRequestGetResponse.ExamRegistrationRequests.ExamRegistrations.FeeTypeStringNo
DiplomaExamRegistrationRequestGetResponse.ExamRegistrationRequests.ExamRegistrations.GstDueDecimalNo
DiplomaExamRegistrationRequestGetResponse.ExamRegistrationRequests.ExamRegistrations.LastUpdateUtcTimeDateTimeYes
DiplomaExamRegistrationRequestGetResponse.ExamRegistrationRequests.ExamRegistrations.StateProvinceIdStringYes
DiplomaExamRegistrationRequestGetResponse.ExamRegistrationRequests.ExamRegistrations.SuppliedContactNamesList<KeyValuePair>No
DiplomaExamRegistrationRequestGetResponse.ExamRegistrationRequests.ExamRegistrations.SuppliedContactNames.KeyStringYes
DiplomaExamRegistrationRequestGetResponse.ExamRegistrationRequests.ExamRegistrations.SuppliedContactNames.ValueStringYesPASI.Validation.Schema.IsNotRequired
DiplomaExamRegistrationRequestGetResponse.ExamRegistrationRequests.PasiCoreVersionInt64No
DiplomaExamRegistrationRequestGetResponse.ExamRegistrationRequests.PaymentMethodStringNo
DiplomaExamRegistrationRequestGetResponse.ExamRegistrationRequests.PaymentTransactionIdStringNo
DiplomaExamRegistrationRequestGetResponse.ExamRegistrationRequests.RequestExpiredUtcTimeDateTimeNo
DiplomaExamRegistrationRequestGetResponse.ExamRegistrationRequests.RequestorNameStringNo
DiplomaExamRegistrationRequestGetResponse.ExamRegistrationRequests.RequestReceivedMethodStringNo
DiplomaExamRegistrationRequestGetResponse.ExamRegistrationRequests.RequestStatusStringNo
DiplomaExamRegistrationRequestGetResponse.ExamRegistrationRequests.WaiveReasonStringNo
DiplomaExamRegistrationRequestGetResponse.RejectionsList<Rejection>No
DiplomaExamRegistrationRequestGetResponse.Rejections.CodeStringYes
DiplomaExamRegistrationRequestGetResponse.Rejections.DescriptionStringYes
See Also

Reference