list method

Future<ListRubricsResponse> list(String courseId, String courseWorkId, { int? pageSize, String? pageToken, String? $fields, })

Returns a list of rubrics that the requester is permitted to view.

This method returns the following error codes: * PERMISSION_DENIED for access errors. * INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if the requested course or course work doesn't exist or if the user doesn't have access to the corresponding course work.

Request parameters:

courseId - Required. Identifier of the course.

courseWorkId - Required. Identifier of the course work.

pageSize - The maximum number of rubrics to return. If unspecified, at most 1 rubric is returned. The maximum value is 1; values above 1 are coerced to 1.

pageToken - nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.

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

Completes with a ListRubricsResponse.

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<ListRubricsResponse> list(
  core.String courseId,
  core.String courseWorkId, {
  core.int? pageSize,
  core.String? pageToken,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (pageSize != null) 'pageSize': ['${pageSize}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if ($fields != null) 'fields': [$fields],
  };

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

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