Method: courses.checkGradingPeriodsSetupEligibility

Returns whether a user is eligible to update GradingPeriodSettings in a given course.

This method is deprecated. Use UserProfiles.checkUserCapability instead.

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 does not exist.

HTTP request

GET https://classroom.googleapis.com/v1/courses/{courseId}:checkGradingPeriodsSetupEligibility

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
courseId

string

Required. The identifier of the course.

Query parameters

Parameters
previewVersion

enum (PreviewVersion)

Optional. The preview version of the API. This must be set in order to access new API capabilities made available to developers in the Preview Program.

Request body

The request body must be empty.

Response body

Whether the user is allowed to update GradingPeriodSettings in this course.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "courseId": string,
  "isGradingPeriodsSetupEligible": boolean,
  "previewVersion": enum (PreviewVersion)
}
Fields
courseId

string

Immutable. The identifier of the course.
isGradingPeriodsSetupEligible

boolean

Whether the user is allowed to update the GradingPeriodSettings in this course.
previewVersion

enum (PreviewVersion)

Output only. The preview version of the API. This must be set in order to access new API capabilities made available to developers in the Preview Program.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/classroom.courses
  • https://www.googleapis.com/auth/classroom.courses.readonly

For more information, see the Authorization guide.