lms.backend.canvas.courses.groupsets.create

 1import typing
 2
 3import lms.backend.canvas.common
 4import lms.backend.canvas.model
 5import lms.model.groupsets
 6
 7BASE_ENDPOINT = "/api/v1/courses/{course_id}/group_categories"
 8
 9def request(backend: typing.Any,
10        course_id: int,
11        name: str,
12        ) -> lms.model.groupsets.GroupSet:
13    """ Create a group set. """
14
15    url = backend.server + BASE_ENDPOINT.format(course_id = course_id)
16    headers = backend.get_standard_headers(write = True)
17
18    data = {
19        'name': name,
20    }
21
22    raw_object = lms.backend.canvas.common.make_post_request(url, headers = headers, data = data)
23    if (raw_object is None):
24        identifiers = {
25            'course_id': course_id,
26        }
27        backend.not_found('create group set', identifiers)
28
29        raise ValueError(f"Unable to create group set '{name}' for course '{course_id}'.")
30
31    return lms.backend.canvas.model.group_set(raw_object)
BASE_ENDPOINT = '/api/v1/courses/{course_id}/group_categories'
def request(backend: Any, course_id: int, name: str) -> lms.model.groupsets.GroupSet:
10def request(backend: typing.Any,
11        course_id: int,
12        name: str,
13        ) -> lms.model.groupsets.GroupSet:
14    """ Create a group set. """
15
16    url = backend.server + BASE_ENDPOINT.format(course_id = course_id)
17    headers = backend.get_standard_headers(write = True)
18
19    data = {
20        'name': name,
21    }
22
23    raw_object = lms.backend.canvas.common.make_post_request(url, headers = headers, data = data)
24    if (raw_object is None):
25        identifiers = {
26            'course_id': course_id,
27        }
28        backend.not_found('create group set', identifiers)
29
30        raise ValueError(f"Unable to create group set '{name}' for course '{course_id}'.")
31
32    return lms.backend.canvas.model.group_set(raw_object)

Create a group set.