autograder.api.courses.users.enroll

Enroll one or more users in a course.

View Source

 1"""
 2Enroll one or more users in a course.
 3"""
 4
 5import typing
 6
 7import autograder.api.common
 8import autograder.api.config
 9import autograder.model.config
10
11API_ENDPOINT: str = 'courses/users/enroll'
12API_WRITE: bool = True
13API_PARAMS: typing.List[autograder.api.config.APIParam] = [
14    autograder.api.config.PARAM_SERVER,
15    autograder.api.config.PARAM_COURSE,
16    autograder.api.config.PARAM_USER_EMAIL,
17    autograder.api.config.PARAM_USER_PASS,
18
19    autograder.api.config.PARAM_DRY_RUN,
20    autograder.api.config.PARAM_SKIP_INSERTS,
21    autograder.api.config.PARAM_SKIP_UPDATES,
22
23    autograder.api.config.PARAM_SEND_EMAILS,
24
25    autograder.api.config.PARAM_RAW_COURSE_USERS,
26
27    autograder.api.config.PARAM_NEW_USER_EMAIL,
28    autograder.api.config.PARAM_NEW_USER_NAME,
29    autograder.api.config.PARAM_NEW_USER_COURSE_ROLE,
30    autograder.api.config.PARAM_NEW_USER_LMS_ID,
31]
32
33def send(config: autograder.model.config.Config, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
34    """ Send a request to the autograder. """
35
36    return autograder.api.common.make_api_request(API_ENDPOINT, config, API_PARAMS, write = API_WRITE, **kwargs)

API_ENDPOINT: str = 'courses/users/enroll'

API_WRITE: bool = True

def send(config: autograder.model.config.Config, **kwargs: Any) -> Dict[str, Any]: View Source

34def send(config: autograder.model.config.Config, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
35    """ Send a request to the autograder. """
36
37    return autograder.api.common.make_api_request(API_ENDPOINT, config, API_PARAMS, write = API_WRITE, **kwargs)

Send a request to the autograder.