- Resource: CourseWork
- CourseWorkState
- Date
- TimeOfDay
- SubmissionModificationMode
- Assignment
- MultipleChoiceQuestion
- Methods
Resource: CourseWork
Course work created by a teacher for students of the course.
JSON representation |
---|
{ "courseId": string, "id": string, "title": string, "description": string, "materials": [ { object ( |
Fields | |
---|---|
courseId |
Identifier of the course. Read-only. |
id |
Classroom-assigned identifier of this course work, unique per course. Read-only. |
title |
Title of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters. |
description |
Optional description of this course work. If set, the description must be a valid UTF-8 string containing no more than 30,000 characters. |
materials[] |
Additional materials. CourseWork must have no more than 20 material items. |
state |
Status of this course work. If unspecified, the default state is |
alternateLink |
Absolute link to this course work in the Classroom web UI. This is only populated if Read-only. |
creationTime |
Timestamp when this course work was created. Read-only. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
updateTime |
Timestamp of the most recent change to this course work. Read-only. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
dueDate |
Optional date, in UTC, that submissions for this course work are due. This must be specified if |
dueTime |
Optional time of day, in UTC, that submissions for this course work are due. This must be specified if |
scheduledTime |
Optional timestamp when this course work is scheduled to be published. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
maxPoints |
Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value. |
workType |
Type of this course work. The type is set when the course work is created and cannot be changed. |
associatedWithDeveloper |
Whether this course work item is associated with the Developer Console project making the request. See Read-only. |
assigneeMode |
Assignee mode of the coursework. If unspecified, the default value is |
individualStudentsOptions |
Identifiers of students with access to the coursework. This field is set only if |
submissionModificationMode |
Setting to determine when students are allowed to modify submissions. If unspecified, the default value is |
creatorUserId |
Identifier for the user that created the coursework. Read-only. |
topicId |
Identifier for the topic that this coursework is associated with. Must match an existing topic in the course. |
gradeCategory |
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. |
Union field details . Additional details that are specific to a type of course work. details can be only one of the following: |
|
assignment |
Assignment details. This is populated only when Read-only. |
multipleChoiceQuestion |
Multiple choice question details. For read operations, this field is populated only when |
CourseWorkState
Possible states of course work.
Enums | |
---|---|
COURSE_WORK_STATE_UNSPECIFIED |
No state specified. This is never returned. |
PUBLISHED |
Status for work that has been published. This is the default state. |
DRAFT |
Status for work that is not yet published. Work in this state is visible only to course teachers and domain administrators. |
DELETED |
Status for work that was published but is now deleted. Work in this state is visible only to course teachers and domain administrators. Work in this state is deleted after some time. |
Date
Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:
- A full date, with non-zero year, month, and day values.
- A month and day, with a zero year (for example, an anniversary).
- A year on its own, with a zero month and a zero day.
- A year and month, with a zero day (for example, a credit card expiration date).
Related types:
google.type.TimeOfDay
google.type.DateTime
google.protobuf.Timestamp
JSON representation |
---|
{ "year": integer, "month": integer, "day": integer } |
Fields | |
---|---|
year |
Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. |
month |
Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. |
day |
Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. |
TimeOfDay
Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date
and google.protobuf.Timestamp
.
JSON representation |
---|
{ "hours": integer, "minutes": integer, "seconds": integer, "nanos": integer } |
Fields | |
---|---|
hours |
Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
minutes |
Minutes of hour of day. Must be from 0 to 59. |
seconds |
Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
nanos |
Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
SubmissionModificationMode
Possible modification modes for student submissions.
Enums | |
---|---|
SUBMISSION_MODIFICATION_MODE_UNSPECIFIED |
No modification mode specified. This is never returned. |
MODIFIABLE_UNTIL_TURNED_IN |
Submissions can be modified before being turned in. |
MODIFIABLE |
Submissions can be modified at any time. |
Assignment
Additional details for assignments.
JSON representation |
---|
{
"studentWorkFolder": {
object ( |
Fields | |
---|---|
studentWorkFolder |
Drive folder where attachments from student submissions are placed. This is only populated for course teachers and administrators. |
MultipleChoiceQuestion
Additional details for multiple-choice questions.
JSON representation |
---|
{ "choices": [ string ] } |
Fields | |
---|---|
choices[] |
Possible choices. |
Methods |
|
---|---|
|
Creates course work. |
|
Deletes a course work. |
|
Returns course work. |
|
Returns a list of course work that the requester is permitted to view. |
|
Modifies assignee mode and options of a coursework. |
|
Updates one or more fields of a course work. |