IPASIService2019SubmitCourseEnrolment Method Provincial Approach to Student Information API
This service is used to manage Course Enrolment information in the PASI Core. It is used to add a new Course Enrolment, update an existing Course Enrolment or delete/undelete an existing Course Enrolment. This service work with either a single record, or a list of Course Enrolment information thus allowing a PASI Client to record information in PASI through submitting one batch at a time.

The IsMarkApproved property of CourseEnrolmentMarkInfo is ignored when this service is called. To approve a mark value the SubmitMarkApproval service must be used.

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

MultipleSubmitResponse SubmitCourseEnrolment(
	SubmitCourseEnrolmentRequest request
)

Parameters

request
Type: PASI.DataContract.V2019SubmitCourseEnrolmentRequest
The request contains a single record or a list of CourseEnrolmentInfo data contract to be submitted to PASI Core.

Return Value

Type: MultipleSubmitResponse
The return from a Submit Course Enrolment request identifies if an add/update/delete/undelete for a Course Enrolment was successfully applied. If not successful, the response identifies which validation rules have failed.

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.

9009, 9015, 9016, 9017, 9018, 9020, 9023, 9024, 9030, 9031, 9058, 9062, 9063, 9068, 40201, 40204, 40218, 40219, 40225, 40226, 40227, 40230, 40231, 40232, 40235, 40258, 40259, 40260, 40262, 40263, 40270, 40271, 40272, 40285, 40286, 40295, 40296, 40297, 40299, 40609, 40613, 40614, 42005
Remarks

Each Course Enrolment on the request will be processed individually, therefore some of the updates may be successful while others may fail.

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
CourseEnrolmentsList<CourseEnrolmentInfo>Yes
CourseEnrolments.ArePrerequisitesWaivedBooleanYes
CourseEnrolments.CourseCodeStringYesValue must be 7 characters
CourseEnrolments.CourseEnrolmentMarkCourseEnrolmentMarkInfoNo
CourseEnrolments.CourseEnrolmentMark.AssignmentDateDateTimeYes
CourseEnrolments.CourseEnrolmentMark.IsMarkApprovedBooleanYes
CourseEnrolments.CourseEnrolmentMark.MarkFormatStringYesValue must be an appropriate MarkFormat code value
CourseEnrolments.CourseEnrolmentMark.MarkValueStringYesValue must be no more than 3 characters
CourseEnrolments.CourseEnrolmentStatusStringYesValue must be an appropriate CourseEnrolmentStatus code value
CourseEnrolments.CreditsAttemptedInt16Yes
CourseEnrolments.EffectiveUtcDateTimeNo
CourseEnrolments.EntryDateDateTimeNo
CourseEnrolments.ExitDateDateTimeNo
CourseEnrolments.InstructionalMinutesReceivedNullable`1NoValue must be between 0 and 2147483647
CourseEnrolments.IsDeletedBooleanYes
CourseEnrolments.IsDualEnrolmentBooleanYes
CourseEnrolments.IsFundingRequestedBooleanYes
CourseEnrolments.PASICoreVersionInt64Yes
CourseEnrolments.ProviderNumberStringNoValue must be no more than 100 characters
CourseEnrolments.RefIdGuidYes
CourseEnrolments.SectionRefIdGuidYes
CourseEnrolments.StateProvinceIdStringYesValue must be in the form of a number between '000000001' and '999999999'
CourseEnrolments.StudentSchoolEnrolmentRefIdGuidNo


Response Fields

Full Property NameTypeRequiredOther Attributes
MultipleSubmitResponse.ResponsesList<SubmitResponse>Yes
MultipleSubmitResponse.Responses.IdStringNo
MultipleSubmitResponse.Responses.PASICoreVersionInt64No
MultipleSubmitResponse.Responses.RejectionsList<Rejection>No
MultipleSubmitResponse.Responses.Rejections.CodeStringYes
MultipleSubmitResponse.Responses.Rejections.DescriptionStringYes
See Also

Reference