get method

Future<Course> get(
  1. String id, {
  2. String? $fields,
})

Returns a course.

This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to access the requested course or for access errors. * NOT_FOUND if no course exists with the requested ID.

Request parameters:

id - Identifier of the course to return. This identifier can be either the Classroom-assigned identifier or an alias.

$fields - Selector specifying which fields to include in a partial response.

Completes with a Course.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<Course> get(
  core.String id, {
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/courses/' + commons.escapeVariable('$id');

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return Course.fromJson(response_ as core.Map<core.String, core.dynamic>);
}