lms.backend.canvas.courses.syllabus.fetch

View Source

 1import typing
 2
 3import lms.backend.canvas.common
 4
 5BASE_ENDPOINT = "/api/v1/courses/{course_id}"
 6
 7def request(backend: typing.Any,
 8        course_id: int,
 9        ) -> typing.Union[str, None]:
10    """ Fetch a course syllabus. """
11
12    url = backend.server + BASE_ENDPOINT.format(course_id = course_id)
13    headers = backend.get_standard_headers()
14
15    data = {
16        'include': ['syllabus_body'],
17    }
18
19    raw_object = lms.backend.canvas.common.make_get_request(url, headers = headers, data = data)
20    if (raw_object is None):
21        identifiers = {
22            'course_id': course_id,
23        }
24        backend.not_found('fetch syllabus', identifiers)
25
26        return None
27
28    result = raw_object.get('syllabus_body', None)
29    if (result is None):
30        return None
31
32    return str(result)

BASE_ENDPOINT = '/api/v1/courses/{course_id}'

def request(backend: Any, course_id: int) -> Optional[str]: View Source

 8def request(backend: typing.Any,
 9        course_id: int,
10        ) -> typing.Union[str, None]:
11    """ Fetch a course syllabus. """
12
13    url = backend.server + BASE_ENDPOINT.format(course_id = course_id)
14    headers = backend.get_standard_headers()
15
16    data = {
17        'include': ['syllabus_body'],
18    }
19
20    raw_object = lms.backend.canvas.common.make_get_request(url, headers = headers, data = data)
21    if (raw_object is None):
22        identifiers = {
23            'course_id': course_id,
24        }
25        backend.not_found('fetch syllabus', identifiers)
26
27        return None
28
29    result = raw_object.get('syllabus_body', None)
30    if (result is None):
31        return None
32
33    return str(result)

Fetch a course syllabus.