 | AcademicServiceDeleteCourseRequest Method |
Deletes a course request.
Namespace:
(Default Namespace)
Assembly:
SeniorSystemsWS (in SeniorSystemsWS.dll) Version: 937.0.0.0 (937.0.0.33)
Syntaxpublic Result DeleteCourseRequest(
CourseRequest request,
string authKey
)
Public Function DeleteCourseRequest (
request As CourseRequest,
authKey As String
) As Result
public:
Result^ DeleteCourseRequest(
CourseRequest^ request,
String^ authKey
)
public function DeleteCourseRequest(
request : CourseRequest,
authKey : String
) : Result
function DeleteCourseRequest(request, authKey);
Parameters
- request
- Type: SeniorSystemsWS.Entity.AcademicCourseRequest
An existing course request (Must provide School, Student, Course). - authKey
- Type: SystemString
Authentication Key obtained from the loginExt method in UserManagementService for a current administrator connection.
Return Value
Type:
ResultA
Result object.
Exceptions
RemarksResult.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 delete the pending record. Otherwise, a new pending course request record will be created for the delete request.
For the request parameter, only the SchoolID, StudentID and CourseID properties will be referenced.
The authorization key provided must be linked to an administrator role.
See Also