Module googleapis.classroom

ballerinax/googleapis.classroom Ballerina library

1.5.1

Overview

This is a generated connector for Google Classroom API v1 OpenAPI specification. Manages classes, rosters, and invitations in Google Classroom.

Prerequisites

Before using this connector in your Ballerina application, complete the following:

Create a Google account
Obtain tokens - Follow this link

Quickstart

To use the Google Classroom connector in your Ballerina application, update the .bal file as follows:

Step 1: Import connector

First, import the ballerinax/googleapis.classroom module into the Ballerina project.


import ballerinax/googleapis.classroom;

Step 2: Create a new connector instance

Create a classroom:ClientConfig with the OAuth2 tokens obtained, and initialize the connector with it.


classroom:ClientConfig clientConfig = {
    auth: {
        clientId: <CLIENT_ID>,
        clientSecret: <CLIENT_SECRET>,
        refreshUrl: <REFRESH_URL>,
        refreshToken: <REFRESH_TOKEN>
    }
};

classroom:Client baseClient = check new Client(clientConfig);

Step 3: Invoke connector operation

Now you can use the operations available within the connector. Note that they are in the form of remote operations.

Following is an example on how to return a list of courses that the requesting user is permitted to view, restricted to those that match the request using the connector.

Return a list of courses


public function main() {
    classroom:ListCoursesResponse|error response = baseClient->listCourses();
    if (response is classroom:ListCoursesResponse) {
        log:printInfo(response.toString());
    } else {
        log:printError(response.message());
    }
}

Use bal run command to compile and run the Ballerina program.

Clients

googleapis.classroom: Client

Isolated

This is a generated connector for Google Classroom API v1 OpenAPI specification. Manages classes, rosters, and invitations in Google Classroom.

Constructor

Gets invoked to initialize the connector. The connector initialization requires setting the API credentials. Create a Google account and obtain tokens by following this guide.

init (ConnectionConfig config, string serviceUrl)

config ConnectionConfig - The configurations to be used when initializing the connector

serviceUrl string "https://classroom.googleapis.com" - URL of the target service

listCourses

Isolated FunctionRemote Function

function listCourses(string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string[]? courseStates, int? pageSize, string? pageToken, string? studentId, string? teacherId) returns ListCoursesResponse|error

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.

Parameters

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

courseStates string[]? (default ()) - Restricts returned courses to those in one of the specified states The default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED.

pageSize int? (default ()) - Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.

pageToken string? (default ()) - nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.

studentId string? (default ()) - Restricts returned courses to those having a student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal "me", indicating the requesting user

teacherId string? (default ()) - Restricts returned courses to those having a teacher with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal "me", indicating the requesting user

Return Type

ListCoursesResponse|error - Successful response

createCourses

Isolated FunctionRemote Function

