Grade Components

The following URL structure exists for this controller:

api/Courses/{courseId}/GradeComponents/{action}/{gradeComponentId : optional}

The following calls are currently available for the GradeComponents controller:

1. GET: /api/GradeComponents/All

• Description: Retrieves a list of all existing grade components.
• Response Format: JSON of IEnumerable<GradeComponentModel>
• Parameters: None
• Permissions: CanSeeAllGradedParts

2. GET: /api/Courses/{courseId}/GradeComponents/All

• Description: Retrieves a list of all existing grade components of a certain course.
• Response Format: JSON of IEnumerable<GradeComponentModel>
• Parameters: {courseId} of type int
• Permissions: CanSeeGradedParts

3. GET: /api/Courses/{courseId}/GradeComponents/Get/{gradeComponentId}

• Description: Retrieves the details of a particular Grade Component belonging to a certain course.
• Response Format: JSON of GradeComponentModel
• Parameters: {courseId} of type int and {gradeComponentId} of type int
• Permissions: CanSeeGradedParts

4. POST: /api/Courses/{courseId}/GradeComponents/Add

• Description: Add a new Grade Component.
• Response Format: JSON of the added GradeComponentModel
• Parameters: {courseId} of type int and {gradeComponent} of type GradeComponentModel (JSON in the body of the message)
• Permissions: CanCreateGradedPart

5. PUT: /api/Courses/{courseId}/GradeComponents/Update/{gradeComponentId}

• Description: Update an existing Grade Component.
• Response Format: JSON of the updated GradeComponentModel
• Parameters: {courseId} of type int and {gradeComponentId} of type int and {gradeComponent} of type GradeComponentModel (JSON in the body of the message)
• Permissions: CanUpdateGradedPart

6. DELETE: /api/Courses/{courseId}/GradeComponents/Delete/{gradeComponentId}

• Description: Delete an existing Grade Component.
• Response Format: HttpStatusCode
• Parameters: {courseId} of type int and {gradeComponentId} of type int
• Permissions: CanDeleteGradedPart