Google Classroom add-ons are now generally available to developers! Please see the
add-ons documentation for more information.
Method: courses.checkGradingPeriodsSetupEligibility
Stay organized with collections
Save and categorize content based on your preferences.
Returns whether a user is eligible to update GradingPeriodSettings in a given course.
This method is deprecated. Use UserProfiles.checkUserCapability
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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-04-17 UTC.
[null,null,["Last updated 2025-04-17 UTC."],[],[],null,["# Method: courses.checkGradingPeriodsSetupEligibility\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.CheckGradingPeriodsSetupEligibilityResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n\n| This item is deprecated!\n\u003cbr /\u003e\n\n| **Developer Preview:** Available as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features. This feature is available in [V1_20240401_PREVIEW](https://developers.google.com/workspace/classroom/reference/rest/v1/PreviewVersion) and later. See [Access Preview APIs](https://developers.google.com/workspace/classroom/reference/preview) to learn more.\nReturns whether a user is eligible to update GradingPeriodSettings in a given course.\n\n\u003cbr /\u003e\n\nThis method is deprecated. Use [`UserProfiles.checkUserCapability`](/workspace/classroom/reference/rest/v1/userProfiles/checkUserCapability#body.PATH_PARAMETERS.user_id) instead.\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` for [access errors](/workspace/classroom/reference/Access.Errors).\n- `INVALID_ARGUMENT` if the request is malformed.\n- `NOT_FOUND` if the requested course does not exist.\n\n### HTTP request\n\n`GET https://classroom.googleapis.com/v1/courses/{courseId}:checkGradingPeriodsSetupEligibility`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|--------------------------------------------------|\n| `courseId` | `string` Required. The identifier of the course. |\n\n### Query parameters\n\n| Parameters ||\n|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `previewVersion` | `enum (`[PreviewVersion](/workspace/classroom/reference/rest/v1/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. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nWhether the user is allowed to update GradingPeriodSettings in this course.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"courseId\": string, \"isGradingPeriodsSetupEligible\": boolean, \"previewVersion\": enum (/workspace/classroom/reference/rest/v1/PreviewVersion) } ``` |\n\n| Fields ||\n|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `courseId` | `string` Immutable. The identifier of the course. |\n| `isGradingPeriodsSetupEligible` | `boolean` Whether the user is allowed to update the GradingPeriodSettings in this course. |\n| `previewVersion` | `enum (`[PreviewVersion](/workspace/classroom/reference/rest/v1/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. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/classroom.courses`\n- `\n https://www.googleapis.com/auth/classroom.courses.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
