delete method

Future<Empty> delete(String courseId, String id, { String? $fields, })

Deletes a student group.

This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to delete the requested student group or for access errors. * NOT_FOUND if the student group does not exist or the user does not have access to the student group.

Request parameters:

courseId - Required. The identifier of the course containing the student group to delete.

id - Required. The identifier of the student group to delete.

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

Completes with a Empty.

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<Empty> delete(
  core.String courseId,
  core.String id, {
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    'fields': ?$fields == null ? null : [$fields],
  };

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

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