function createCourses(Course payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Course|error

Creates a course. The user specified in ownerId is the owner of the created course and added as a teacher. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to create courses or for access errors. * NOT_FOUND if the primary teacher is not a valid user. * FAILED_PRECONDITION if the course owner's account is disabled or for the following request errors: * UserGroupsMembershipLimitReached * ALREADY_EXISTS if an alias was specified in the id and already exists.

Parameters

payload Course - Course request

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

Return Type

Course|error - Successful response

listCoursesAliases

Isolated FunctionRemote Function

function listCoursesAliases(string courseId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, int? pageSize, string? pageToken) returns ListCourseAliasesResponse|error

Returns a list of aliases for a course. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to access the course or for access errors. * NOT_FOUND if the course does not exist.

Parameters

courseId string - The identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

pageSize int? (default ()) - Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.

pageToken string? (default ()) - nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.

Return Type

ListCourseAliasesResponse|error - Successful response

createCoursesAliases

Isolated FunctionRemote Function

function createCoursesAliases(string courseId, CourseAlias payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns CourseAlias|error

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).

Parameters

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

payload CourseAlias - Course alias request

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

Return Type

CourseAlias|error - Successful response

deleteCoursesAliases

Isolated FunctionRemote Function

function deleteCoursesAliases(string courseId, string alias, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Response|error

Deletes an alias of a course. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to remove the alias or for access errors. * NOT_FOUND if the alias does not exist. * 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 delete a domain-scoped alias).

Parameters

courseId string - Identifier of the course whose alias should be deleted. This identifier can be either the Classroom-assigned identifier or an alias.

alias string - Alias to delete. This may not be the Classroom-assigned identifier.

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

Return Type

Response|error - Successful response

listCoursesAnnouncements

Isolated FunctionRemote Function

function listCoursesAnnouncements(string courseId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string[]? announcementStates, string? orderBy, int? pageSize, string? pageToken) returns ListAnnouncementsResponse|error

Returns a list of announcements that the requester is permitted to view. Course students may only view PUBLISHED announcements. Course teachers and domain administrators may view all announcements. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to access the requested course or for access errors. * INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if the requested course does not exist.

Parameters

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

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

announcementStates string[]? (default ()) - Restriction on the state of announcements returned. If this argument is left unspecified, the default value is PUBLISHED.

orderBy string? (default ()) - Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported field is updateTime. Supported direction keywords are asc and desc. If not specified, updateTime desc is the default behavior. Examples: updateTime asc, updateTime

pageSize int? (default ()) - Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.

pageToken string? (default ()) - nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.

Return Type

ListAnnouncementsResponse|error - Successful response

createCoursesAnnouncements

Isolated FunctionRemote Function

function createCoursesAnnouncements(string courseId, Announcement payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Announcement|error

Creates an announcement. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to access the requested course, create announcements in the requested course, share a Drive attachment, or for access errors. * INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if the requested course does not exist. * FAILED_PRECONDITION for the following request error: * AttachmentNotVisible

Parameters

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

payload Announcement - Announcement request

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

Return Type

Announcement|error - Successful response

getCoursesAnnouncements

Isolated FunctionRemote Function

function getCoursesAnnouncements(string courseId, string id, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Announcement|error

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

Parameters

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

id string - Identifier of the announcement.

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

Return Type

Announcement|error - Successful response

deleteCoursesAnnouncements

Isolated FunctionRemote Function

function deleteCoursesAnnouncements(string courseId, string id, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Response|error

Deletes an announcement. This request must be made by the Developer Console project of the OAuth client ID used to create the corresponding announcement item. This method returns the following error codes: * PERMISSION_DENIED if the requesting developer project did not create the corresponding announcement, if the requesting user is not permitted to delete the requested course or for access errors. * FAILED_PRECONDITION if the requested announcement has already been deleted. * NOT_FOUND if no course exists with the requested ID.

Parameters

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

id string - Identifier of the announcement to delete. This identifier is a Classroom-assigned identifier.

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

Return Type

Response|error - Successful response

patchCoursesAnnouncements

Isolated FunctionRemote Function

function patchCoursesAnnouncements(string courseId, string id, Announcement payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? updateMask) returns Announcement|error

Updates one or more fields of an announcement. This method returns the following error codes: * PERMISSION_DENIED if the requesting developer project did not create the corresponding announcement or for access errors. * INVALID_ARGUMENT if the request is malformed. * FAILED_PRECONDITION if the requested announcement has already been deleted. * NOT_FOUND if the requested course or announcement does not exist

Parameters

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

id string - Identifier of the announcement.

payload Announcement - Announcement request

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

updateMask string? (default ()) - Mask that identifies which fields on the announcement 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 Announcement object. If a field that does not support empty values is included in the update mask and not set in the Announcement object, an INVALID_ARGUMENT error is returned. The following fields may be specified by teachers: * text * state * scheduled_time

Return Type

Announcement|error - Successful response

modifyassigneesCoursesAnnouncements

Isolated FunctionRemote Function

function modifyassigneesCoursesAnnouncements(string courseId, string id, ModifyAnnouncementAssigneesRequest payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Announcement|error

Modifies assignee mode and options of an announcement. Only a teacher of the course that contains the announcement may call this method. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to access the requested course or course work or for access errors. * INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if the requested course or course work does not exist.

Parameters

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

id string - Identifier of the announcement.

payload ModifyAnnouncementAssigneesRequest - Modify announcement assignees request

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

Return Type

Announcement|error - Successful response

listCoursesCoursework

Isolated FunctionRemote Function

function listCoursesCoursework(string courseId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string[]? courseWorkStates, string? orderBy, int? pageSize, string? pageToken) returns ListCourseWorkResponse|error

Returns a list of course work that the requester is permitted to view. Course students may only view PUBLISHED course work. Course teachers and domain administrators may view all course work. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to access the requested course or for access errors. * INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if the requested course does not exist.

Parameters

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

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

courseWorkStates string[]? (default ()) - Restriction on the work status to return. Only courseWork that matches is returned. If unspecified, items with a work status of PUBLISHED is returned.

orderBy string? (default ()) - Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported fields are updateTime and dueDate. Supported direction keywords are asc and desc. If not specified, updateTime desc is the default behavior. Examples: dueDate asc,updateTime desc, updateTime,dueDate desc

pageSize int? (default ()) - Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.

pageToken string? (default ()) - nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.

Return Type

ListCourseWorkResponse|error - Successful response

createCoursesCoursework

Isolated FunctionRemote Function

function createCoursesCoursework(string courseId, CourseWork payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns CourseWork|error

Creates course work. The resulting course work (and corresponding student submissions) are associated with the Developer Console project of the OAuth client ID used to make the request. Classroom API requests to modify course work and student submissions must be made with an OAuth client ID from the associated Developer Console project. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to access the requested course, create course work in the requested course, share a Drive attachment, or for access errors. * INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if the requested course does not exist. * FAILED_PRECONDITION for the following request error: * AttachmentNotVisible

Parameters

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

payload CourseWork - CourseWork request

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

Return Type

CourseWork|error - Successful response

listCoursesCourseworkStudentsubmissions

Isolated FunctionRemote Function

function listCoursesCourseworkStudentsubmissions(string courseId, string courseWorkId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? late, int? pageSize, string? pageToken, string[]? states, string? userId) returns ListStudentSubmissionsResponse|error

Returns a list of student submissions that the requester is permitted to view, factoring in the OAuth scopes of the request. - may be specified as the course_work_id to include student submissions for multiple course work items. Course students may only view their own work. Course teachers and domain administrators may view all student submissions. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to access the requested course or course work, or for access errors. * INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if the requested course does not exist.

Parameters

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

courseWorkId string - Identifier of the student work to request. This may be set to the string literal "-" to request student work for all course work in the specified course.

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

late string? (default ()) - Requested lateness value. If specified, returned student submissions are restricted by the requested value. If unspecified, submissions are returned regardless of late value.

pageSize int? (default ()) - Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.

pageToken string? (default ()) - nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.

states string[]? (default ()) - Requested submission states. If specified, returned student submissions match one of the specified submission states.

userId string? (default ()) - Optional argument to restrict returned student work to those owned by the student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal "me", indicating the requesting user

Return Type

ListStudentSubmissionsResponse|error - Successful response

getCoursesCourseworkStudentsubmissions

Isolated FunctionRemote Function

function getCoursesCourseworkStudentsubmissions(string courseId, string courseWorkId, string id, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns StudentSubmission|error

Returns a student submission. * PERMISSION_DENIED if the requesting user is not permitted to access the requested course, course work, or student submission or for access errors. * INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if the requested course, course work, or student submission does not exist.

Parameters

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

courseWorkId string - Identifier of the course work.

id string - Identifier of the student submission.

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

Return Type

StudentSubmission|error - Successful response

patchCoursesCourseworkStudentsubmissions

Isolated FunctionRemote Function

function patchCoursesCourseworkStudentsubmissions(string courseId, string courseWorkId, string id, StudentSubmission payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? updateMask) returns StudentSubmission|error

Updates one or more fields of a student submission. See google.classroom.v1.StudentSubmission for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the OAuth client ID used to create the corresponding course work item. This method returns the following error codes: * PERMISSION_DENIED if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if the requested course, course work, or student submission does not exist.

Parameters

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

courseWorkId string - Identifier of the course work.

id string - Identifier of the student submission.

payload StudentSubmission - StudentSubmission request

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

updateMask string? (default ()) - Mask that identifies which fields on the student submission to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields may be specified by teachers: * draft_grade * assigned_grade

Return Type

StudentSubmission|error - Successful response

modifyattachmentsCoursesCourseworkStudentsubmissions

Isolated FunctionRemote Function

function modifyattachmentsCoursesCourseworkStudentsubmissions(string courseId, string courseWorkId, string id, ModifyAttachmentsRequest payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns StudentSubmission|error

Modifies attachments of student submission. Attachments may only be added to student submissions belonging to course work objects with a workType of ASSIGNMENT. This request must be made by the Developer Console project of the OAuth client ID used to create the corresponding course work item. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to access the requested course or course work, if the user is not permitted to modify attachments on the requested student submission, or for access errors. * INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if the requested course, course work, or student submission does not exist.

Parameters

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

courseWorkId string - Identifier of the course work.

id string - Identifier of the student submission.

payload ModifyAttachmentsRequest - Modify attachments request

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

Return Type

StudentSubmission|error - Successful response

reclaimCoursesCourseworkStudentsubmissions

Isolated FunctionRemote Function

function reclaimCoursesCourseworkStudentsubmissions(string courseId, string courseWorkId, string id, ReclaimStudentSubmissionRequest payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Response|error

Reclaims a student submission on behalf of the student that owns it. Reclaiming a student submission transfers ownership of attached Drive files to the student and updates the submission state. Only the student that owns the requested student submission may call this method, and only for a student submission that has been turned in. This request must be made by the Developer Console project of the OAuth client ID used to create the corresponding course work item. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to access the requested course or course work, unsubmit the requested student submission, or for access errors. * FAILED_PRECONDITION if the student submission has not been turned in. * INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if the requested course, course work, or student submission does not exist.

Parameters

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

courseWorkId string - Identifier of the course work.

id string - Identifier of the student submission.

payload ReclaimStudentSubmissionRequest - ReclaimStudentSubmission request

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

Return Type

Response|error - Successful response

returnCoursesCourseworkStudentsubmissions

Isolated FunctionRemote Function

function returnCoursesCourseworkStudentsubmissions(string courseId, string courseWorkId, string id, ReturnStudentSubmissionRequest payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Response|error

Returns a student submission. Returning a student submission transfers ownership of attached Drive files to the student and may also update the submission state. Unlike the Classroom application, returning a student submission does not set assignedGrade to the draftGrade value. Only a teacher of the course that contains the requested student submission may call this method. This request must be made by the Developer Console project of the OAuth client ID used to create the corresponding course work item. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to access the requested course or course work, return the requested student submission, or for access errors. * INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if the requested course, course work, or student submission does not exist.

Parameters

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

courseWorkId string - Identifier of the course work.

id string - Identifier of the student submission.

payload ReturnStudentSubmissionRequest - ReturnStudentSubmission request

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

Return Type

Response|error - Successful response

turninCoursesCourseworkStudentsubmissions

Isolated FunctionRemote Function

function turninCoursesCourseworkStudentsubmissions(string courseId, string courseWorkId, string id, TurnInStudentSubmissionRequest payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Response|error

Turns in a student submission. Turning in a student submission transfers ownership of attached Drive files to the teacher and may also update the submission state. This may only be called by the student that owns the specified student submission. This request must be made by the Developer Console project of the OAuth client ID used to create the corresponding course work item. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to access the requested course or course work, turn in the requested student submission, or for access errors. * INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if the requested course, course work, or student submission does not exist.

Parameters

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

courseWorkId string - Identifier of the course work.

id string - Identifier of the student submission.

payload TurnInStudentSubmissionRequest - TurnInStudentSubmission request

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

Return Type

Response|error - Successful response

getCoursesCoursework

Isolated FunctionRemote Function

function getCoursesCoursework(string courseId, string id, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns CourseWork|error

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

Parameters

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

id string - Identifier of the course work.

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

Return Type

CourseWork|error - Successful response

deleteCoursesCoursework

Isolated FunctionRemote Function

function deleteCoursesCoursework(string courseId, string id, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Response|error

Deletes a course work. This request must be made by the Developer Console project of the OAuth client ID used to create the corresponding course work item. This method returns the following error codes: * PERMISSION_DENIED if the requesting developer project did not create the corresponding course work, if the requesting user is not permitted to delete the requested course or for access errors. * FAILED_PRECONDITION if the requested course work has already been deleted. * NOT_FOUND if no course exists with the requested ID.

Parameters

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

id string - Identifier of the course work to delete. This identifier is a Classroom-assigned identifier.

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

Return Type

Response|error - Successful response

patchCoursesCoursework

Isolated FunctionRemote Function

function patchCoursesCoursework(string courseId, string id, CourseWork payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? updateMask) returns CourseWork|error

Updates one or more fields of a course work. See google.classroom.v1.CourseWork for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the OAuth client ID used to create the corresponding course work item. This method returns the following error codes: * PERMISSION_DENIED if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * INVALID_ARGUMENT if the request is malformed. * FAILED_PRECONDITION if the requested course work has already been deleted. * NOT_FOUND if the requested course, course work, or student submission does not exist.

Parameters

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

id string - Identifier of the course work.

payload CourseWork - CourseWork request

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

updateMask string? (default ()) - 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

Return Type

CourseWork|error - Successful response

modifyassigneesCoursesCoursework

Isolated FunctionRemote Function

function modifyassigneesCoursesCoursework(string courseId, string id, ModifyCourseWorkAssigneesRequest payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns CourseWork|error

Modifies assignee mode and options of a coursework. Only a teacher of the course that contains the coursework may call this method. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to access the requested course or course work or for access errors. * INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if the requested course or course work does not exist.

Parameters

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

id string - Identifier of the coursework.

payload ModifyCourseWorkAssigneesRequest - ModifyCourseWorkAssignees request

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

Return Type

CourseWork|error - Successful response

listCoursesCourseworkmaterials

Isolated FunctionRemote Function

function listCoursesCourseworkmaterials(string courseId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string[]? courseWorkMaterialStates, string? materialDriveId, string? materialLink, string? orderBy, int? pageSize, string? pageToken) returns ListCourseWorkMaterialResponse|error

Returns a list of course work material that the requester is permitted to view. Course students may only view PUBLISHED course work material. Course teachers and domain administrators may view all 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 for access errors. * INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if the requested course does not exist.

Parameters

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

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

courseWorkMaterialStates string[]? (default ()) - Restriction on the work status to return. Only course work material that matches is returned. If unspecified, items with a work status of PUBLISHED is returned.

materialDriveId string? (default ()) - Optional filtering for course work material with at least one Drive material whose ID matches the provided string. If material_link is also specified, course work material must have materials matching both filters.

materialLink string? (default ()) - Optional filtering for course work material with at least one link material whose URL partially matches the provided string.

orderBy string? (default ()) - Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported field is updateTime. Supported direction keywords are asc and desc. If not specified, updateTime desc is the default behavior. Examples: updateTime asc, updateTime

pageSize int? (default ()) - Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.

pageToken string? (default ()) - nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.

Return Type

ListCourseWorkMaterialResponse|error - Successful response

createCoursesCourseworkmaterials

Isolated FunctionRemote Function

function createCoursesCourseworkmaterials(string courseId, CourseWorkMaterial payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns CourseWorkMaterial|error

Creates 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, create course work material in the requested course, share a Drive attachment, or for access errors. * INVALID_ARGUMENT if the request is malformed or if more than 20 * materials are provided. * NOT_FOUND if the requested course does not exist. * FAILED_PRECONDITION for the following request error: * AttachmentNotVisible

Parameters

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

payload CourseWorkMaterial - CourseWorkMaterial

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

Return Type

CourseWorkMaterial|error - Successful response

getCoursesCourseworkmaterials

Isolated FunctionRemote Function

function getCoursesCourseworkmaterials(string courseId, string id, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns CourseWorkMaterial|error

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.

Parameters

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

id string - Identifier of the course work material.

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

Return Type

CourseWorkMaterial|error - Successful response

deleteCoursesCourseworkmaterials

Isolated FunctionRemote Function

function deleteCoursesCourseworkmaterials(string courseId, string id, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Response|error

Deletes a course work material. This request must be made by the Developer Console project of the OAuth client ID used to create the corresponding course work material item. This method returns the following error codes: * PERMISSION_DENIED if the requesting developer project did not create the corresponding course work material, if the requesting user is not permitted to delete the requested course or for access errors. * FAILED_PRECONDITION if the requested course work material has already been deleted. * NOT_FOUND if no course exists with the requested ID.

Parameters

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

id string - Identifier of the course work material to delete. This identifier is a Classroom-assigned identifier.

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

Return Type

Response|error - Successful response

patchCoursesCourseworkmaterials

Isolated FunctionRemote Function

function patchCoursesCourseworkmaterials(string courseId, string id, CourseWorkMaterial payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? updateMask) returns CourseWorkMaterial|error

Updates one or more fields of a course work material. This method returns the following error codes: * PERMISSION_DENIED if the requesting developer project for access errors. * INVALID_ARGUMENT if the request is malformed. * FAILED_PRECONDITION if the requested course work material has already been deleted. * NOT_FOUND if the requested course or course work material does not exist

Parameters

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

id string - Identifier of the course work material.

payload CourseWorkMaterial - CourseWorkMaterial request

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

updateMask string? (default ()) - Mask that identifies which fields on the course work material 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 course work material object. If a field that does not support empty values is included in the update mask and not set in the course work material object, an INVALID_ARGUMENT error is returned. The following fields may be specified by teachers: * title * description * state * scheduled_time * topic_id

Return Type

CourseWorkMaterial|error - Successful response

listCoursesStudents

Isolated FunctionRemote Function

function listCoursesStudents(string courseId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, int? pageSize, string? pageToken) returns ListStudentsResponse|error

Returns a list of students of this course that the requester is permitted to view. This method returns the following error codes: * NOT_FOUND if the course does not exist. * PERMISSION_DENIED for access errors.

Parameters

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

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

pageSize int? (default ()) - Maximum number of items to return. The default is 30 if unspecified or 0. The server may return fewer than the specified number of results.

pageToken string? (default ()) - nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.

Return Type

ListStudentsResponse|error - Successful response

createCoursesStudents

Isolated FunctionRemote Function

function createCoursesStudents(string courseId, Student payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? enrollmentCode) returns Student|error

Adds a user as a student of a course. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to create students in this course or for access errors. * NOT_FOUND if the requested course ID does not exist. * FAILED_PRECONDITION if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * UserGroupsMembershipLimitReached * ALREADY_EXISTS if the user is already a student or teacher in the course.

Parameters

courseId string - Identifier of the course to create the student in. This identifier can be either the Classroom-assigned identifier or an alias.

payload Student - Student request

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

enrollmentCode string? (default ()) - Enrollment code of the course to create the student in. This code is required if userId corresponds to the requesting user; it may be omitted if the requesting user has administrative permissions to create students for any user.

Return Type

Student|error - Successful response

getCoursesStudents

Isolated FunctionRemote Function

function getCoursesStudents(string courseId, string userId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Student|error

Returns a student of a course. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to view students of this course or for access errors. * NOT_FOUND if no student of this course has the requested ID or if the course does not exist.

Parameters

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

userId string - Identifier of the student to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal "me", indicating the requesting user

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

Return Type

Student|error - Successful response

deleteCoursesStudents

Isolated FunctionRemote Function

function deleteCoursesStudents(string courseId, string userId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Response|error

Deletes a student of a course. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to delete students of this course or for access errors. * NOT_FOUND if no student of this course has the requested ID or if the course does not exist.

Parameters

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

userId string - Identifier of the student to delete. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal "me", indicating the requesting user

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

Return Type

Response|error - Successful response

listCoursesTeachers

Isolated FunctionRemote Function

function listCoursesTeachers(string courseId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, int? pageSize, string? pageToken) returns ListTeachersResponse|error

Returns a list of teachers of this course that the requester is permitted to view. This method returns the following error codes: * NOT_FOUND if the course does not exist. * PERMISSION_DENIED for access errors.

Parameters

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

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

pageSize int? (default ()) - Maximum number of items to return. The default is 30 if unspecified or 0. The server may return fewer than the specified number of results.

pageToken string? (default ()) - nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.

Return Type

ListTeachersResponse|error - Successful response

createCoursesTeachers

Isolated FunctionRemote Function

function createCoursesTeachers(string courseId, Teacher payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Teacher|error

Creates a teacher of a course. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to create teachers in this course or for access errors. * NOT_FOUND if the requested course ID does not exist. * FAILED_PRECONDITION if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * ALREADY_EXISTS if the user is already a teacher or student in the course.

Parameters

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

payload Teacher - Teacher request

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

Return Type

Teacher|error - Successful response

getCoursesTeachers

Isolated FunctionRemote Function

function getCoursesTeachers(string courseId, string userId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Teacher|error

Returns a teacher of a course. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to view teachers of this course or for access errors. * NOT_FOUND if no teacher of this course has the requested ID or if the course does not exist.

Parameters

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

userId string - Identifier of the teacher to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal "me", indicating the requesting user

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

Return Type

Teacher|error - Successful response

deleteCoursesTeachers

Isolated FunctionRemote Function

function deleteCoursesTeachers(string courseId, string userId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Response|error

Deletes a teacher of a course. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to delete teachers of this course or for access errors. * NOT_FOUND if no teacher of this course has the requested ID or if the course does not exist. * FAILED_PRECONDITION if the requested ID belongs to the primary teacher of this course.

Parameters

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

userId string - Identifier of the teacher to delete. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal "me", indicating the requesting user

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

Return Type

Response|error - Successful response

listCoursesTopics

Isolated FunctionRemote Function

function listCoursesTopics(string courseId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, int? pageSize, string? pageToken) returns ListTopicResponse|error

Returns the list of topics that the requester is permitted to view. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to access the requested course or for access errors. * INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if the requested course does not exist.

Parameters

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

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

pageSize int? (default ()) - Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.

pageToken string? (default ()) - nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.

Return Type

ListTopicResponse|error - Successful response

createCoursesTopics

Isolated FunctionRemote Function

function createCoursesTopics(string courseId, Topic payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Topic|error

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

Parameters

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

payload Topic - Topic request

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

Return Type

Topic|error - Successful response

getCoursesTopics

Isolated FunctionRemote Function

function getCoursesTopics(string courseId, string id, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Topic|error

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

Parameters

courseId string - Identifier of the course.

id string - Identifier of the topic.

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

Return Type

Topic|error - Successful response

deleteCoursesTopics

Isolated FunctionRemote Function

function deleteCoursesTopics(string courseId, string id, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Response|error

Deletes a topic. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not allowed to delete the requested topic or for access errors. * FAILED_PRECONDITION if the requested topic has already been deleted. * NOT_FOUND if no course or topic exists with the requested ID.

Parameters

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

id string - Identifier of the topic to delete.

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

Return Type

Response|error - Successful response

patchCoursesTopics

Isolated FunctionRemote Function

function patchCoursesTopics(string courseId, string id, Topic payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? updateMask) returns Topic|error

Updates one or more fields of a topic. This method returns the following error codes: * PERMISSION_DENIED if the requesting developer project did not create the corresponding topic or for access errors. * INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if the requested course or topic does not exist

Parameters

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

id string - Identifier of the topic.

payload Topic - Topic request

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

updateMask string? (default ()) - Mask that identifies which fields on the topic 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 Topic object. If a field that does not support empty values is included in the update mask and not set in the Topic object, an INVALID_ARGUMENT error is returned. The following fields may be specified: * name

Return Type

Topic|error - Successful response

getCourses

Isolated FunctionRemote Function

function getCourses(string id, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Course|error

Returns a course. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to access the requested course or for access errors. * NOT_FOUND if no course exists with the requested ID.

Parameters

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

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

Return Type

Course|error - Successful response

updateCourses

Isolated FunctionRemote Function

function updateCourses(string id, Course payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Course|error

Updates a course. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to modify the requested course or for access errors. * NOT_FOUND if no course exists with the requested ID. * FAILED_PRECONDITION for the following request errors: * CourseNotModifiable

Parameters

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

payload Course - Course request

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

Return Type

Course|error - Successful response

deleteCourses

Isolated FunctionRemote Function

function deleteCourses(string id, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Response|error

Deletes a course. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to delete the requested course or for access errors. * NOT_FOUND if no course exists with the requested ID.

Parameters

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

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

Return Type

Response|error - Successful response

patchCourses

Isolated FunctionRemote Function

function patchCourses(string id, Course payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? updateMask) returns Course|error

Updates one or more fields in a course. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to modify the requested course or for access errors. * NOT_FOUND if no course exists with the requested ID. * INVALID_ARGUMENT if invalid fields are specified in the update mask or if no update mask is supplied. * FAILED_PRECONDITION for the following request errors: * CourseNotModifiable

Parameters

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

payload Course - Course request

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

updateMask string? (default ()) - Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: * name * section * descriptionHeading * description * room * courseState * ownerId Note: patches to ownerId are treated as being effective immediately, but in practice it may take some time for the ownership transfer of all affected resources to complete. When set in a query parameter, this field should be specified as updateMask=,,...

Return Type

Course|error - Successful response

listInvitations

Isolated FunctionRemote Function

function listInvitations(string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? courseId, int? pageSize, string? pageToken, string? userId) returns ListInvitationsResponse|error

Returns a list of invitations that the requesting user is permitted to view, restricted to those that match the list request. Note: At least one of user_id or course_id must be supplied. Both fields can be supplied. This method returns the following error codes: * PERMISSION_DENIED for access errors.

Parameters

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

courseId string? (default ()) - Restricts returned invitations to those for a course with the specified identifier.

pageSize int? (default ()) - Maximum number of items to return. The default is 500 if unspecified or 0. The server may return fewer than the specified number of results.

pageToken string? (default ()) - nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.

userId string? (default ()) - Restricts returned invitations to those for a specific user. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal "me", indicating the requesting user

Return Type

ListInvitationsResponse|error - Successful response

createInvitations

Isolated FunctionRemote Function

function createInvitations(Invitation payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Invitation|error

Creates an invitation. Only one invitation for a user and course may exist at a time. Delete and re-create an invitation to make changes. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to create invitations for this course or for access errors. * NOT_FOUND if the course or the user does not exist. * FAILED_PRECONDITION if the requested user's account is disabled or if the user already has this role or a role with greater permissions. * ALREADY_EXISTS if an invitation for the specified user and course already exists.

Parameters

payload Invitation - Invitation request

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

Return Type

Invitation|error - Successful response

getInvitations

Isolated FunctionRemote Function

function getInvitations(string id, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Invitation|error

Returns an invitation. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to view the requested invitation or for access errors. * NOT_FOUND if no invitation exists with the requested ID.

Parameters

id string - Identifier of the invitation to return.

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

Return Type

Invitation|error - Successful response

deleteInvitations

Isolated FunctionRemote Function

function deleteInvitations(string id, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Response|error

Deletes an invitation. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to delete the requested invitation or for access errors. * NOT_FOUND if no invitation exists with the requested ID.

Parameters

id string - Identifier of the invitation to delete.

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

Return Type

Response|error - Successful response

acceptInvitations

Isolated FunctionRemote Function

function acceptInvitations(string id, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Response|error

Accepts an invitation, removing it and adding the invited user to the teachers or students (as appropriate) of the specified course. Only the invited user may accept an invitation. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to accept the requested invitation or for access errors. * FAILED_PRECONDITION for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * NOT_FOUND if no invitation exists with the requested ID.

Parameters

id string - Identifier of the invitation to accept.

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

Return Type

Response|error - Successful response

createRegistrations

Isolated FunctionRemote Function

function createRegistrations(Registration payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Registration|error

Creates a Registration, causing Classroom to start sending notifications from the provided feed to the destination provided in cloudPubSubTopic. Returns the created Registration. Currently, this will be the same as the argument, but with server-assigned fields such as expiry_time and id filled in. Note that any value specified for the expiry_time or id fields will be ignored. While Classroom may validate the cloudPubSubTopic and return errors on a best effort basis, it is the caller's responsibility to ensure that it exists and that Classroom has permission to publish to it. This method may return the following error codes: * PERMISSION_DENIED if: * the authenticated user does not have permission to receive notifications from the requested field; or * the current user has not granted access to the current Cloud project with the appropriate scope for the requested feed. Note that domain-wide delegation of authority is not currently supported for this purpose. If the request has the appropriate scope, but no grant exists, a Request Errors is returned. * another access error is encountered. * INVALID_ARGUMENT if: * no cloudPubsubTopic is specified, or the specified cloudPubsubTopic is not valid; or * no feed is specified, or the specified feed is not valid. * NOT_FOUND if: * the specified feed cannot be located, or the requesting user does not have permission to determine whether or not it exists; or * the specified cloudPubsubTopic cannot be located, or Classroom has not been granted permission to publish to it.

Parameters

payload Registration - Registration request

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

Return Type

Registration|error - Successful response

deleteRegistrations

Isolated FunctionRemote Function

function deleteRegistrations(string registrationId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Response|error

Deletes a Registration, causing Classroom to stop sending notifications for that Registration.

Parameters

registrationId string - The registration_id of the Registration to be deleted.

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

Return Type

Response|error - Successful response

listUserprofilesGuardianinvitations

Isolated FunctionRemote Function

function listUserprofilesGuardianinvitations(string studentId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? invitedEmailAddress, int? pageSize, string? pageToken, string[]? states) returns ListGuardianInvitationsResponse|error

Returns a list of guardian invitations that the requesting user is permitted to view, filtered by the parameters provided. This method returns the following error codes: * PERMISSION_DENIED if a student_id is specified, and the requesting user is not permitted to view guardian invitations for that student, if "-" is specified as the student_id and the user is not a domain administrator, if guardians are not enabled for the domain in question, or for other access errors. * INVALID_ARGUMENT if a student_id is specified, but its format cannot be recognized (it is not an email address, nor a student_id from the API, nor the literal string me). May also be returned if an invalid page_token or state is provided. * NOT_FOUND if a student_id is specified, and its format can be recognized, but Classroom has no record of that student.

Parameters

studentId string - The ID of the student whose guardian invitations are to be returned. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal "me", indicating the requesting user * the string literal "-", indicating that results should be returned for all students that the requesting user is permitted to view guardian invitations.

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

invitedEmailAddress string? (default ()) - If specified, only results with the specified invited_email_address are returned.

pageSize int? (default ()) - Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.

pageToken string? (default ()) - nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.

states string[]? (default ()) - If specified, only results with the specified state values are returned. Otherwise, results with a state of PENDING are returned.

Return Type

ListGuardianInvitationsResponse|error - Successful response

createUserprofilesGuardianinvitations

Isolated FunctionRemote Function

function createUserprofilesGuardianinvitations(string studentId, GuardianInvitation payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns GuardianInvitation|error

Creates a guardian invitation, and sends an email to the guardian asking them to confirm that they are the student's guardian. Once the guardian accepts the invitation, their state will change to COMPLETED and they will start receiving guardian notifications. A Guardian resource will also be created to represent the active guardian. The request object must have the student_id and invited_email_address fields set. Failing to set these fields, or setting any other fields in the request, will result in an error. This method returns the following error codes: * PERMISSION_DENIED if the current user does not have permission to manage guardians, if the guardian in question has already rejected too many requests for that student, if guardians are not enabled for the domain in question, or for other access errors. * RESOURCE_EXHAUSTED if the student or guardian has exceeded the guardian link limit. * INVALID_ARGUMENT if the guardian email address is not valid (for example, if it is too long), or if the format of the student ID provided cannot be recognized (it is not an email address, nor a user_id from this API). This error will also be returned if read-only fields are set, or if the state field is set to to a value other than PENDING. * NOT_FOUND if the student ID provided is a valid student ID, but Classroom has no record of that student. * ALREADY_EXISTS if there is already a pending guardian invitation for the student and invited_email_address provided, or if the provided invited_email_address matches the Google account of an existing Guardian for this user.

Parameters

studentId string - ID of the student (in standard format)

payload GuardianInvitation - GuardianInvitation request

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

Return Type

GuardianInvitation|error - Successful response

getUserprofilesGuardianinvitations

Isolated FunctionRemote Function

function getUserprofilesGuardianinvitations(string studentId, string invitationId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns GuardianInvitation|error

Returns a specific guardian invitation. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to view guardian invitations for the student identified by the student_id, if guardians are not enabled for the domain in question, or for other access errors. * INVALID_ARGUMENT if a student_id is specified, but its format cannot be recognized (it is not an email address, nor a student_id from the API, nor the literal string me). * NOT_FOUND if Classroom cannot find any record of the given student or invitation_id. May also be returned if the student exists, but the requesting user does not have access to see that student.

Parameters

studentId string - The ID of the student whose guardian invitation is being requested.

invitationId string - The id field of the GuardianInvitation being requested.

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

Return Type

GuardianInvitation|error - Successful response

patchUserprofilesGuardianinvitations

Isolated FunctionRemote Function

function patchUserprofilesGuardianinvitations(string studentId, string invitationId, GuardianInvitation payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? updateMask) returns GuardianInvitation|error

Modifies a guardian invitation. Currently, the only valid modification is to change the state from PENDING to COMPLETE. This has the effect of withdrawing the invitation. This method returns the following error codes: * PERMISSION_DENIED if the current user does not have permission to manage guardians, if guardians are not enabled for the domain in question or for other access errors. * FAILED_PRECONDITION if the guardian link is not in the PENDING state. * INVALID_ARGUMENT if the format of the student ID provided cannot be recognized (it is not an email address, nor a user_id from this API), or if the passed GuardianInvitation has a state other than COMPLETE, or if it modifies fields other than state. * NOT_FOUND if the student ID provided is a valid student ID, but Classroom has no record of that student, or if the id field does not refer to a guardian invitation known to Classroom.

Parameters

studentId string - The ID of the student whose guardian invitation is to be modified.

invitationId string - The id field of the GuardianInvitation to be modified.

payload GuardianInvitation - GuardianInvitation request

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

updateMask string? (default ()) - Mask that identifies which fields on the course to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields are valid: * state When set in a query parameter, this field should be specified as updateMask=,,...

Return Type

GuardianInvitation|error - Successful response

listUserprofilesGuardians

Isolated FunctionRemote Function

function listUserprofilesGuardians(string studentId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? invitedEmailAddress, int? pageSize, string? pageToken) returns ListGuardiansResponse|error

Returns a list of guardians that the requesting user is permitted to view, restricted to those that match the request. To list guardians for any student that the requesting user may view guardians for, use the literal character - for the student ID. This method returns the following error codes: * PERMISSION_DENIED if a student_id is specified, and the requesting user is not permitted to view guardian information for that student, if "-" is specified as the student_id and the user is not a domain administrator, if guardians are not enabled for the domain in question, if the invited_email_address filter is set by a user who is not a domain administrator, or for other access errors. * INVALID_ARGUMENT if a student_id is specified, but its format cannot be recognized (it is not an email address, nor a student_id from the API, nor the literal string me). May also be returned if an invalid page_token is provided. * NOT_FOUND if a student_id is specified, and its format can be recognized, but Classroom has no record of that student.

Parameters

studentId string - Filter results by the student who the guardian is linked to. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal "me", indicating the requesting user * the string literal "-", indicating that results should be returned for all students that the requesting user has access to view.

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

invitedEmailAddress string? (default ()) - Filter results by the email address that the original invitation was sent to, resulting in this guardian link. This filter can only be used by domain administrators.

pageSize int? (default ()) - Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.

pageToken string? (default ()) - nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.

Return Type

ListGuardiansResponse|error - Successful response

getUserprofilesGuardians

Isolated FunctionRemote Function

function getUserprofilesGuardians(string studentId, string guardianId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Guardian|error

Returns a specific guardian. This method returns the following error codes: * PERMISSION_DENIED if no user that matches the provided student_id is visible to the requesting user, if the requesting user is not permitted to view guardian information for the student identified by the student_id, if guardians are not enabled for the domain in question, or for other access errors. * INVALID_ARGUMENT if a student_id is specified, but its format cannot be recognized (it is not an email address, nor a student_id from the API, nor the literal string me). * NOT_FOUND if the requesting user is permitted to view guardians for the requested student_id, but no Guardian record exists for that student that matches the provided guardian_id.

Parameters

studentId string - The student whose guardian is being requested. One of the following: * the numeric identifier for the user * the email address of the user * the string literal "me", indicating the requesting user

guardianId string - The id field from a Guardian.

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

Return Type

Guardian|error - Successful response

deleteUserprofilesGuardians

Isolated FunctionRemote Function

function deleteUserprofilesGuardians(string studentId, string guardianId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Response|error

Deletes a guardian. The guardian will no longer receive guardian notifications and the guardian will no longer be accessible via the API. This method returns the following error codes: * PERMISSION_DENIED if no user that matches the provided student_id is visible to the requesting user, if the requesting user is not permitted to manage guardians for the student identified by the student_id, if guardians are not enabled for the domain in question, or for other access errors. * INVALID_ARGUMENT if a student_id is specified, but its format cannot be recognized (it is not an email address, nor a student_id from the API). * NOT_FOUND if the requesting user is permitted to modify guardians for the requested student_id, but no Guardian record exists for that student with the provided guardian_id.

Parameters

studentId string - The student whose guardian is to be deleted. One of the following: * the numeric identifier for the user * the email address of the user * the string literal "me", indicating the requesting user

guardianId string - The id field from a Guardian.

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

Return Type

Response|error - Successful response

getUserprofiles

Isolated FunctionRemote Function

function getUserprofiles(string userId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns UserProfile|error

Returns a user profile. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to access this user profile, if no profile exists with the requested ID, or for access errors.

Parameters

userId string - Identifier of the profile to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal "me", indicating the requesting user

xgafv string? (default ()) - V1 error format.

alt string? (default ()) - Data format for response.

callback string? (default ()) - JSONP

fields string? (default ()) - Selector specifying which fields to include in a partial response.

quotaUser string? (default ()) - 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.

uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").

uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").

Return Type

UserProfile|error - Successful response

Records

googleapis.classroom: Announcement

Announcement created by a teacher for students of the course

Fields

alternateLink string? - Absolute link to this announcement in the Classroom web UI. This is only populated if state is PUBLISHED. Read-only.

assigneeMode string? - Assignee mode of the announcement. If unspecified, the default value is ALL_STUDENTS.

courseId string? - Identifier of the course. Read-only.

creationTime string? - Timestamp when this announcement was created. Read-only.

creatorUserId string? - Identifier for the user that created the announcement. Read-only.

id string? - Classroom-assigned identifier of this announcement, unique per course. Read-only.

individualStudentsOptions IndividualStudentsOptions? - Assignee details about a coursework/announcement. This field is set if and only if assigneeMode is INDIVIDUAL_STUDENTS.

materials Material[]? - Additional materials. Announcements must have no more than 20 material items.

scheduledTime string? - Optional timestamp when this announcement is scheduled to be published.

state string? - Status of this announcement. If unspecified, the default state is DRAFT.

text string? - Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters.

updateTime string? - Timestamp of the most recent change to this announcement. Read-only.

googleapis.classroom: Assignment

Additional details for assignments.

Fields

studentWorkFolder DriveFolder? - Representation of a Google Drive folder.

googleapis.classroom: AssignmentSubmission

Student work for an assignment.

Fields

attachments Attachment[]? - Attachments added by the student. Drive files that correspond to materials with a share mode of STUDENT_COPY may not exist yet if the student has not accessed the assignment in Classroom. Some attachment metadata is only populated if the requesting user has permission to access it. Identifier and alternate_link fields are always available, but others (for example, title) may not be.

googleapis.classroom: Attachment

Attachment added to student assignment work. When creating attachments, setting the form field is not supported.

Fields

driveFile DriveFile? - Representation of a Google Drive file.

form Form? - Google Forms item.

link Link? - URL item.

youTubeVideo YouTubeVideo? - YouTube video item.

googleapis.classroom: ClientHttp1Settings

Closed record

Provides settings related to HTTP/1.x protocol.

Fields

keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests

chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request

proxy ProxyConfig? - Proxy server related options

googleapis.classroom: CloudPubsubTopic

A reference to a Cloud Pub/Sub topic. To register for notifications, the owner of the topic must grant classroom-notifications@system.gserviceaccount.com the projects.topics.publish permission.

Fields

topicName string? - The name field of a Cloud Pub/Sub Topic.

googleapis.classroom: ConnectionConfig

Closed record

Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.

Fields

auth BearerTokenConfig|OAuth2RefreshTokenGrantConfig - Configurations related to client authentication

httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client

http1Settings ClientHttp1Settings? - Configurations related to HTTP/1.x protocol

http2Settings ClientHttp2Settings? - Configurations related to HTTP/2 protocol

timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection

forwarded string(default "disable") - The choice of setting forwarded/x-forwarded header

poolConfig PoolConfiguration? - Configurations associated with request pooling

cache CacheConfig? - HTTP caching related configurations

compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (accept-encoding) header

circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker

retryConfig RetryConfig? - Configurations associated with retrying

responseLimits ResponseLimitConfigs? - Configurations associated with inbound response size limits

secureSocket ClientSecureSocket? - SSL/TLS-related options

proxy ProxyConfig? - Proxy server related options

validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

googleapis.classroom: Course

A Course in Classroom.

Fields

alternateLink string? - Absolute link to this course in the Classroom web UI. Read-only.

calendarId string? - The Calendar ID for a calendar that all course members can see, to which Classroom adds events for course work and announcements in the course. Read-only.

courseGroupEmail string? - The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only.

courseMaterialSets CourseMaterialSet[]? - Sets of materials that appear on the "about" page of this course. Read-only.

courseState string? - State of the course. If unspecified, the default state is PROVISIONED.

creationTime string? - Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.

description string? - Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.

descriptionHeading string? - Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters.

enrollmentCode string? - Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.

guardiansEnabled boolean? - Whether or not guardian notifications are enabled for this course. Read-only.

id string? - Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The id is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error.

name string? - Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.

ownerId string? - The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal "me", indicating the requesting user This must be set in a create request. Admins can also specify this field in a patch course request to transfer ownership. In other contexts, it is read-only.

room string? - Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters.

section string? - Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.

teacherFolder DriveFolder? - Representation of a Google Drive folder.

teacherGroupEmail string? - The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only.

updateTime string? - Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.

googleapis.classroom: CourseAlias

Alternative identifier for a course. An alias uniquely identifies a course. It must be unique within one of the following scopes: * domain: A domain-scoped alias is visible to all users within the alias creator's domain and can be created only by a domain admin. A domain-scoped alias is often used when a course has an identifier external to Classroom. * project: A project-scoped alias is visible to any request from an application using the Developer Console project ID that created the alias and can be created by any project. A project-scoped alias is often used when an application has alternative identifiers. A random value can also be used to avoid duplicate courses in the event of transmission failures, as retrying a request will return ALREADY_EXISTS if a previous one has succeeded.

Fields

alias string? - Alias string. The format of the string indicates the desired alias scoping. * d: indicates a domain-scoped alias. Example: d:math_101 * p: indicates a project-scoped alias. Example: p:abc123 This field has a maximum length of 256 characters.

googleapis.classroom: CourseMaterial

A material attached to a course as part of a material set.

Fields

driveFile DriveFile? - Representation of a Google Drive file.

form Form? - Google Forms item.

link Link? - URL item.

youTubeVideo YouTubeVideo? - YouTube video item.

googleapis.classroom: CourseMaterialSet

A set of materials that appears on the "About" page of the course. These materials might include a syllabus, schedule, or other background information relating to the course as a whole.

Fields

materials CourseMaterial[]? - Materials attached to this set.

title string? - Title for this set.

googleapis.classroom: CourseRosterChangesInfo

Information about a Feed with a feed_type of COURSE_ROSTER_CHANGES.

Fields

courseId string? - The course_id of the course to subscribe to roster changes for.

googleapis.classroom: CourseWork

Course work created by a teacher for students of the course.

Fields

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

assigneeMode string? - Assignee mode of the coursework. If unspecified, the default value is ALL_STUDENTS.

assignment Assignment? - Additional details for assignments.

associatedWithDeveloper boolean? - Whether this course work item is associated with the Developer Console project making the request. See CreateCourseWork for more details. Read-only.

courseId string? - Identifier of the course. Read-only.

creationTime string? - Timestamp when this course work was created. Read-only.

creatorUserId string? - Identifier for the user that created the coursework. Read-only.

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.

dueDate 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 value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and google.protobuf.Timestamp.

dueTime 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.

id string? - Classroom-assigned identifier of this course work, unique per course. Read-only.

individualStudentsOptions IndividualStudentsOptions? - Assignee details about a coursework/announcement. This field is set if and only if assigneeMode is INDIVIDUAL_STUDENTS.

materials Material[]? - Additional materials. CourseWork must have no more than 20 material items.

maxPoints decimal? - Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value.

multipleChoiceQuestion MultipleChoiceQuestion? - Additional details for multiple-choice questions.

scheduledTime string? - Optional timestamp when this course work is scheduled to be published.

state string? - Status of this course work. If unspecified, the default state is DRAFT.

submissionModificationMode string? - Setting to determine when students are allowed to modify submissions. If unspecified, the default value is MODIFIABLE_UNTIL_TURNED_IN.

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

topicId string? - Identifier for the topic that this coursework is associated with. Must match an existing topic in the course.

updateTime string? - Timestamp of the most recent change to this course work. Read-only.

workType string? - Type of this course work. The type is set when the course work is created and cannot be changed.

googleapis.classroom: CourseWorkChangesInfo

Information about a Feed with a feed_type of COURSE_WORK_CHANGES.

Fields

courseId string? - The course_id of the course to subscribe to work changes for.

googleapis.classroom: CourseWorkMaterial

Course work material created by a teacher for students of the course

Fields

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

assigneeMode string? - Assignee mode of the course work material. If unspecified, the default value is ALL_STUDENTS.

courseId string? - Identifier of the course. Read-only.

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

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

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

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

individualStudentsOptions IndividualStudentsOptions? - Assignee details about a coursework/announcement. This field is set if and only if assigneeMode is INDIVIDUAL_STUDENTS.

materials Material[]? - Additional materials. A course work material must have no more than 20 material items.

scheduledTime string? - Optional timestamp when this course work material is scheduled to be published.

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

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

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

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

googleapis.classroom: 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 value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and google.protobuf.Timestamp.

Fields

day int? - 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.

month int? - Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

year int? - Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

googleapis.classroom: DriveFile

Representation of a Google Drive file.

Fields

alternateLink string? - URL that can be used to access the Drive item. Read-only.

id string? - Drive API resource ID.

thumbnailUrl string? - URL of a thumbnail image of the Drive item. Read-only.

title string? - Title of the Drive item. Read-only.

googleapis.classroom: DriveFolder

Representation of a Google Drive folder.

Fields

alternateLink string? - URL that can be used to access the Drive folder. Read-only.

id string? - Drive API resource ID.

title string? - Title of the Drive folder. Read-only.

googleapis.classroom: Empty

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.

googleapis.classroom: Feed

A class of notifications that an application can register to receive. For example: "all roster changes for a domain".

Fields

courseRosterChangesInfo CourseRosterChangesInfo? - Information about a Feed with a feed_type of COURSE_ROSTER_CHANGES.

courseWorkChangesInfo CourseWorkChangesInfo? - Information about a Feed with a feed_type of COURSE_WORK_CHANGES.

feedType string? - The type of feed.

googleapis.classroom: Form

Google Forms item.

Fields

formUrl string? - URL of the form.

responseUrl string? - URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.

thumbnailUrl string? - URL of a thumbnail image of the Form. Read-only.

title string? - Title of the Form. Read-only.

googleapis.classroom: GlobalPermission

Global user permission description.

Fields

permission string? - Permission value.

googleapis.classroom: GradeHistory

The history of each grade on this submission.

Fields

actorUserId string? - The teacher who made the grade change.

gradeChangeType string? - The type of grade change at this time in the submission grade history.

gradeTimestamp string? - When the grade of the submission was changed.

maxPoints decimal? - The denominator of the grade at this time in the submission grade history.

pointsEarned decimal? - The numerator of the grade at this time in the submission grade history.

googleapis.classroom: Guardian

Association between a student and a guardian of that student. The guardian may receive information about the student's course work.

Fields

guardianId string? - Identifier for the guardian.

guardianProfile UserProfile? - Global information for a user.

invitedEmailAddress string? - The email address to which the initial guardian invitation was sent. This field is only visible to domain administrators.

studentId string? - Identifier for the student to whom the guardian relationship applies.

googleapis.classroom: GuardianInvitation

An invitation to become the guardian of a specified user, sent to a specified email address.

Fields

creationTime string? - The time that this invitation was created. Read-only.

invitationId string? - Unique identifier for this invitation. Read-only.

invitedEmailAddress string? - Email address that the invitation was sent to. This field is only visible to domain administrators.

state string? - The state that this invitation is in.

studentId string? - ID of the student (in standard format)

googleapis.classroom: IndividualStudentsOptions

Assignee details about a coursework/announcement. This field is set if and only if assigneeMode is INDIVIDUAL_STUDENTS.

Fields

studentIds string[]? - Identifiers for the students that have access to the coursework/announcement.

googleapis.classroom: Invitation

An invitation to join a course.

Fields

courseId string? - Identifier of the course to invite the user to.

id string? - Identifier assigned by Classroom. Read-only.

role string? - Role to invite the user to have. Must not be COURSE_ROLE_UNSPECIFIED.

userId string? - Identifier of the invited user. When specified as a parameter of a request, this identifier can be set to one of the following: * the numeric identifier for the user * the email address of the user * the string literal "me", indicating the requesting user

googleapis.classroom: Link

URL item.

Fields

thumbnailUrl string? - URL of a thumbnail image of the target URL. Read-only.

title string? - Title of the target of the URL. Read-only.

url string? - URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.

googleapis.classroom: ListAnnouncementsResponse

Response when listing course work.

Fields

announcements Announcement[]? - Announcement items that match the request.

nextPageToken string? - Token identifying the next page of results to return. If empty, no further results are available.

googleapis.classroom: ListCourseAliasesResponse

Response when listing course aliases.

Fields

aliases CourseAlias[]? - The course aliases.

nextPageToken string? - Token identifying the next page of results to return. If empty, no further results are available.

googleapis.classroom: ListCoursesResponse

Response when listing courses.

Fields

courses Course[]? - Courses that match the list request.

nextPageToken string? - Token identifying the next page of results to return. If empty, no further results are available.

googleapis.classroom: ListCourseWorkMaterialResponse

Response when listing course work material.

Fields

courseWorkMaterial CourseWorkMaterial[]? - Course work material items that match the request.

nextPageToken string? - Token identifying the next page of results to return. If empty, no further results are available.

googleapis.classroom: ListCourseWorkResponse

Response when listing course work.

Fields

courseWork CourseWork[]? - Course work items that match the request.

nextPageToken string? - Token identifying the next page of results to return. If empty, no further results are available.

googleapis.classroom: ListGuardianInvitationsResponse

Response when listing guardian invitations.

Fields

guardianInvitations GuardianInvitation[]? - Guardian invitations that matched the list request.

nextPageToken string? - Token identifying the next page of results to return. If empty, no further results are available.

googleapis.classroom: ListGuardiansResponse

Response when listing guardians.

Fields

guardians Guardian[]? - Guardians on this page of results that met the criteria specified in the request.

nextPageToken string? - Token identifying the next page of results to return. If empty, no further results are available.

googleapis.classroom: ListInvitationsResponse

Response when listing invitations.

Fields

invitations Invitation[]? - Invitations that match the list request.

nextPageToken string? - Token identifying the next page of results to return. If empty, no further results are available.

googleapis.classroom: ListStudentsResponse

Response when listing students.

Fields

nextPageToken string? - Token identifying the next page of results to return. If empty, no further results are available.

students Student[]? - Students who match the list request.

googleapis.classroom: ListStudentSubmissionsResponse

Response when listing student submissions.

Fields

nextPageToken string? - Token identifying the next page of results to return. If empty, no further results are available.

studentSubmissions StudentSubmission[]? - Student work that matches the request.

googleapis.classroom: ListTeachersResponse

Response when listing teachers.

Fields

nextPageToken string? - Token identifying the next page of results to return. If empty, no further results are available.

teachers Teacher[]? - Teachers who match the list request.

googleapis.classroom: ListTopicResponse

Response when listing topics.

Fields

nextPageToken string? - Token identifying the next page of results to return. If empty, no further results are available.

topic Topic[]? - Topic items that match the request.

googleapis.classroom: Material

Material attached to course work. When creating attachments, setting the form field is not supported.

Fields

driveFile SharedDriveFile? - Drive file that is used as material for course work.

form Form? - Google Forms item.

link Link? - URL item.

youtubeVideo YouTubeVideo? - YouTube video item.

googleapis.classroom: ModifyAnnouncementAssigneesRequest

Request to modify assignee mode and options of an announcement.

Fields

assigneeMode string? - Mode of the announcement describing whether it is accessible by all students or specified individual students.

modifyIndividualStudentsOptions ModifyIndividualStudentsOptions? - Contains fields to add or remove students from a course work or announcement where the assigneeMode is set to INDIVIDUAL_STUDENTS.

googleapis.classroom: ModifyAttachmentsRequest

Request to modify the attachments of a student submission.

Fields

addAttachments Attachment[]? - Attachments to add. A student submission may not have more than 20 attachments. Form attachments are not supported.

googleapis.classroom: ModifyCourseWorkAssigneesRequest

Request to modify assignee mode and options of a coursework.

Fields

assigneeMode string? - Mode of the coursework describing whether it will be assigned to all students or specified individual students.

modifyIndividualStudentsOptions ModifyIndividualStudentsOptions? - Contains fields to add or remove students from a course work or announcement where the assigneeMode is set to INDIVIDUAL_STUDENTS.

googleapis.classroom: ModifyIndividualStudentsOptions

Contains fields to add or remove students from a course work or announcement where the assigneeMode is set to INDIVIDUAL_STUDENTS.

Fields

addStudentIds string[]? - IDs of students to be added as having access to this coursework/announcement.

removeStudentIds string[]? - IDs of students to be removed from having access to this coursework/announcement.

googleapis.classroom: MultipleChoiceQuestion

Additional details for multiple-choice questions.

Fields

choices string[]? - Possible choices.

googleapis.classroom: MultipleChoiceSubmission

Student work for a multiple-choice question.

Fields

answer string? - Student's select choice.

googleapis.classroom: Name

Details of the user's name.

Fields

familyName string? - The user's last name. Read-only.

fullName string? - The user's full name formed by concatenating the first and last name values. Read-only.

givenName string? - The user's first name. Read-only.

googleapis.classroom: OAuth2RefreshTokenGrantConfig

Closed record

OAuth2 Refresh Token Grant Configs

Fields

Fields Included from *OAuth2RefreshTokenGrantConfig

refreshUrl string
refreshToken string
clientId string
clientSecret string
scopes string|string[]
defaultTokenExpTime decimal
clockSkew decimal
optionalParams map<string>
credentialBearer CredentialBearer
clientConfig ClientConfiguration

refreshUrl string(default "https://accounts.google.com/o/oauth2/token") - Refresh URL

googleapis.classroom: ProxyConfig

Closed record

Proxy server configurations to be used with the HTTP client endpoint.

Fields

host string(default "") - Host name of the proxy server

port int(default 0) - Proxy server port

userName string(default "") - Proxy server username

password string(default "") - Proxy server password

googleapis.classroom: ReclaimStudentSubmissionRequest

Request to reclaim a student submission.

googleapis.classroom: Registration

An instruction to Classroom to send notifications from the feed to the provided destination.

Fields

cloudPubsubTopic CloudPubsubTopic? - A reference to a Cloud Pub/Sub topic. To register for notifications, the owner of the topic must grant classroom-notifications@system.gserviceaccount.com the projects.topics.publish permission.

expiryTime string? - The time until which the Registration is effective. This is a read-only field assigned by the server.

feed Feed? - A class of notifications that an application can register to receive. For example: "all roster changes for a domain".

registrationId string? - A server-generated unique identifier for this Registration. Read-only.

googleapis.classroom: ReturnStudentSubmissionRequest

Request to return a student submission.

googleapis.classroom: SharedDriveFile

Drive file that is used as material for course work.

Fields

driveFile DriveFile? - Representation of a Google Drive file.

shareMode string? - Mechanism by which students access the Drive item.

googleapis.classroom: ShortAnswerSubmission

Student work for a short answer question.

Fields

answer string? - Student response to a short-answer question.

googleapis.classroom: StateHistory

The history of each state this submission has been in.

Fields

actorUserId string? - The teacher or student who made the change.

state string? - The workflow pipeline stage.

stateTimestamp string? - When the submission entered this state.

googleapis.classroom: Student

Student in a course.

Fields

courseId string? - Identifier of the course. Read-only.

profile UserProfile? - Global information for a user.

studentWorkFolder DriveFolder? - Representation of a Google Drive folder.

userId string? - Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal "me", indicating the requesting user

googleapis.classroom: StudentSubmission

Student submission for course work. StudentSubmission items are generated when a CourseWork item is created. StudentSubmissions that have never been accessed (i.e. with state = NEW) may not have a creation time or update time.

Fields

alternateLink string? - Absolute link to the submission in the Classroom web UI. Read-only.

assignedGrade decimal? - Optional grade. If unset, no grade was set. This value must be non-negative. Decimal (that is, non-integer) values are allowed, but are rounded to two decimal places. This may be modified only by course teachers.

assignmentSubmission AssignmentSubmission? - Student work for an assignment.

associatedWithDeveloper boolean? - Whether this student submission is associated with the Developer Console project making the request. See CreateCourseWork for more details. Read-only.

courseId string? - Identifier of the course. Read-only.

courseWorkId string? - Identifier for the course work this corresponds to. Read-only.

courseWorkType string? - Type of course work this submission is for. Read-only.

creationTime string? - Creation time of this submission. This may be unset if the student has not accessed this item. Read-only.

draftGrade decimal? - Optional pending grade. If unset, no grade was set. This value must be non-negative. Decimal (that is, non-integer) values are allowed, but are rounded to two decimal places. This is only visible to and modifiable by course teachers.

id string? - Classroom-assigned Identifier for the student submission. This is unique among submissions for the relevant course work. Read-only.

late boolean? - Whether this submission is late. Read-only.

multipleChoiceSubmission MultipleChoiceSubmission? - Student work for a multiple-choice question.

shortAnswerSubmission ShortAnswerSubmission? - Student work for a short answer question.

state string? - State of this submission. Read-only.

submissionHistory SubmissionHistory[]? - The history of the submission (includes state and grade histories). Read-only.

updateTime string? - Last update time of this submission. This may be unset if the student has not accessed this item. Read-only.

userId string? - Identifier for the student that owns this submission. Read-only.

googleapis.classroom: SubmissionHistory

The history of the submission. This currently includes state and grade histories.

Fields

gradeHistory GradeHistory? - The history of each grade on this submission.

stateHistory StateHistory? - The history of each state this submission has been in.

googleapis.classroom: Teacher

Teacher of a course.

Fields

courseId string? - Identifier of the course. Read-only.

profile UserProfile? - Global information for a user.

userId string? - Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal "me", indicating the requesting user

googleapis.classroom: 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.

Fields

hours int? - 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 int? - Minutes of hour of day. Must be from 0 to 59.

nanos int? - Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

seconds int? - 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.

googleapis.classroom: Topic

Topic created by a teacher for the course

Fields

courseId string? - Identifier of the course. Read-only.

name string? - The name of the topic, generated by the user. Leading and trailing whitespaces, if any, are trimmed. Also, multiple consecutive whitespaces are collapsed into one inside the name. The result must be a non-empty string. Topic names are case sensitive, and must be no longer than 100 characters.

topicId string? - Unique identifier for the topic. Read-only.

updateTime string? - The time the topic was last updated by the system. Read-only.

googleapis.classroom: TurnInStudentSubmissionRequest

Request to turn in a student submission.

googleapis.classroom: UserProfile

Global information for a user.

Fields

emailAddress string? - Email address of the user. Read-only.

id string? - Identifier of the user. Read-only.

name Name? - Details of the user's name.

permissions GlobalPermission[]? - Global permissions of the user. Read-only.

photoUrl string? - URL of user's profile photo. Read-only.

verifiedTeacher boolean? - Represents whether a G Suite for Education user's domain administrator has explicitly verified them as being a teacher. If the user is not a member of a G Suite for Education domain, than this field is always false. Read-only

googleapis.classroom: YouTubeVideo

YouTube video item.

Fields

alternateLink string? - URL that can be used to view the YouTube video. Read-only.

id string? - YouTube API resource ID.

thumbnailUrl string? - URL of a thumbnail image of the YouTube video. Read-only.

title string? - Title of the YouTube video. Read-only.

Import

import ballerinax/googleapis.classroom;

Metadata

Released date: over 1 year ago

Version: 1.5.1

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.4.1

GraalVM compatible: Yes

Pull count

Total: 4

Current verison: 1

Weekly downloads

Source repository

Keywords

Education/Elearning

Cost/Free

Vendor/Google

Contributors

Other versions

1.5.1

1.5.0 1.4.0 1.2.0 1.1.1

Dependencies

ballerina/url/2.2.3 ballerina/http/2.6.1

Cookie policy

Delete policy

clients

records

ballerinax/googleapis.classroom Ballerina library

Overview

Prerequisites

Quickstart

Step 1: Import connector

Step 2: Create a new connector instance

Step 3: Invoke connector operation

Clients

googleapis.classroom: Client

Constructor

listCourses

Parameters

Return Type

createCourses

Parameters

Return Type

listCoursesAliases

Parameters

Return Type

createCoursesAliases

Parameters

Return Type

deleteCoursesAliases

Parameters

Return Type

listCoursesAnnouncements

Parameters

Return Type

createCoursesAnnouncements

Parameters

Return Type

getCoursesAnnouncements

Parameters

Return Type

deleteCoursesAnnouncements

Parameters

Return Type

patchCoursesAnnouncements

Parameters

Return Type

modifyassigneesCoursesAnnouncements

Parameters

Return Type

listCoursesCoursework

Parameters

Return Type

createCoursesCoursework

Parameters

Return Type

listCoursesCourseworkStudentsubmissions

Parameters

Return Type

getCoursesCourseworkStudentsubmissions

Parameters

Return Type

patchCoursesCourseworkStudentsubmissions

Parameters

Return Type

modifyattachmentsCoursesCourseworkStudentsubmissions

Parameters

Return Type

reclaimCoursesCourseworkStudentsubmissions

Parameters

Return Type

returnCoursesCourseworkStudentsubmissions

Parameters

Return Type

turninCoursesCourseworkStudentsubmissions

Parameters

Return Type

getCoursesCoursework

Parameters

Return Type

deleteCoursesCoursework

Parameters

Return Type

patchCoursesCoursework

Parameters