IPASISystemSubmitDiplomaExamRegistrationRequest Method Provincial Approach to Student Information API
Ministry only service. This service is used to submit or update a diploma exam registration request.

Namespace: PASI.ServiceContract
Assembly: PASI.ServiceContract (in PASI.ServiceContract.dll) Version: 9.23.3.0 (9.23.3.0)
Syntax
Copy
DiplomaExamRegistrationRequestResponse SubmitDiplomaExamRegistrationRequest(
	DiplomaExamRegistrationRequest request
)

Parameters

request
Type: PASI.DataContract.V201507DiplomaExamRegistrationRequest
Contains all the information needed to submit a diploma exam registration request, including the request itself, any fees, exams and sittings

Return Value

Type: DiplomaExamRegistrationRequestResponse
The PASI Core version and Id for the diploma exam registration 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.

9002, 9009, 9019, 9023, 9062, 40507, 40508, 40526, 40530, 40531, 40540, 40541, 40542, 40552, 40553, 40559, 62001, 62002, 62003, 62004, 62005, 62006, 62007, 62008, 62009
Remarks
One of either StateProvinceId or EducationAccountIdentifier are required (it is not valid to provide both). Note that, when EducationAccountIdentifier is provided, the service will only return ExamRegistrationRequests that do not have a status of “Registered”.

Request and Response Class Diagram



Request Fields

Full Property NameTypeRequiredOther Attributes
BillingInformationIdInt32Yes
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
DiplomaExamRegistrationRequestIdInt32No
EducationAccountIdentifierInt32Yes
EducationAccountOrganizationStringNoValue must be a valid organization code (e.g. s.1312).
ExamRegistrationsList<DiplomaExamRegistrationRequestItem>No
ExamRegistrations.AmountCollectedDecimalYesDecimal number must have precision of at most 7 and scale of at most 2 Value must be greater than or equal to 0 Value must be less than or equal to 99999.99
ExamRegistrations.AmountDueDecimalYesDecimal number must have precision of at most 7 and scale of at most 2 Value must be greater than or equal to 0 Value must be less than or equal to 99999.99
ExamRegistrations.CouponCouponIdentifierInfoNo
ExamRegistrations.Coupon.CouponReferenceIdGuidYes
ExamRegistrations.Coupon.CouponVersionInt64Yes
ExamRegistrations.ExamReferenceIdGuidYes
ExamRegistrations.ExamSittingReferenceIdsList<Guid>Yes
ExamRegistrations.FeeTypeStringNoValue must be an appropriate FeeType code value
ExamRegistrations.GstDueDecimalYesDecimal number must have precision of at most 7 and scale of at most 2 Value must be greater than or equal to 0 Value must be less than or equal to 99999.99
ExamRegistrations.StateProvinceIdStringYesValue must be in the form of a number between '000000001' and '999999999'
ExamRegistrations.SuppliedContactNamesList<KeyValuePair>No
ExamRegistrations.SuppliedContactNames.KeyStringYes
ExamRegistrations.SuppliedContactNames.ValueStringYesPASI.Validation.Schema.IsNotRequired
IsDeletedBooleanYes
PASICoreVersionInt64YesValue must be greater than or equal to 0
PaymentMethodStringNoValue must be an appropriate PaymentMethod code value
PaymentTransactionIdStringNo
RequestExpiryUtcDateTimeYes
RequestMethodStringYesValue must be an appropriate OrderReceivedMethod code value
RequestorNameStringYesValue must be no more than 120 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]
RequestStatusStringYesValue must be an appropriate RequestStatus code value
WaiveReasonStringNo


Response Fields

Full Property NameTypeRequiredOther Attributes
DiplomaExamRegistrationRequestResponse.DiplomaExamRegistrationRequestIdInt32Yes
DiplomaExamRegistrationRequestResponse.PASICoreVersionInt64Yes
DiplomaExamRegistrationRequestResponse.RejectionsList<Rejection>No
DiplomaExamRegistrationRequestResponse.Rejections.CodeStringYes
DiplomaExamRegistrationRequestResponse.Rejections.DescriptionStringYes
See Also

Reference

IPASISystem Interface
PASI.ServiceContract Namespace