You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Returns the grading period settings in a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user isn't permitted to access the grading period settings in the requested course or for access errors. * `NOT_FOUND` if the requested course does not exist.
209
+
210
+
## Parameters
211
+
212
+
* `connection` (*type:* `GoogleApi.Classroom.V1.Connection.t`) - Connection to server
213
+
* `course_id` (*type:* `String.t`) - Required. The identifier of the course.
* `:alt` (*type:* `String.t`) - Data format for response.
218
+
* `:callback` (*type:* `String.t`) - JSONP
219
+
* `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response.
220
+
* `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
221
+
* `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user.
222
+
* `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks.
223
+
* `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
224
+
* `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart").
225
+
* `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart").
226
+
* `opts` (*type:* `keyword()`) - Call options
227
+
228
+
## Returns
229
+
230
+
* `{:ok, %GoogleApi.Classroom.V1.Model.GradingPeriodSettings{}}` on success
Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. Returned courses are ordered by creation time, with the most recently created coming first. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the query argument is malformed. * `NOT_FOUND` if any users specified in the query arguments do not exist.
209
279
@@ -397,6 +467,80 @@ defmodule GoogleApi.Classroom.V1.Api.Courses do
Updates grading period settings of a course. Individual grading periods can be added, removed, or modified using this method. The requesting user and course owner must be eligible to modify Grading Periods. For details, see [licensing requirements](https://developers.google.com/classroom/grading-periods/manage-grading-periods#licensing_requirements). This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the grading period settings in a course or for access errors: * UserIneligibleToUpdateGradingPeriodSettings * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.
472
+
473
+
## Parameters
474
+
475
+
* `connection` (*type:* `GoogleApi.Classroom.V1.Connection.t`) - Connection to server
476
+
* `course_id` (*type:* `String.t`) - Required. The identifier of the course.
* `:alt` (*type:* `String.t`) - Data format for response.
481
+
* `:callback` (*type:* `String.t`) - JSONP
482
+
* `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response.
483
+
* `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
484
+
* `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user.
485
+
* `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks.
486
+
* `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
487
+
* `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart").
488
+
* `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart").
489
+
* `:updateMask` (*type:* `String.t`) - Mask that identifies which fields in the GradingPeriodSettings to update. The GradingPeriodSettings `grading_periods` list will be fully replaced by the grading periods specified in the update request. For example: * Grading periods included in the list without an ID are considered additions, and a new ID will be assigned when the request is made. * Grading periods that currently exist, but are missing from the request will be considered deletions. * Grading periods with an existing ID and modified data are considered edits. Unmodified data will be left as is. * Grading periods included with an unknown ID will result in an error. The following fields may be specified: * `grading_periods` * `apply_to_existing_coursework`
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).
402
546
@@ -2002,7 +2146,7 @@ defmodule GoogleApi.Classroom.V1.Api.Courses do
2002
2146
* `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
2003
2147
* `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart").
2004
2148
* `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart").
2005
-
* `:updateMask` (*type:* `String.t`) - Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the `CourseWork` object. If a field that does not support empty values is included in the update mask and not set in the `CourseWork` object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `due_date` * `due_time` * `max_points` * `scheduled_time` * `submission_modification_mode` * `topic_id` * `grading_period_id` Available in [V1_20240401_PREVIEW](https://developers.google.com/classroom/reference/preview) and later.
2149
+
* `:updateMask` (*type:* `String.t`) - Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the `CourseWork` object. If a field that does not support empty values is included in the update mask and not set in the `CourseWork` object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `due_date` * `due_time` * `max_points` * `scheduled_time` * `submission_modification_mode` * `topic_id` * `grading_period_id`
Copy file name to clipboardExpand all lines: clients/classroom/lib/google_api/classroom/v1/model/course_work.ex
+3Lines changed: 3 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -32,6 +32,7 @@ defmodule GoogleApi.Classroom.V1.Model.CourseWork do
32
32
* `dueDate` (*type:* `GoogleApi.Classroom.V1.Model.Date.t`, *default:* `nil`) - Optional date, in UTC, that submissions for this course work are due. This must be specified if `due_time` is specified.
33
33
* `dueTime` (*type:* `GoogleApi.Classroom.V1.Model.TimeOfDay.t`, *default:* `nil`) - Optional time of day, in UTC, that submissions for this course work are due. This must be specified if `due_date` is specified.
34
34
* `gradeCategory` (*type:* `GoogleApi.Classroom.V1.Model.GradeCategory.t`, *default:* `nil`) - The category that this coursework's grade contributes to. Present only when a category has been chosen for the coursework. May be used in calculating the overall grade. Read-only.
35
+
* `gradingPeriodId` (*type:* `String.t`, *default:* `nil`) - Identifier of the grading period associated with the coursework. * At creation, if unspecified, the grading period ID will be set based on the `dueDate` (or `scheduledTime` if no `dueDate` is set). * To indicate no association to any grading period, set this field to an empty string (""). * If specified, it must match an existing grading period ID in the course.
35
36
* `id` (*type:* `String.t`, *default:* `nil`) - Classroom-assigned identifier of this course work, unique per course. Read-only.
36
37
* `individualStudentsOptions` (*type:* `GoogleApi.Classroom.V1.Model.IndividualStudentsOptions.t`, *default:* `nil`) - Identifiers of students with access to the coursework. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field are assigned the coursework.
37
38
* `materials` (*type:* `list(GoogleApi.Classroom.V1.Model.Material.t)`, *default:* `nil`) - Additional materials. CourseWork must have no more than 20 material items.
@@ -60,6 +61,7 @@ defmodule GoogleApi.Classroom.V1.Model.CourseWork do
An individual grading period. Grading periods must not have overlapping date ranges and must be listed in chronological order. For example, if the end_date of a grading period is 2024-01-25, then the start_date of the next grading period must be 2024-01-26 or later. Each grading period must have a unique title within a course.
21
+
22
+
## Attributes
23
+
24
+
* `endDate` (*type:* `GoogleApi.Classroom.V1.Model.Date.t`, *default:* `nil`) - Required. End date, in UTC, of the grading period. Inclusive.
25
+
* `id` (*type:* `String.t`, *default:* `nil`) - Output only. System generated grading period ID. Read-only.
26
+
* `startDate` (*type:* `GoogleApi.Classroom.V1.Model.Date.t`, *default:* `nil`) - Required. Start date, in UTC, of the grading period. Inclusive.
27
+
* `title` (*type:* `String.t`, *default:* `nil`) - Required. Title of the grading period. For example, “Semester 1”.
Grading period settings that include all the individual grading periods in a course.
21
+
22
+
## Attributes
23
+
24
+
* `applyToExistingCoursework` (*type:* `boolean()`, *default:* `nil`) - Supports toggling the application of grading periods on existing stream items. Once set, this value is persisted meaning that it does not need to be set in every request to update `GradingPeriodSettings`. If not previously set, the default is False.
25
+
* `gradingPeriods` (*type:* `list(GoogleApi.Classroom.V1.Model.GradingPeriod.t)`, *default:* `nil`) - The list of grading periods in a specific course. Grading periods must not have overlapping date ranges and must be listed in chronological order. Each grading period must have a unique title within a course.
0 commit comments