lms.backend.canvas.courses.groupsets.create 

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

Create a group set.