create method

Future<CourseAlias> create(CourseAlias request, String courseId, { String? $fields, })

Creates an alias for a course.

This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to create the alias or for access errors. * NOT_FOUND if the course does not exist. * ALREADY_EXISTS if the alias already exists. * FAILED_PRECONDITION if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to access a domain-scoped alias).

request - The metadata request object.

Request parameters:

courseId - Identifier of the course to alias. 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 CourseAlias.

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<CourseAlias> create(
  CourseAlias request,
  core.String courseId, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

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

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