GOgoogle
courses

GET /v1/courses/{courseId}/courseWorkMaterials/{id}

Changed on

Returns a course work material. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to access the requested course or course work material, or for access errors. * INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if the requested course or course work material does not exist.

Request

  • Base URL
    https://classroom.googleapis.com
  • URL
    https://classroom.googleapis.com/v1/courses/{courseId}/courseWorkMaterials/{id}
  • Auth
    • OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/classroom.courseworkmaterials
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/classroom.courseworkmaterials
    • or OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/classroom.courseworkmaterials.readonly
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/classroom.courseworkmaterials.readonly

Path parameters

courseIdstring required

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

idstring required

Identifier of the course work material.

Response

Successful response

alternateLinkstring

Absolute link to this course work material in the Classroom web UI. This is only populated if state is PUBLISHED. Read-only.

assigneeMode'ASSIGNEE_MODE_UNSPECIFIED' | 'ALL_STUDENTS' | 'INDIVIDUAL_STUDENTS'

Assignee mode of the course work material. If unspecified, the default value is ALL_STUDENTS.

courseIdstring

Identifier of the course. Read-only.

creationTimestring google-datetime

Timestamp when this course work material was created. Read-only.

creatorUserIdstring

Identifier for the user that created the course work material. Read-only.

descriptionstring

Optional description of this course work material. The text must be a valid UTF-8 string containing no more than 30,000 characters.

idstring

Classroom-assigned identifier of this course work material, unique per course. Read-only.

scheduledTimestring google-datetime

Optional timestamp when this course work material is scheduled to be published.

state'COURSEWORK_MATERIAL_STATE_UNSPECIFIED' | 'PUBLISHED' | 'DRAFT' | 'DELETED'

Status of this course work material. If unspecified, the default state is DRAFT.

titlestring

Title of this course work material. The title must be a valid UTF-8 string containing between 1 and 3000 characters.

topicIdstring

Identifier for the topic that this course work material is associated with. Must match an existing topic in the course.

updateTimestring google-datetime

Timestamp of the most recent change to this course work material. Read-only.

Changes

  • d9e82ce809f1Revision changes
    • info

      the security scope https://www.googleapis.com/auth/classroom.courseworkmaterials was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/classroom.courseworkmaterials was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/classroom.courseworkmaterials.readonly was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/classroom.courseworkmaterials.readonly was removed from the endpoint's security scheme Oauth2c

  • 8575901d0ec9Revision changes
    • info

      the security scope https://www.googleapis.com/auth/classroom.courseworkmaterials was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/classroom.courseworkmaterials was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/classroom.courseworkmaterials.readonly was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/classroom.courseworkmaterials.readonly was removed from the endpoint's security scheme Oauth2c