lms.backend.canvas.courses.groupsets.delete

View Source

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

BASE_ENDPOINT = '/api/v1/group_categories/{groupset_id}'

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

 9def request(backend: typing.Any,
10        course_id: int,
11        groupset_id: int,
12        ) -> bool:
13    """ Delete a group set. """
14
15    url = backend.server + BASE_ENDPOINT.format(groupset_id = groupset_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        }
26        backend.not_found('delete group set', identifiers)
27
28        return False
29
30    return True

Delete a group set.