lms.backend.canvas.courses.groups.delete

View Source

 1import typing
 2
 3import lms.backend.canvas.common
 4import lms.model.constants
 5
 6BASE_ENDPOINT = "/api/v1/groups/{group_id}"
 7
 8def request(backend: typing.Any,
 9        course_id: int,
10        groupset_id: int,
11        group_id: int,
12        ) -> bool:
13    """ Delete a group. """
14
15    url = backend.server + BASE_ENDPOINT.format(group_id = group_id)
16    headers = backend.get_standard_headers()
17
18    headers[lms.model.constants.HEADER_KEY_WRITE] = 'true'
19
20    raw_object = lms.backend.canvas.common.make_delete_request(url, headers = headers)
21    if (raw_object is None):
22        identifiers = {
23            'course_id': course_id,
24            'groupset_id': groupset_id,
25            'group_id': group_id,
26        }
27        backend.not_found('delete group', identifiers)
28
29        return False
30
31    return True

BASE_ENDPOINT = '/api/v1/groups/{group_id}'

def request(backend: Any, course_id: int, groupset_id: int, group_id: int) -> bool: View Source

 9def request(backend: typing.Any,
10        course_id: int,
11        groupset_id: int,
12        group_id: int,
13        ) -> bool:
14    """ Delete a group. """
15
16    url = backend.server + BASE_ENDPOINT.format(group_id = group_id)
17    headers = backend.get_standard_headers()
18
19    headers[lms.model.constants.HEADER_KEY_WRITE] = 'true'
20
21    raw_object = lms.backend.canvas.common.make_delete_request(url, headers = headers)
22    if (raw_object is None):
23        identifiers = {
24            'course_id': course_id,
25            'groupset_id': groupset_id,
26            'group_id': group_id,
27        }
28        backend.not_found('delete group', identifiers)
29
30        return False
31
32    return True

Delete a group.