- Resource: CourseWork
- CourseWorkState
- 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 ( |
courseId
string
Identifier of the course.
Read-only.
id
string
Classroom-assigned identifier of this course work, unique per course.
Read-only.
title
string
Title of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters.
description
string
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[]
state
enum (
CourseWorkState
)
Status of this course work. If unspecified, the default state is DRAFT
.
alternateLink
string
Absolute link to this course work in the Classroom web UI. This is only populated if state
is PUBLISHED
.
Read-only.
creationTime
string (
Timestamp
format)
Timestamp when this course work was created.
Read-only.
Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z"
, "2014-10-02T15:01:23.045123456Z"
or "2014-10-02T15:01:23+05:30"
.
updateTime
string (
Timestamp
format)
Timestamp of the most recent change to this course work.
Read-only.
Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z"
, "2014-10-02T15:01:23.045123456Z"
or "2014-10-02T15:01:23+05:30"
.
dueDate
object (
Date
)
Optional date, in UTC, that submissions for this course work are due. This must be specified if dueTime
is specified.
dueTime
object (
TimeOfDay
)
Optional time of day, in UTC, that submissions for this course work are due. This must be specified if dueDate
is specified.
scheduledTime
string (
Timestamp
format)
Optional timestamp when this course work is scheduled to be published.
Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z"
, "2014-10-02T15:01:23.045123456Z"
or "2014-10-02T15:01:23+05:30"
.
maxPoints
number
Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value.
workType
enum (
CourseWorkType
)
Type of this course work.
The type is set when the course work is created and cannot be changed.
associatedWithDeveloper
boolean
Whether this course work item is associated with the Developer Console project making the request.
See courseWork.create
for more details.
Read-only.
assigneeMode
enum (
AssigneeMode
)
Assignee mode of the coursework. If unspecified, the default value is ALL_STUDENTS
.
submissionModificationMode
enum (
SubmissionModificationMode
)
Setting to determine when students are allowed to modify submissions. If unspecified, the default value is MODIFIABLE_UNTIL_TURNED_IN
.
creatorUserId
string
Identifier for the user that created the coursework.
Read-only.
topicId
string
Identifier for the topic that this coursework is associated with. Must match an existing topic in the course.
gradeCategory
object (
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.
previewVersion
enum (
PreviewVersion
)
Output only. The preview version of the API used to retrieve this resource.
details
. Additional details that are specific to a type of course work. details
can be only one of the following:assignment
object (
Assignment
)
Assignment details. This is populated only when workType
is ASSIGNMENT
.
Read-only.
multipleChoiceQuestion
object (
MultipleChoiceQuestion
)
Multiple choice question details. For read operations, this field is populated only when workType
is MULTIPLE_CHOICE_QUESTION
. For write operations, this field must be specified when creating course work with a workType
of MULTIPLE_CHOICE_QUESTION
, and it must not be set otherwise.
gradingPeriodId
string
Identifier of the grading period associated with the coursework.
- At creation, if unspecified, the grading period ID will be set based on the
dueDate
(orscheduledTime
if nodueDate
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.
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. |
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. |
|
Gets metadata for Classroom add-ons in the context of a specific post. |
|
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. |