Click or drag to resize

AcademicServiceInsertCourseRequest Method

Inserts a course request.

Namespace:  (Default Namespace)
Assembly:  SeniorSystemsWS (in SeniorSystemsWS.dll) Version: 937.0.0.0 (937.0.0.33)
Syntax
public Result InsertCourseRequest(
	CourseRequest request,
	string authKey
)

Parameters

request
Type: SeniorSystemsWS.Entity.AcademicCourseRequest
A course request object.
authKey
Type: SystemString
Authentication Key obtained from the loginExt method in UserManagementService for a current administrator connection.

Return Value

Type: Result
A Result object.
Exceptions
ExceptionCondition
ApplicationExceptionInvalid authorization key
Remarks
Result.IsSuccess is True, if the call was successful; otherwise, Result.Message will contain error codes.

An error will occur if the given student is already requesting the Course ID or a pending request for the Course ID has already been entered.

The new course request record will be placed in a pending status until reviewed and approved.

The following properties in the Course Request object are required:

PropertyNotes
SchoolIDRequired

Student must be in this school/division in the upcoming academic year.

StudentIDRequired
CourseIDRequired

Must be a valid Course ID for the next academic year.

CourseIDAlt1Optional

Must be a valid Course ID for the next academic year.

CourseIDAlt2Optional

Must be a valid Course ID for the next academic year.

RequestPriorityOptional

Valid values are 0..99, inclusive.

RequestedTermsOptional

Within the Term object, only the Term.TermID property needs to be set. If no Terms are set, "all terms" is the default.

The authorization key provided must be linked to an administrator role.

See Also