Click or drag to resize

AcademicServiceUpdateCourseRequest Method

Update a course request.

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

Parameters

oldRequest
Type: SeniorSystemsWS.Entity.AcademicCourseRequest
Existing course request object (must provide School, Student, Course).
newRequest
Type: SeniorSystemsWS.Entity.AcademicCourseRequest
New course request.
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 Course ID is not already requested. If the Course ID is already a pending course request, this call will update the pending record. Otherwise, a new pending course request record will be created.

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

For the oldRequest parameter, only the SchoolID, StudentID and CourseID properties will be referenced.

For the newRequest parameter, the following properties in the Course Request object are used:

PropertyNotes
SchoolIDRequired

Must be the same as in the oldRequest parameter. Student must be in this school/division in the upcoming academic year.

StudentIDRequired

Must be the same as in the oldRequest parameter.

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