{ "uuid": "e25e3e2e-5a84-4be2-862d-3007ac11211f", "lastMigration": 29, "name": "Google Classroom API", "endpointPrefix": "", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "c13b4201-265b-4c47-85b1-b9ddec67890e", "documentation": "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.", "method": "get", "endpoint": "v1/courses", "responses": [ { "uuid": "230c9e00-3231-4362-bcd5-281b2ab78985", "body": "{\n \"courses\": [\n {\n \"alternateLink\": \"\",\n \"calendarId\": \"\",\n \"courseGroupEmail\": \"\",\n \"courseMaterialSets\": [\n {\n \"materials\": [\n {\n \"driveFile\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n },\n \"form\": {\n \"formUrl\": \"\",\n \"responseUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n },\n \"link\": {\n \"thumbnailUrl\": \"\",\n \"title\": \"\",\n \"url\": \"\"\n },\n \"youTubeVideo\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n }\n }\n ],\n \"title\": \"\"\n }\n ],\n \"courseState\": \"{{oneOf (array 'COURSE_STATE_UNSPECIFIED' 'ACTIVE' 'ARCHIVED' 'PROVISIONED' 'DECLINED' 'SUSPENDED')}}\",\n \"creationTime\": \"\",\n \"description\": \"\",\n \"descriptionHeading\": \"\",\n \"enrollmentCode\": \"\",\n \"gradebookSettings\": {\n \"calculationType\": \"{{oneOf (array 'CALCULATION_TYPE_UNSPECIFIED' 'TOTAL_POINTS' 'WEIGHTED_CATEGORIES')}}\",\n \"displaySetting\": \"{{oneOf (array 'DISPLAY_SETTING_UNSPECIFIED' 'SHOW_OVERALL_GRADE' 'HIDE_OVERALL_GRADE' 'SHOW_TEACHERS_ONLY')}}\",\n \"gradeCategories\": [\n {\n \"defaultGradeDenominator\": {{faker 'number.int' max=99999}},\n \"id\": \"\",\n \"name\": \"\",\n \"weight\": {{faker 'number.int' max=99999}}\n }\n ]\n },\n \"guardiansEnabled\": {{faker 'datatype.boolean'}},\n \"id\": \"\",\n \"name\": \"\",\n \"ownerId\": \"\",\n \"room\": \"\",\n \"section\": \"\",\n \"teacherFolder\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"title\": \"\"\n },\n \"teacherGroupEmail\": \"\",\n \"updateTime\": \"\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "df1fe726-c4c6-4c41-8b00-5e4084e4694c", "documentation": "Creates a course. The user specified in `ownerId` is the owner of the created course and added as a teacher. A non-admin requesting user can only create a course with themselves as the owner. Domain admins can create courses owned by any user within their domain. 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.", "method": "post", "endpoint": "v1/courses", "responses": [ { "uuid": "cfab33e6-b232-43b9-bee9-6bdc2361372f", "body": "{\n \"alternateLink\": \"\",\n \"calendarId\": \"\",\n \"courseGroupEmail\": \"\",\n \"courseMaterialSets\": [\n {\n \"materials\": [\n {\n \"driveFile\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n },\n \"form\": {\n \"formUrl\": \"\",\n \"responseUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n },\n \"link\": {\n \"thumbnailUrl\": \"\",\n \"title\": \"\",\n \"url\": \"\"\n },\n \"youTubeVideo\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n }\n }\n ],\n \"title\": \"\"\n }\n ],\n \"courseState\": \"{{oneOf (array 'COURSE_STATE_UNSPECIFIED' 'ACTIVE' 'ARCHIVED' 'PROVISIONED' 'DECLINED' 'SUSPENDED')}}\",\n \"creationTime\": \"\",\n \"description\": \"\",\n \"descriptionHeading\": \"\",\n \"enrollmentCode\": \"\",\n \"gradebookSettings\": {\n \"calculationType\": \"{{oneOf (array 'CALCULATION_TYPE_UNSPECIFIED' 'TOTAL_POINTS' 'WEIGHTED_CATEGORIES')}}\",\n \"displaySetting\": \"{{oneOf (array 'DISPLAY_SETTING_UNSPECIFIED' 'SHOW_OVERALL_GRADE' 'HIDE_OVERALL_GRADE' 'SHOW_TEACHERS_ONLY')}}\",\n \"gradeCategories\": [\n {\n \"defaultGradeDenominator\": {{faker 'number.int' max=99999}},\n \"id\": \"\",\n \"name\": \"\",\n \"weight\": {{faker 'number.int' max=99999}}\n }\n ]\n },\n \"guardiansEnabled\": {{faker 'datatype.boolean'}},\n \"id\": \"\",\n \"name\": \"\",\n \"ownerId\": \"\",\n \"room\": \"\",\n \"section\": \"\",\n \"teacherFolder\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"title\": \"\"\n },\n \"teacherGroupEmail\": \"\",\n \"updateTime\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e502aa39-99a8-44ca-8817-bb4b361aa9a7", "documentation": "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.", "method": "get", "endpoint": "v1/courses/:courseId/aliases", "responses": [ { "uuid": "a633e601-fa36-4e82-9ae5-0dc3516ff0fe", "body": "{\n \"aliases\": [\n {\n \"alias\": \"\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "18b3ae2b-943f-421f-8146-9eb2b4818c97", "documentation": "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).", "method": "post", "endpoint": "v1/courses/:courseId/aliases", "responses": [ { "uuid": "52b64515-bf63-40e1-9595-cd42ed4af2be", "body": "{\n \"alias\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "90457008-d532-42df-82a5-519983ecd28f", "documentation": "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).", "method": "delete", "endpoint": "v1/courses/:courseId/aliases/:alias", "responses": [ { "uuid": "eb509a77-d2ba-46f7-97ff-c7e836db5fba", "body": "{}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5ef0f49b-a9b1-4cff-afa2-dbe65c779221", "documentation": "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.", "method": "get", "endpoint": "v1/courses/:courseId/announcements", "responses": [ { "uuid": "d17f22e8-dbfa-4a87-bd52-90dca099be02", "body": "{\n \"announcements\": [\n {\n \"alternateLink\": \"\",\n \"assigneeMode\": \"{{oneOf (array 'ASSIGNEE_MODE_UNSPECIFIED' 'ALL_STUDENTS' 'INDIVIDUAL_STUDENTS')}}\",\n \"courseId\": \"\",\n \"creationTime\": \"\",\n \"creatorUserId\": \"\",\n \"id\": \"\",\n \"individualStudentsOptions\": {\n \"studentIds\": [\n \"\"\n ]\n },\n \"materials\": [\n {\n \"driveFile\": {\n \"driveFile\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n },\n \"shareMode\": \"{{oneOf (array 'UNKNOWN_SHARE_MODE' 'VIEW' 'EDIT' 'STUDENT_COPY')}}\"\n },\n \"form\": {\n \"formUrl\": \"\",\n \"responseUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n },\n \"link\": {\n \"thumbnailUrl\": \"\",\n \"title\": \"\",\n \"url\": \"\"\n },\n \"youtubeVideo\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n }\n }\n ],\n \"scheduledTime\": \"\",\n \"state\": \"{{oneOf (array 'ANNOUNCEMENT_STATE_UNSPECIFIED' 'PUBLISHED' 'DRAFT' 'DELETED')}}\",\n \"text\": \"\",\n \"updateTime\": \"\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "eef93f05-f79d-4be2-957a-7c6557b4ae0f", "documentation": "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", "method": "post", "endpoint": "v1/courses/:courseId/announcements", "responses": [ { "uuid": "ff07e6b5-fa26-4e0d-bc44-2680b5dda5b6", "body": "{\n \"alternateLink\": \"\",\n \"assigneeMode\": \"{{oneOf (array 'ASSIGNEE_MODE_UNSPECIFIED' 'ALL_STUDENTS' 'INDIVIDUAL_STUDENTS')}}\",\n \"courseId\": \"\",\n \"creationTime\": \"\",\n \"creatorUserId\": \"\",\n \"id\": \"\",\n \"individualStudentsOptions\": {\n \"studentIds\": [\n \"\"\n ]\n },\n \"materials\": [\n {\n \"driveFile\": {\n \"driveFile\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n },\n \"shareMode\": \"{{oneOf (array 'UNKNOWN_SHARE_MODE' 'VIEW' 'EDIT' 'STUDENT_COPY')}}\"\n },\n \"form\": {\n \"formUrl\": \"\",\n \"responseUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n },\n \"link\": {\n \"thumbnailUrl\": \"\",\n \"title\": \"\",\n \"url\": \"\"\n },\n \"youtubeVideo\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n }\n }\n ],\n \"scheduledTime\": \"\",\n \"state\": \"{{oneOf (array 'ANNOUNCEMENT_STATE_UNSPECIFIED' 'PUBLISHED' 'DRAFT' 'DELETED')}}\",\n \"text\": \"\",\n \"updateTime\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7d8d5d82-ea2a-41d0-962f-258bc663a4b7", "documentation": "Deletes an announcement. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) 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.", "method": "delete", "endpoint": "v1/courses/:courseId/announcements/:id", "responses": [ { "uuid": "a5753d3e-1714-4dd7-8671-7da6289750da", "body": "{}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "577eb31e-2fa9-41eb-9ca5-933174590e1c", "documentation": "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.", "method": "get", "endpoint": "v1/courses/:courseId/announcements/:id", "responses": [ { "uuid": "95488e7f-eba9-45c3-bb6a-9bffe9c9a45b", "body": "{\n \"alternateLink\": \"\",\n \"assigneeMode\": \"{{oneOf (array 'ASSIGNEE_MODE_UNSPECIFIED' 'ALL_STUDENTS' 'INDIVIDUAL_STUDENTS')}}\",\n \"courseId\": \"\",\n \"creationTime\": \"\",\n \"creatorUserId\": \"\",\n \"id\": \"\",\n \"individualStudentsOptions\": {\n \"studentIds\": [\n \"\"\n ]\n },\n \"materials\": [\n {\n \"driveFile\": {\n \"driveFile\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n },\n \"shareMode\": \"{{oneOf (array 'UNKNOWN_SHARE_MODE' 'VIEW' 'EDIT' 'STUDENT_COPY')}}\"\n },\n \"form\": {\n \"formUrl\": \"\",\n \"responseUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n },\n \"link\": {\n \"thumbnailUrl\": \"\",\n \"title\": \"\",\n \"url\": \"\"\n },\n \"youtubeVideo\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n }\n }\n ],\n \"scheduledTime\": \"\",\n \"state\": \"{{oneOf (array 'ANNOUNCEMENT_STATE_UNSPECIFIED' 'PUBLISHED' 'DRAFT' 'DELETED')}}\",\n \"text\": \"\",\n \"updateTime\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d532f637-f250-4462-a023-57238ab32e0c", "documentation": "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", "method": "patch", "endpoint": "v1/courses/:courseId/announcements/:id", "responses": [ { "uuid": "c0b3d68a-c3ab-4071-86d7-b6c2c01e9f4e", "body": "{\n \"alternateLink\": \"\",\n \"assigneeMode\": \"{{oneOf (array 'ASSIGNEE_MODE_UNSPECIFIED' 'ALL_STUDENTS' 'INDIVIDUAL_STUDENTS')}}\",\n \"courseId\": \"\",\n \"creationTime\": \"\",\n \"creatorUserId\": \"\",\n \"id\": \"\",\n \"individualStudentsOptions\": {\n \"studentIds\": [\n \"\"\n ]\n },\n \"materials\": [\n {\n \"driveFile\": {\n \"driveFile\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n },\n \"shareMode\": \"{{oneOf (array 'UNKNOWN_SHARE_MODE' 'VIEW' 'EDIT' 'STUDENT_COPY')}}\"\n },\n \"form\": {\n \"formUrl\": \"\",\n \"responseUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n },\n \"link\": {\n \"thumbnailUrl\": \"\",\n \"title\": \"\",\n \"url\": \"\"\n },\n \"youtubeVideo\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n }\n }\n ],\n \"scheduledTime\": \"\",\n \"state\": \"{{oneOf (array 'ANNOUNCEMENT_STATE_UNSPECIFIED' 'PUBLISHED' 'DRAFT' 'DELETED')}}\",\n \"text\": \"\",\n \"updateTime\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e0b63bac-f027-410c-8860-b621a989ecfd", "documentation": "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.", "method": "post", "endpoint": "v1/courses/:courseId/announcements/:id:modifyAssignees", "responses": [ { "uuid": "5629eefa-2857-4ceb-8e30-f6c776de38ee", "body": "{\n \"alternateLink\": \"\",\n \"assigneeMode\": \"{{oneOf (array 'ASSIGNEE_MODE_UNSPECIFIED' 'ALL_STUDENTS' 'INDIVIDUAL_STUDENTS')}}\",\n \"courseId\": \"\",\n \"creationTime\": \"\",\n \"creatorUserId\": \"\",\n \"id\": \"\",\n \"individualStudentsOptions\": {\n \"studentIds\": [\n \"\"\n ]\n },\n \"materials\": [\n {\n \"driveFile\": {\n \"driveFile\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n },\n \"shareMode\": \"{{oneOf (array 'UNKNOWN_SHARE_MODE' 'VIEW' 'EDIT' 'STUDENT_COPY')}}\"\n },\n \"form\": {\n \"formUrl\": \"\",\n \"responseUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n },\n \"link\": {\n \"thumbnailUrl\": \"\",\n \"title\": \"\",\n \"url\": \"\"\n },\n \"youtubeVideo\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n }\n }\n ],\n \"scheduledTime\": \"\",\n \"state\": \"{{oneOf (array 'ANNOUNCEMENT_STATE_UNSPECIFIED' 'PUBLISHED' 'DRAFT' 'DELETED')}}\",\n \"text\": \"\",\n \"updateTime\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8a18a59a-21a2-4d6c-b994-2b9f985d5ab1", "documentation": "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.", "method": "get", "endpoint": "v1/courses/:courseId/courseWork", "responses": [ { "uuid": "fab9168b-f954-47dc-900d-c5bb374ad0ec", "body": "{\n \"courseWork\": [\n {\n \"alternateLink\": \"\",\n \"assigneeMode\": \"{{oneOf (array 'ASSIGNEE_MODE_UNSPECIFIED' 'ALL_STUDENTS' 'INDIVIDUAL_STUDENTS')}}\",\n \"assignment\": {\n \"studentWorkFolder\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"title\": \"\"\n }\n },\n \"associatedWithDeveloper\": {{faker 'datatype.boolean'}},\n \"courseId\": \"\",\n \"creationTime\": \"\",\n \"creatorUserId\": \"\",\n \"description\": \"\",\n \"dueDate\": {\n \"day\": {{faker 'number.int' max=99999}},\n \"month\": {{faker 'number.int' max=99999}},\n \"year\": {{faker 'number.int' max=99999}}\n },\n \"dueTime\": {\n \"hours\": {{faker 'number.int' max=99999}},\n \"minutes\": {{faker 'number.int' max=99999}},\n \"nanos\": {{faker 'number.int' max=99999}},\n \"seconds\": {{faker 'number.int' max=99999}}\n },\n \"gradeCategory\": {\n \"defaultGradeDenominator\": {{faker 'number.int' max=99999}},\n \"id\": \"\",\n \"name\": \"\",\n \"weight\": {{faker 'number.int' max=99999}}\n },\n \"id\": \"\",\n \"individualStudentsOptions\": {\n \"studentIds\": [\n \"\"\n ]\n },\n \"materials\": [\n {\n \"driveFile\": {\n \"driveFile\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n },\n \"shareMode\": \"{{oneOf (array 'UNKNOWN_SHARE_MODE' 'VIEW' 'EDIT' 'STUDENT_COPY')}}\"\n },\n \"form\": {\n \"formUrl\": \"\",\n \"responseUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n },\n \"link\": {\n \"thumbnailUrl\": \"\",\n \"title\": \"\",\n \"url\": \"\"\n },\n \"youtubeVideo\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n }\n }\n ],\n \"maxPoints\": {{faker 'number.float'}},\n \"multipleChoiceQuestion\": {\n \"choices\": [\n \"\"\n ]\n },\n \"scheduledTime\": \"\",\n \"state\": \"{{oneOf (array 'COURSE_WORK_STATE_UNSPECIFIED' 'PUBLISHED' 'DRAFT' 'DELETED')}}\",\n \"submissionModificationMode\": \"{{oneOf (array 'SUBMISSION_MODIFICATION_MODE_UNSPECIFIED' 'MODIFIABLE_UNTIL_TURNED_IN' 'MODIFIABLE')}}\",\n \"title\": \"\",\n \"topicId\": \"\",\n \"updateTime\": \"\",\n \"workType\": \"{{oneOf (array 'COURSE_WORK_TYPE_UNSPECIFIED' 'ASSIGNMENT' 'SHORT_ANSWER_QUESTION' 'MULTIPLE_CHOICE_QUESTION')}}\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7138acdc-3439-4b34-ab4a-4bc0877dc5c1", "documentation": "Creates course work. The resulting course work (and corresponding student submissions) are associated with the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) 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", "method": "post", "endpoint": "v1/courses/:courseId/courseWork", "responses": [ { "uuid": "9e7311ca-9aef-44e6-b07e-dda40eb01dc1", "body": "{\n \"alternateLink\": \"\",\n \"assigneeMode\": \"{{oneOf (array 'ASSIGNEE_MODE_UNSPECIFIED' 'ALL_STUDENTS' 'INDIVIDUAL_STUDENTS')}}\",\n \"assignment\": {\n \"studentWorkFolder\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"title\": \"\"\n }\n },\n \"associatedWithDeveloper\": {{faker 'datatype.boolean'}},\n \"courseId\": \"\",\n \"creationTime\": \"\",\n \"creatorUserId\": \"\",\n \"description\": \"\",\n \"dueDate\": {\n \"day\": {{faker 'number.int' max=99999}},\n \"month\": {{faker 'number.int' max=99999}},\n \"year\": {{faker 'number.int' max=99999}}\n },\n \"dueTime\": {\n \"hours\": {{faker 'number.int' max=99999}},\n \"minutes\": {{faker 'number.int' max=99999}},\n \"nanos\": {{faker 'number.int' max=99999}},\n \"seconds\": {{faker 'number.int' max=99999}}\n },\n \"gradeCategory\": {\n \"defaultGradeDenominator\": {{faker 'number.int' max=99999}},\n \"id\": \"\",\n \"name\": \"\",\n \"weight\": {{faker 'number.int' max=99999}}\n },\n \"id\": \"\",\n \"individualStudentsOptions\": {\n \"studentIds\": [\n \"\"\n ]\n },\n \"materials\": [\n {\n \"driveFile\": {\n \"driveFile\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n },\n \"shareMode\": \"{{oneOf (array 'UNKNOWN_SHARE_MODE' 'VIEW' 'EDIT' 'STUDENT_COPY')}}\"\n },\n \"form\": {\n \"formUrl\": \"\",\n \"responseUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n },\n \"link\": {\n \"thumbnailUrl\": \"\",\n \"title\": \"\",\n \"url\": \"\"\n },\n \"youtubeVideo\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n }\n }\n ],\n \"maxPoints\": {{faker 'number.float'}},\n \"multipleChoiceQuestion\": {\n \"choices\": [\n \"\"\n ]\n },\n \"scheduledTime\": \"\",\n \"state\": \"{{oneOf (array 'COURSE_WORK_STATE_UNSPECIFIED' 'PUBLISHED' 'DRAFT' 'DELETED')}}\",\n \"submissionModificationMode\": \"{{oneOf (array 'SUBMISSION_MODIFICATION_MODE_UNSPECIFIED' 'MODIFIABLE_UNTIL_TURNED_IN' 'MODIFIABLE')}}\",\n \"title\": \"\",\n \"topicId\": \"\",\n \"updateTime\": \"\",\n \"workType\": \"{{oneOf (array 'COURSE_WORK_TYPE_UNSPECIFIED' 'ASSIGNMENT' 'SHORT_ANSWER_QUESTION' 'MULTIPLE_CHOICE_QUESTION')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0c3bb12e-30e1-4beb-8351-70fff4546071", "documentation": "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.", "method": "get", "endpoint": "v1/courses/:courseId/courseWork/:courseWorkId/studentSubmissions", "responses": [ { "uuid": "a6e56c07-6054-40f6-92c3-25eea31f4b5b", "body": "{\n \"nextPageToken\": \"\",\n \"studentSubmissions\": [\n {\n \"alternateLink\": \"\",\n \"assignedGrade\": {{faker 'number.float'}},\n \"assignmentSubmission\": {\n \"attachments\": [\n {\n \"driveFile\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n },\n \"form\": {\n \"formUrl\": \"\",\n \"responseUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n },\n \"link\": {\n \"thumbnailUrl\": \"\",\n \"title\": \"\",\n \"url\": \"\"\n },\n \"youTubeVideo\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n }\n }\n ]\n },\n \"associatedWithDeveloper\": {{faker 'datatype.boolean'}},\n \"courseId\": \"\",\n \"courseWorkId\": \"\",\n \"courseWorkType\": \"{{oneOf (array 'COURSE_WORK_TYPE_UNSPECIFIED' 'ASSIGNMENT' 'SHORT_ANSWER_QUESTION' 'MULTIPLE_CHOICE_QUESTION')}}\",\n \"creationTime\": \"\",\n \"draftGrade\": {{faker 'number.float'}},\n \"id\": \"\",\n \"late\": {{faker 'datatype.boolean'}},\n \"multipleChoiceSubmission\": {\n \"answer\": \"\"\n },\n \"shortAnswerSubmission\": {\n \"answer\": \"\"\n },\n \"state\": \"{{oneOf (array 'SUBMISSION_STATE_UNSPECIFIED' 'NEW' 'CREATED' 'TURNED_IN' 'RETURNED' 'RECLAIMED_BY_STUDENT')}}\",\n \"submissionHistory\": [\n {\n \"gradeHistory\": {\n \"actorUserId\": \"\",\n \"gradeChangeType\": \"{{oneOf (array 'UNKNOWN_GRADE_CHANGE_TYPE' 'DRAFT_GRADE_POINTS_EARNED_CHANGE' 'ASSIGNED_GRADE_POINTS_EARNED_CHANGE' 'MAX_POINTS_CHANGE')}}\",\n \"gradeTimestamp\": \"\",\n \"maxPoints\": {{faker 'number.float'}},\n \"pointsEarned\": {{faker 'number.float'}}\n },\n \"stateHistory\": {\n \"actorUserId\": \"\",\n \"state\": \"{{oneOf (array 'STATE_UNSPECIFIED' 'CREATED' 'TURNED_IN' 'RETURNED' 'RECLAIMED_BY_STUDENT' 'STUDENT_EDITED_AFTER_TURN_IN')}}\",\n \"stateTimestamp\": \"\"\n }\n }\n ],\n \"updateTime\": \"\",\n \"userId\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c26c1533-2aa2-4179-af84-c2f6784db5b3", "documentation": "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.", "method": "get", "endpoint": "v1/courses/:courseId/courseWork/:courseWorkId/studentSubmissions/:id", "responses": [ { "uuid": "df374e96-8a59-4dab-b252-49353c108919", "body": "{\n \"alternateLink\": \"\",\n \"assignedGrade\": {{faker 'number.float'}},\n \"assignmentSubmission\": {\n \"attachments\": [\n {\n \"driveFile\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n },\n \"form\": {\n \"formUrl\": \"\",\n \"responseUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n },\n \"link\": {\n \"thumbnailUrl\": \"\",\n \"title\": \"\",\n \"url\": \"\"\n },\n \"youTubeVideo\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n }\n }\n ]\n },\n \"associatedWithDeveloper\": {{faker 'datatype.boolean'}},\n \"courseId\": \"\",\n \"courseWorkId\": \"\",\n \"courseWorkType\": \"{{oneOf (array 'COURSE_WORK_TYPE_UNSPECIFIED' 'ASSIGNMENT' 'SHORT_ANSWER_QUESTION' 'MULTIPLE_CHOICE_QUESTION')}}\",\n \"creationTime\": \"\",\n \"draftGrade\": {{faker 'number.float'}},\n \"id\": \"\",\n \"late\": {{faker 'datatype.boolean'}},\n \"multipleChoiceSubmission\": {\n \"answer\": \"\"\n },\n \"shortAnswerSubmission\": {\n \"answer\": \"\"\n },\n \"state\": \"{{oneOf (array 'SUBMISSION_STATE_UNSPECIFIED' 'NEW' 'CREATED' 'TURNED_IN' 'RETURNED' 'RECLAIMED_BY_STUDENT')}}\",\n \"submissionHistory\": [\n {\n \"gradeHistory\": {\n \"actorUserId\": \"\",\n \"gradeChangeType\": \"{{oneOf (array 'UNKNOWN_GRADE_CHANGE_TYPE' 'DRAFT_GRADE_POINTS_EARNED_CHANGE' 'ASSIGNED_GRADE_POINTS_EARNED_CHANGE' 'MAX_POINTS_CHANGE')}}\",\n \"gradeTimestamp\": \"\",\n \"maxPoints\": {{faker 'number.float'}},\n \"pointsEarned\": {{faker 'number.float'}}\n },\n \"stateHistory\": {\n \"actorUserId\": \"\",\n \"state\": \"{{oneOf (array 'STATE_UNSPECIFIED' 'CREATED' 'TURNED_IN' 'RETURNED' 'RECLAIMED_BY_STUDENT' 'STUDENT_EDITED_AFTER_TURN_IN')}}\",\n \"stateTimestamp\": \"\"\n }\n }\n ],\n \"updateTime\": \"\",\n \"userId\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1904381a-481c-4584-82b3-d9d56f8bc64c", "documentation": "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](https://support.google.com/cloud/answer/6158849) 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.", "method": "patch", "endpoint": "v1/courses/:courseId/courseWork/:courseWorkId/studentSubmissions/:id", "responses": [ { "uuid": "c1319598-70be-411c-9475-c70e0db336f4", "body": "{\n \"alternateLink\": \"\",\n \"assignedGrade\": {{faker 'number.float'}},\n \"assignmentSubmission\": {\n \"attachments\": [\n {\n \"driveFile\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n },\n \"form\": {\n \"formUrl\": \"\",\n \"responseUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n },\n \"link\": {\n \"thumbnailUrl\": \"\",\n \"title\": \"\",\n \"url\": \"\"\n },\n \"youTubeVideo\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n }\n }\n ]\n },\n \"associatedWithDeveloper\": {{faker 'datatype.boolean'}},\n \"courseId\": \"\",\n \"courseWorkId\": \"\",\n \"courseWorkType\": \"{{oneOf (array 'COURSE_WORK_TYPE_UNSPECIFIED' 'ASSIGNMENT' 'SHORT_ANSWER_QUESTION' 'MULTIPLE_CHOICE_QUESTION')}}\",\n \"creationTime\": \"\",\n \"draftGrade\": {{faker 'number.float'}},\n \"id\": \"\",\n \"late\": {{faker 'datatype.boolean'}},\n \"multipleChoiceSubmission\": {\n \"answer\": \"\"\n },\n \"shortAnswerSubmission\": {\n \"answer\": \"\"\n },\n \"state\": \"{{oneOf (array 'SUBMISSION_STATE_UNSPECIFIED' 'NEW' 'CREATED' 'TURNED_IN' 'RETURNED' 'RECLAIMED_BY_STUDENT')}}\",\n \"submissionHistory\": [\n {\n \"gradeHistory\": {\n \"actorUserId\": \"\",\n \"gradeChangeType\": \"{{oneOf (array 'UNKNOWN_GRADE_CHANGE_TYPE' 'DRAFT_GRADE_POINTS_EARNED_CHANGE' 'ASSIGNED_GRADE_POINTS_EARNED_CHANGE' 'MAX_POINTS_CHANGE')}}\",\n \"gradeTimestamp\": \"\",\n \"maxPoints\": {{faker 'number.float'}},\n \"pointsEarned\": {{faker 'number.float'}}\n },\n \"stateHistory\": {\n \"actorUserId\": \"\",\n \"state\": \"{{oneOf (array 'STATE_UNSPECIFIED' 'CREATED' 'TURNED_IN' 'RETURNED' 'RECLAIMED_BY_STUDENT' 'STUDENT_EDITED_AFTER_TURN_IN')}}\",\n \"stateTimestamp\": \"\"\n }\n }\n ],\n \"updateTime\": \"\",\n \"userId\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "65178f2b-7057-431e-aa62-6c2cfcb55ec4", "documentation": "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](https://support.google.com/cloud/answer/6158849) 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.", "method": "post", "endpoint": "v1/courses/:courseId/courseWork/:courseWorkId/studentSubmissions/:id:modifyAttachments", "responses": [ { "uuid": "333cad59-6f9c-4378-baef-ee4b080d6828", "body": "{\n \"alternateLink\": \"\",\n \"assignedGrade\": {{faker 'number.float'}},\n \"assignmentSubmission\": {\n \"attachments\": [\n {\n \"driveFile\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n },\n \"form\": {\n \"formUrl\": \"\",\n \"responseUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n },\n \"link\": {\n \"thumbnailUrl\": \"\",\n \"title\": \"\",\n \"url\": \"\"\n },\n \"youTubeVideo\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n }\n }\n ]\n },\n \"associatedWithDeveloper\": {{faker 'datatype.boolean'}},\n \"courseId\": \"\",\n \"courseWorkId\": \"\",\n \"courseWorkType\": \"{{oneOf (array 'COURSE_WORK_TYPE_UNSPECIFIED' 'ASSIGNMENT' 'SHORT_ANSWER_QUESTION' 'MULTIPLE_CHOICE_QUESTION')}}\",\n \"creationTime\": \"\",\n \"draftGrade\": {{faker 'number.float'}},\n \"id\": \"\",\n \"late\": {{faker 'datatype.boolean'}},\n \"multipleChoiceSubmission\": {\n \"answer\": \"\"\n },\n \"shortAnswerSubmission\": {\n \"answer\": \"\"\n },\n \"state\": \"{{oneOf (array 'SUBMISSION_STATE_UNSPECIFIED' 'NEW' 'CREATED' 'TURNED_IN' 'RETURNED' 'RECLAIMED_BY_STUDENT')}}\",\n \"submissionHistory\": [\n {\n \"gradeHistory\": {\n \"actorUserId\": \"\",\n \"gradeChangeType\": \"{{oneOf (array 'UNKNOWN_GRADE_CHANGE_TYPE' 'DRAFT_GRADE_POINTS_EARNED_CHANGE' 'ASSIGNED_GRADE_POINTS_EARNED_CHANGE' 'MAX_POINTS_CHANGE')}}\",\n \"gradeTimestamp\": \"\",\n \"maxPoints\": {{faker 'number.float'}},\n \"pointsEarned\": {{faker 'number.float'}}\n },\n \"stateHistory\": {\n \"actorUserId\": \"\",\n \"state\": \"{{oneOf (array 'STATE_UNSPECIFIED' 'CREATED' 'TURNED_IN' 'RETURNED' 'RECLAIMED_BY_STUDENT' 'STUDENT_EDITED_AFTER_TURN_IN')}}\",\n \"stateTimestamp\": \"\"\n }\n }\n ],\n \"updateTime\": \"\",\n \"userId\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e37b4bce-3f6f-4b63-9f60-c57b5987003a", "documentation": "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](https://support.google.com/cloud/answer/6158849) 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.", "method": "post", "endpoint": "v1/courses/:courseId/courseWork/:courseWorkId/studentSubmissions/:id:reclaim", "responses": [ { "uuid": "c71be231-d843-4c69-8b75-6ecaaf2dfef1", "body": "{}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "fa837f3a-1ac8-4e2f-88eb-6f2f034df1d3", "documentation": "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](https://support.google.com/cloud/answer/6158849) 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.", "method": "post", "endpoint": "v1/courses/:courseId/courseWork/:courseWorkId/studentSubmissions/:id:return", "responses": [ { "uuid": "e9af50e0-e920-4762-9a82-ca1da2804e89", "body": "{}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1d566b4e-0036-467b-83f0-df85b9bb0a56", "documentation": "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](https://support.google.com/cloud/answer/6158849) 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.", "method": "post", "endpoint": "v1/courses/:courseId/courseWork/:courseWorkId/studentSubmissions/:id:turnIn", "responses": [ { "uuid": "2d7576bb-59b3-4f02-84ba-06638ac5b766", "body": "{}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "985490bc-bdae-41fa-9f1b-05a647cfcdae", "documentation": "Deletes a course work. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) 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.", "method": "delete", "endpoint": "v1/courses/:courseId/courseWork/:id", "responses": [ { "uuid": "02942087-e989-4491-abc2-c675fafaf802", "body": "{}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "20ada2fe-14ff-47f3-a50d-cc3215b7824c", "documentation": "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.", "method": "get", "endpoint": "v1/courses/:courseId/courseWork/:id", "responses": [ { "uuid": "88442568-adb5-453c-8d8e-dedc4231ba76", "body": "{\n \"alternateLink\": \"\",\n \"assigneeMode\": \"{{oneOf (array 'ASSIGNEE_MODE_UNSPECIFIED' 'ALL_STUDENTS' 'INDIVIDUAL_STUDENTS')}}\",\n \"assignment\": {\n \"studentWorkFolder\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"title\": \"\"\n }\n },\n \"associatedWithDeveloper\": {{faker 'datatype.boolean'}},\n \"courseId\": \"\",\n \"creationTime\": \"\",\n \"creatorUserId\": \"\",\n \"description\": \"\",\n \"dueDate\": {\n \"day\": {{faker 'number.int' max=99999}},\n \"month\": {{faker 'number.int' max=99999}},\n \"year\": {{faker 'number.int' max=99999}}\n },\n \"dueTime\": {\n \"hours\": {{faker 'number.int' max=99999}},\n \"minutes\": {{faker 'number.int' max=99999}},\n \"nanos\": {{faker 'number.int' max=99999}},\n \"seconds\": {{faker 'number.int' max=99999}}\n },\n \"gradeCategory\": {\n \"defaultGradeDenominator\": {{faker 'number.int' max=99999}},\n \"id\": \"\",\n \"name\": \"\",\n \"weight\": {{faker 'number.int' max=99999}}\n },\n \"id\": \"\",\n \"individualStudentsOptions\": {\n \"studentIds\": [\n \"\"\n ]\n },\n \"materials\": [\n {\n \"driveFile\": {\n \"driveFile\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n },\n \"shareMode\": \"{{oneOf (array 'UNKNOWN_SHARE_MODE' 'VIEW' 'EDIT' 'STUDENT_COPY')}}\"\n },\n \"form\": {\n \"formUrl\": \"\",\n \"responseUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n },\n \"link\": {\n \"thumbnailUrl\": \"\",\n \"title\": \"\",\n \"url\": \"\"\n },\n \"youtubeVideo\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n }\n }\n ],\n \"maxPoints\": {{faker 'number.float'}},\n \"multipleChoiceQuestion\": {\n \"choices\": [\n \"\"\n ]\n },\n \"scheduledTime\": \"\",\n \"state\": \"{{oneOf (array 'COURSE_WORK_STATE_UNSPECIFIED' 'PUBLISHED' 'DRAFT' 'DELETED')}}\",\n \"submissionModificationMode\": \"{{oneOf (array 'SUBMISSION_MODIFICATION_MODE_UNSPECIFIED' 'MODIFIABLE_UNTIL_TURNED_IN' 'MODIFIABLE')}}\",\n \"title\": \"\",\n \"topicId\": \"\",\n \"updateTime\": \"\",\n \"workType\": \"{{oneOf (array 'COURSE_WORK_TYPE_UNSPECIFIED' 'ASSIGNMENT' 'SHORT_ANSWER_QUESTION' 'MULTIPLE_CHOICE_QUESTION')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "348b7968-0819-4289-acee-03199a1c1871", "documentation": "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](https://support.google.com/cloud/answer/6158849) 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.", "method": "patch", "endpoint": "v1/courses/:courseId/courseWork/:id", "responses": [ { "uuid": "2290bf12-dace-4e47-860b-a1fd5e90abf0", "body": "{\n \"alternateLink\": \"\",\n \"assigneeMode\": \"{{oneOf (array 'ASSIGNEE_MODE_UNSPECIFIED' 'ALL_STUDENTS' 'INDIVIDUAL_STUDENTS')}}\",\n \"assignment\": {\n \"studentWorkFolder\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"title\": \"\"\n }\n },\n \"associatedWithDeveloper\": {{faker 'datatype.boolean'}},\n \"courseId\": \"\",\n \"creationTime\": \"\",\n \"creatorUserId\": \"\",\n \"description\": \"\",\n \"dueDate\": {\n \"day\": {{faker 'number.int' max=99999}},\n \"month\": {{faker 'number.int' max=99999}},\n \"year\": {{faker 'number.int' max=99999}}\n },\n \"dueTime\": {\n \"hours\": {{faker 'number.int' max=99999}},\n \"minutes\": {{faker 'number.int' max=99999}},\n \"nanos\": {{faker 'number.int' max=99999}},\n \"seconds\": {{faker 'number.int' max=99999}}\n },\n \"gradeCategory\": {\n \"defaultGradeDenominator\": {{faker 'number.int' max=99999}},\n \"id\": \"\",\n \"name\": \"\",\n \"weight\": {{faker 'number.int' max=99999}}\n },\n \"id\": \"\",\n \"individualStudentsOptions\": {\n \"studentIds\": [\n \"\"\n ]\n },\n \"materials\": [\n {\n \"driveFile\": {\n \"driveFile\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n },\n \"shareMode\": \"{{oneOf (array 'UNKNOWN_SHARE_MODE' 'VIEW' 'EDIT' 'STUDENT_COPY')}}\"\n },\n \"form\": {\n \"formUrl\": \"\",\n \"responseUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n },\n \"link\": {\n \"thumbnailUrl\": \"\",\n \"title\": \"\",\n \"url\": \"\"\n },\n \"youtubeVideo\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n }\n }\n ],\n \"maxPoints\": {{faker 'number.float'}},\n \"multipleChoiceQuestion\": {\n \"choices\": [\n \"\"\n ]\n },\n \"scheduledTime\": \"\",\n \"state\": \"{{oneOf (array 'COURSE_WORK_STATE_UNSPECIFIED' 'PUBLISHED' 'DRAFT' 'DELETED')}}\",\n \"submissionModificationMode\": \"{{oneOf (array 'SUBMISSION_MODIFICATION_MODE_UNSPECIFIED' 'MODIFIABLE_UNTIL_TURNED_IN' 'MODIFIABLE')}}\",\n \"title\": \"\",\n \"topicId\": \"\",\n \"updateTime\": \"\",\n \"workType\": \"{{oneOf (array 'COURSE_WORK_TYPE_UNSPECIFIED' 'ASSIGNMENT' 'SHORT_ANSWER_QUESTION' 'MULTIPLE_CHOICE_QUESTION')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "471031fa-dc51-4add-863e-2796d6511dba", "documentation": "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.", "method": "post", "endpoint": "v1/courses/:courseId/courseWork/:id:modifyAssignees", "responses": [ { "uuid": "762664d6-1456-446d-b10b-75dff06cae32", "body": "{\n \"alternateLink\": \"\",\n \"assigneeMode\": \"{{oneOf (array 'ASSIGNEE_MODE_UNSPECIFIED' 'ALL_STUDENTS' 'INDIVIDUAL_STUDENTS')}}\",\n \"assignment\": {\n \"studentWorkFolder\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"title\": \"\"\n }\n },\n \"associatedWithDeveloper\": {{faker 'datatype.boolean'}},\n \"courseId\": \"\",\n \"creationTime\": \"\",\n \"creatorUserId\": \"\",\n \"description\": \"\",\n \"dueDate\": {\n \"day\": {{faker 'number.int' max=99999}},\n \"month\": {{faker 'number.int' max=99999}},\n \"year\": {{faker 'number.int' max=99999}}\n },\n \"dueTime\": {\n \"hours\": {{faker 'number.int' max=99999}},\n \"minutes\": {{faker 'number.int' max=99999}},\n \"nanos\": {{faker 'number.int' max=99999}},\n \"seconds\": {{faker 'number.int' max=99999}}\n },\n \"gradeCategory\": {\n \"defaultGradeDenominator\": {{faker 'number.int' max=99999}},\n \"id\": \"\",\n \"name\": \"\",\n \"weight\": {{faker 'number.int' max=99999}}\n },\n \"id\": \"\",\n \"individualStudentsOptions\": {\n \"studentIds\": [\n \"\"\n ]\n },\n \"materials\": [\n {\n \"driveFile\": {\n \"driveFile\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n },\n \"shareMode\": \"{{oneOf (array 'UNKNOWN_SHARE_MODE' 'VIEW' 'EDIT' 'STUDENT_COPY')}}\"\n },\n \"form\": {\n \"formUrl\": \"\",\n \"responseUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n },\n \"link\": {\n \"thumbnailUrl\": \"\",\n \"title\": \"\",\n \"url\": \"\"\n },\n \"youtubeVideo\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n }\n }\n ],\n \"maxPoints\": {{faker 'number.float'}},\n \"multipleChoiceQuestion\": {\n \"choices\": [\n \"\"\n ]\n },\n \"scheduledTime\": \"\",\n \"state\": \"{{oneOf (array 'COURSE_WORK_STATE_UNSPECIFIED' 'PUBLISHED' 'DRAFT' 'DELETED')}}\",\n \"submissionModificationMode\": \"{{oneOf (array 'SUBMISSION_MODIFICATION_MODE_UNSPECIFIED' 'MODIFIABLE_UNTIL_TURNED_IN' 'MODIFIABLE')}}\",\n \"title\": \"\",\n \"topicId\": \"\",\n \"updateTime\": \"\",\n \"workType\": \"{{oneOf (array 'COURSE_WORK_TYPE_UNSPECIFIED' 'ASSIGNMENT' 'SHORT_ANSWER_QUESTION' 'MULTIPLE_CHOICE_QUESTION')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f12621c2-ba7f-45a5-93bf-91a1d9046655", "documentation": "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.", "method": "get", "endpoint": "v1/courses/:courseId/courseWorkMaterials", "responses": [ { "uuid": "d3c454ea-088a-4c63-b7c1-a7dedee99765", "body": "{\n \"courseWorkMaterial\": [\n {\n \"alternateLink\": \"\",\n \"assigneeMode\": \"{{oneOf (array 'ASSIGNEE_MODE_UNSPECIFIED' 'ALL_STUDENTS' 'INDIVIDUAL_STUDENTS')}}\",\n \"courseId\": \"\",\n \"creationTime\": \"\",\n \"creatorUserId\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"individualStudentsOptions\": {\n \"studentIds\": [\n \"\"\n ]\n },\n \"materials\": [\n {\n \"driveFile\": {\n \"driveFile\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n },\n \"shareMode\": \"{{oneOf (array 'UNKNOWN_SHARE_MODE' 'VIEW' 'EDIT' 'STUDENT_COPY')}}\"\n },\n \"form\": {\n \"formUrl\": \"\",\n \"responseUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n },\n \"link\": {\n \"thumbnailUrl\": \"\",\n \"title\": \"\",\n \"url\": \"\"\n },\n \"youtubeVideo\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n }\n }\n ],\n \"scheduledTime\": \"\",\n \"state\": \"{{oneOf (array 'COURSEWORK_MATERIAL_STATE_UNSPECIFIED' 'PUBLISHED' 'DRAFT' 'DELETED')}}\",\n \"title\": \"\",\n \"topicId\": \"\",\n \"updateTime\": \"\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3420fb33-64e3-4e1e-b42e-7cdf4a574091", "documentation": "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", "method": "post", "endpoint": "v1/courses/:courseId/courseWorkMaterials", "responses": [ { "uuid": "d5723f8e-e6c3-48df-bb34-92f27511083e", "body": "{\n \"alternateLink\": \"\",\n \"assigneeMode\": \"{{oneOf (array 'ASSIGNEE_MODE_UNSPECIFIED' 'ALL_STUDENTS' 'INDIVIDUAL_STUDENTS')}}\",\n \"courseId\": \"\",\n \"creationTime\": \"\",\n \"creatorUserId\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"individualStudentsOptions\": {\n \"studentIds\": [\n \"\"\n ]\n },\n \"materials\": [\n {\n \"driveFile\": {\n \"driveFile\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n },\n \"shareMode\": \"{{oneOf (array 'UNKNOWN_SHARE_MODE' 'VIEW' 'EDIT' 'STUDENT_COPY')}}\"\n },\n \"form\": {\n \"formUrl\": \"\",\n \"responseUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n },\n \"link\": {\n \"thumbnailUrl\": \"\",\n \"title\": \"\",\n \"url\": \"\"\n },\n \"youtubeVideo\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n }\n }\n ],\n \"scheduledTime\": \"\",\n \"state\": \"{{oneOf (array 'COURSEWORK_MATERIAL_STATE_UNSPECIFIED' 'PUBLISHED' 'DRAFT' 'DELETED')}}\",\n \"title\": \"\",\n \"topicId\": \"\",\n \"updateTime\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "90133fe7-d72e-4a80-9b95-f42ce828b875", "documentation": "Deletes a course work material. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) 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.", "method": "delete", "endpoint": "v1/courses/:courseId/courseWorkMaterials/:id", "responses": [ { "uuid": "749d5173-45eb-4d39-9a79-e5441dbe88a8", "body": "{}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "55c4d1ce-f19e-48ab-9215-b355c930acb6", "documentation": "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.", "method": "get", "endpoint": "v1/courses/:courseId/courseWorkMaterials/:id", "responses": [ { "uuid": "29135d7b-b3ac-4ff2-86ca-a093bc7379d1", "body": "{\n \"alternateLink\": \"\",\n \"assigneeMode\": \"{{oneOf (array 'ASSIGNEE_MODE_UNSPECIFIED' 'ALL_STUDENTS' 'INDIVIDUAL_STUDENTS')}}\",\n \"courseId\": \"\",\n \"creationTime\": \"\",\n \"creatorUserId\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"individualStudentsOptions\": {\n \"studentIds\": [\n \"\"\n ]\n },\n \"materials\": [\n {\n \"driveFile\": {\n \"driveFile\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n },\n \"shareMode\": \"{{oneOf (array 'UNKNOWN_SHARE_MODE' 'VIEW' 'EDIT' 'STUDENT_COPY')}}\"\n },\n \"form\": {\n \"formUrl\": \"\",\n \"responseUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n },\n \"link\": {\n \"thumbnailUrl\": \"\",\n \"title\": \"\",\n \"url\": \"\"\n },\n \"youtubeVideo\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n }\n }\n ],\n \"scheduledTime\": \"\",\n \"state\": \"{{oneOf (array 'COURSEWORK_MATERIAL_STATE_UNSPECIFIED' 'PUBLISHED' 'DRAFT' 'DELETED')}}\",\n \"title\": \"\",\n \"topicId\": \"\",\n \"updateTime\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e76c6e0b-9c56-4d85-8e28-720151513f17", "documentation": "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", "method": "patch", "endpoint": "v1/courses/:courseId/courseWorkMaterials/:id", "responses": [ { "uuid": "3c903221-7267-41fd-af50-e766bd1385b2", "body": "{\n \"alternateLink\": \"\",\n \"assigneeMode\": \"{{oneOf (array 'ASSIGNEE_MODE_UNSPECIFIED' 'ALL_STUDENTS' 'INDIVIDUAL_STUDENTS')}}\",\n \"courseId\": \"\",\n \"creationTime\": \"\",\n \"creatorUserId\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"individualStudentsOptions\": {\n \"studentIds\": [\n \"\"\n ]\n },\n \"materials\": [\n {\n \"driveFile\": {\n \"driveFile\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n },\n \"shareMode\": \"{{oneOf (array 'UNKNOWN_SHARE_MODE' 'VIEW' 'EDIT' 'STUDENT_COPY')}}\"\n },\n \"form\": {\n \"formUrl\": \"\",\n \"responseUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n },\n \"link\": {\n \"thumbnailUrl\": \"\",\n \"title\": \"\",\n \"url\": \"\"\n },\n \"youtubeVideo\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n }\n }\n ],\n \"scheduledTime\": \"\",\n \"state\": \"{{oneOf (array 'COURSEWORK_MATERIAL_STATE_UNSPECIFIED' 'PUBLISHED' 'DRAFT' 'DELETED')}}\",\n \"title\": \"\",\n \"topicId\": \"\",\n \"updateTime\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a891d038-d8d5-4a7f-a7f0-2129055e1ff4", "documentation": "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.", "method": "get", "endpoint": "v1/courses/:courseId/students", "responses": [ { "uuid": "79ed8946-e76e-49cd-bf7b-dc349884f0d3", "body": "{\n \"nextPageToken\": \"\",\n \"students\": [\n {\n \"courseId\": \"\",\n \"profile\": {\n \"emailAddress\": \"\",\n \"id\": \"\",\n \"name\": {\n \"familyName\": \"\",\n \"fullName\": \"\",\n \"givenName\": \"\"\n },\n \"permissions\": [\n {\n \"permission\": \"{{oneOf (array 'PERMISSION_UNSPECIFIED' 'CREATE_COURSE')}}\"\n }\n ],\n \"photoUrl\": \"\",\n \"verifiedTeacher\": {{faker 'datatype.boolean'}}\n },\n \"studentWorkFolder\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"title\": \"\"\n },\n \"userId\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "eaf7f17e-2aed-4bba-8b56-b22d866b0a25", "documentation": "Adds a user as a student of a course. Domain administrators are permitted to [directly add](https://developers.google.com/classroom/guides/manage-users) users within their domain as students to courses within their domain. Students are permitted to add themselves to a course using an enrollment code. 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 * InactiveCourseOwner * `ALREADY_EXISTS` if the user is already a student or teacher in the course.", "method": "post", "endpoint": "v1/courses/:courseId/students", "responses": [ { "uuid": "7fc958c5-3fb0-4a17-afea-f5964b8791f2", "body": "{\n \"courseId\": \"\",\n \"profile\": {\n \"emailAddress\": \"\",\n \"id\": \"\",\n \"name\": {\n \"familyName\": \"\",\n \"fullName\": \"\",\n \"givenName\": \"\"\n },\n \"permissions\": [\n {\n \"permission\": \"{{oneOf (array 'PERMISSION_UNSPECIFIED' 'CREATE_COURSE')}}\"\n }\n ],\n \"photoUrl\": \"\",\n \"verifiedTeacher\": {{faker 'datatype.boolean'}}\n },\n \"studentWorkFolder\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"title\": \"\"\n },\n \"userId\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "86538ec7-f598-4102-b95e-b9c0dae3c956", "documentation": "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.", "method": "delete", "endpoint": "v1/courses/:courseId/students/:userId", "responses": [ { "uuid": "37f9fc08-1840-41c5-9d6c-8779e070c0a3", "body": "{}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4eef0c22-600f-4a6b-8215-14712f06145d", "documentation": "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.", "method": "get", "endpoint": "v1/courses/:courseId/students/:userId", "responses": [ { "uuid": "04710348-a058-4d1f-804c-c2dcef9d97bb", "body": "{\n \"courseId\": \"\",\n \"profile\": {\n \"emailAddress\": \"\",\n \"id\": \"\",\n \"name\": {\n \"familyName\": \"\",\n \"fullName\": \"\",\n \"givenName\": \"\"\n },\n \"permissions\": [\n {\n \"permission\": \"{{oneOf (array 'PERMISSION_UNSPECIFIED' 'CREATE_COURSE')}}\"\n }\n ],\n \"photoUrl\": \"\",\n \"verifiedTeacher\": {{faker 'datatype.boolean'}}\n },\n \"studentWorkFolder\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"title\": \"\"\n },\n \"userId\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "bbe9a5c9-6dec-4e13-9457-2cddf10eaf03", "documentation": "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.", "method": "get", "endpoint": "v1/courses/:courseId/teachers", "responses": [ { "uuid": "fc156573-5141-4fdb-8363-1b7c435dd64f", "body": "{\n \"nextPageToken\": \"\",\n \"teachers\": [\n {\n \"courseId\": \"\",\n \"profile\": {\n \"emailAddress\": \"\",\n \"id\": \"\",\n \"name\": {\n \"familyName\": \"\",\n \"fullName\": \"\",\n \"givenName\": \"\"\n },\n \"permissions\": [\n {\n \"permission\": \"{{oneOf (array 'PERMISSION_UNSPECIFIED' 'CREATE_COURSE')}}\"\n }\n ],\n \"photoUrl\": \"\",\n \"verifiedTeacher\": {{faker 'datatype.boolean'}}\n },\n \"userId\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3e1bb432-db99-458c-b4d2-847c3ea6bed4", "documentation": "Creates a teacher of a course. Domain administrators are permitted to [directly add](https://developers.google.com/classroom/guides/manage-users) users within their domain as teachers to courses within their domain. Non-admin users should send an Invitation instead. 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 * InactiveCourseOwner * `ALREADY_EXISTS` if the user is already a teacher or student in the course.", "method": "post", "endpoint": "v1/courses/:courseId/teachers", "responses": [ { "uuid": "b5e85c39-f1e1-4cf7-a413-87fa4b3220e2", "body": "{\n \"courseId\": \"\",\n \"profile\": {\n \"emailAddress\": \"\",\n \"id\": \"\",\n \"name\": {\n \"familyName\": \"\",\n \"fullName\": \"\",\n \"givenName\": \"\"\n },\n \"permissions\": [\n {\n \"permission\": \"{{oneOf (array 'PERMISSION_UNSPECIFIED' 'CREATE_COURSE')}}\"\n }\n ],\n \"photoUrl\": \"\",\n \"verifiedTeacher\": {{faker 'datatype.boolean'}}\n },\n \"userId\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d92b35b6-a4ec-4785-99ad-09e41b7335ef", "documentation": "Removes the specified teacher from the specified 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. * `FAILED_PRECONDITION` if the requested ID belongs to the owner of the course Drive folder. * `FAILED_PRECONDITION` if the course no longer has an active owner.", "method": "delete", "endpoint": "v1/courses/:courseId/teachers/:userId", "responses": [ { "uuid": "63ef8c92-a84a-4536-afd2-b0a634f9d2b3", "body": "{}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "af4a9884-5fcd-4d5d-baef-10f189fb7752", "documentation": "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.", "method": "get", "endpoint": "v1/courses/:courseId/teachers/:userId", "responses": [ { "uuid": "96aff52e-2742-43b3-b19d-1ec99995e45d", "body": "{\n \"courseId\": \"\",\n \"profile\": {\n \"emailAddress\": \"\",\n \"id\": \"\",\n \"name\": {\n \"familyName\": \"\",\n \"fullName\": \"\",\n \"givenName\": \"\"\n },\n \"permissions\": [\n {\n \"permission\": \"{{oneOf (array 'PERMISSION_UNSPECIFIED' 'CREATE_COURSE')}}\"\n }\n ],\n \"photoUrl\": \"\",\n \"verifiedTeacher\": {{faker 'datatype.boolean'}}\n },\n \"userId\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5211d4f0-d003-470a-82a1-8812ea9184d9", "documentation": "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.", "method": "get", "endpoint": "v1/courses/:courseId/topics", "responses": [ { "uuid": "0e67323c-5dd3-4527-bfff-377e0fc21878", "body": "{\n \"nextPageToken\": \"\",\n \"topic\": [\n {\n \"courseId\": \"\",\n \"name\": \"\",\n \"topicId\": \"\",\n \"updateTime\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "847e5400-ad0a-492e-b6b7-60bc55abc53e", "documentation": "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.", "method": "post", "endpoint": "v1/courses/:courseId/topics", "responses": [ { "uuid": "04bff71f-0219-4f32-98fa-bbf11936d837", "body": "{\n \"courseId\": \"\",\n \"name\": \"\",\n \"topicId\": \"\",\n \"updateTime\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9b1b43b0-51f9-494c-b234-a9332a11e1f2", "documentation": "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.", "method": "delete", "endpoint": "v1/courses/:courseId/topics/:id", "responses": [ { "uuid": "4271a4e7-4912-455c-8a2c-46bf8d9cff9b", "body": "{}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ed7e4fad-8997-4f0d-aa30-1dcea4ef6040", "documentation": "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.", "method": "get", "endpoint": "v1/courses/:courseId/topics/:id", "responses": [ { "uuid": "b53ca501-a692-46f9-ad9e-e894d770cbad", "body": "{\n \"courseId\": \"\",\n \"name\": \"\",\n \"topicId\": \"\",\n \"updateTime\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "10d4566c-fa5a-4e1c-8071-89a8ead285b1", "documentation": "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", "method": "patch", "endpoint": "v1/courses/:courseId/topics/:id", "responses": [ { "uuid": "24b4d5d9-d9d4-4bea-a75f-924a0ff9b212", "body": "{\n \"courseId\": \"\",\n \"name\": \"\",\n \"topicId\": \"\",\n \"updateTime\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6a8cd050-e5ae-48e6-b464-ce552b264a6e", "documentation": "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.", "method": "delete", "endpoint": "v1/courses/:id", "responses": [ { "uuid": "498d706d-374e-448c-b9b3-1ec985526153", "body": "{}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ef8054ec-663b-4099-b333-9ceaaccbc71e", "documentation": "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.", "method": "get", "endpoint": "v1/courses/:id", "responses": [ { "uuid": "f06a905e-a465-4e1b-883e-4dcb3ee3cece", "body": "{\n \"alternateLink\": \"\",\n \"calendarId\": \"\",\n \"courseGroupEmail\": \"\",\n \"courseMaterialSets\": [\n {\n \"materials\": [\n {\n \"driveFile\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n },\n \"form\": {\n \"formUrl\": \"\",\n \"responseUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n },\n \"link\": {\n \"thumbnailUrl\": \"\",\n \"title\": \"\",\n \"url\": \"\"\n },\n \"youTubeVideo\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n }\n }\n ],\n \"title\": \"\"\n }\n ],\n \"courseState\": \"{{oneOf (array 'COURSE_STATE_UNSPECIFIED' 'ACTIVE' 'ARCHIVED' 'PROVISIONED' 'DECLINED' 'SUSPENDED')}}\",\n \"creationTime\": \"\",\n \"description\": \"\",\n \"descriptionHeading\": \"\",\n \"enrollmentCode\": \"\",\n \"gradebookSettings\": {\n \"calculationType\": \"{{oneOf (array 'CALCULATION_TYPE_UNSPECIFIED' 'TOTAL_POINTS' 'WEIGHTED_CATEGORIES')}}\",\n \"displaySetting\": \"{{oneOf (array 'DISPLAY_SETTING_UNSPECIFIED' 'SHOW_OVERALL_GRADE' 'HIDE_OVERALL_GRADE' 'SHOW_TEACHERS_ONLY')}}\",\n \"gradeCategories\": [\n {\n \"defaultGradeDenominator\": {{faker 'number.int' max=99999}},\n \"id\": \"\",\n \"name\": \"\",\n \"weight\": {{faker 'number.int' max=99999}}\n }\n ]\n },\n \"guardiansEnabled\": {{faker 'datatype.boolean'}},\n \"id\": \"\",\n \"name\": \"\",\n \"ownerId\": \"\",\n \"room\": \"\",\n \"section\": \"\",\n \"teacherFolder\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"title\": \"\"\n },\n \"teacherGroupEmail\": \"\",\n \"updateTime\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ead174a2-f603-4d8a-baa8-302ee2bdaa5d", "documentation": "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 * InactiveCourseOwner", "method": "patch", "endpoint": "v1/courses/:id", "responses": [ { "uuid": "e5c71072-3191-4f08-b5b9-71afb3e1fb54", "body": "{\n \"alternateLink\": \"\",\n \"calendarId\": \"\",\n \"courseGroupEmail\": \"\",\n \"courseMaterialSets\": [\n {\n \"materials\": [\n {\n \"driveFile\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n },\n \"form\": {\n \"formUrl\": \"\",\n \"responseUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n },\n \"link\": {\n \"thumbnailUrl\": \"\",\n \"title\": \"\",\n \"url\": \"\"\n },\n \"youTubeVideo\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n }\n }\n ],\n \"title\": \"\"\n }\n ],\n \"courseState\": \"{{oneOf (array 'COURSE_STATE_UNSPECIFIED' 'ACTIVE' 'ARCHIVED' 'PROVISIONED' 'DECLINED' 'SUSPENDED')}}\",\n \"creationTime\": \"\",\n \"description\": \"\",\n \"descriptionHeading\": \"\",\n \"enrollmentCode\": \"\",\n \"gradebookSettings\": {\n \"calculationType\": \"{{oneOf (array 'CALCULATION_TYPE_UNSPECIFIED' 'TOTAL_POINTS' 'WEIGHTED_CATEGORIES')}}\",\n \"displaySetting\": \"{{oneOf (array 'DISPLAY_SETTING_UNSPECIFIED' 'SHOW_OVERALL_GRADE' 'HIDE_OVERALL_GRADE' 'SHOW_TEACHERS_ONLY')}}\",\n \"gradeCategories\": [\n {\n \"defaultGradeDenominator\": {{faker 'number.int' max=99999}},\n \"id\": \"\",\n \"name\": \"\",\n \"weight\": {{faker 'number.int' max=99999}}\n }\n ]\n },\n \"guardiansEnabled\": {{faker 'datatype.boolean'}},\n \"id\": \"\",\n \"name\": \"\",\n \"ownerId\": \"\",\n \"room\": \"\",\n \"section\": \"\",\n \"teacherFolder\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"title\": \"\"\n },\n \"teacherGroupEmail\": \"\",\n \"updateTime\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4277ac66-b5cb-4638-a1b6-3e0b22cbe568", "documentation": "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", "method": "put", "endpoint": "v1/courses/:id", "responses": [ { "uuid": "baddd252-8ea1-48e3-9cd6-e7663eda1658", "body": "{\n \"alternateLink\": \"\",\n \"calendarId\": \"\",\n \"courseGroupEmail\": \"\",\n \"courseMaterialSets\": [\n {\n \"materials\": [\n {\n \"driveFile\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n },\n \"form\": {\n \"formUrl\": \"\",\n \"responseUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n },\n \"link\": {\n \"thumbnailUrl\": \"\",\n \"title\": \"\",\n \"url\": \"\"\n },\n \"youTubeVideo\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"thumbnailUrl\": \"\",\n \"title\": \"\"\n }\n }\n ],\n \"title\": \"\"\n }\n ],\n \"courseState\": \"{{oneOf (array 'COURSE_STATE_UNSPECIFIED' 'ACTIVE' 'ARCHIVED' 'PROVISIONED' 'DECLINED' 'SUSPENDED')}}\",\n \"creationTime\": \"\",\n \"description\": \"\",\n \"descriptionHeading\": \"\",\n \"enrollmentCode\": \"\",\n \"gradebookSettings\": {\n \"calculationType\": \"{{oneOf (array 'CALCULATION_TYPE_UNSPECIFIED' 'TOTAL_POINTS' 'WEIGHTED_CATEGORIES')}}\",\n \"displaySetting\": \"{{oneOf (array 'DISPLAY_SETTING_UNSPECIFIED' 'SHOW_OVERALL_GRADE' 'HIDE_OVERALL_GRADE' 'SHOW_TEACHERS_ONLY')}}\",\n \"gradeCategories\": [\n {\n \"defaultGradeDenominator\": {{faker 'number.int' max=99999}},\n \"id\": \"\",\n \"name\": \"\",\n \"weight\": {{faker 'number.int' max=99999}}\n }\n ]\n },\n \"guardiansEnabled\": {{faker 'datatype.boolean'}},\n \"id\": \"\",\n \"name\": \"\",\n \"ownerId\": \"\",\n \"room\": \"\",\n \"section\": \"\",\n \"teacherFolder\": {\n \"alternateLink\": \"\",\n \"id\": \"\",\n \"title\": \"\"\n },\n \"teacherGroupEmail\": \"\",\n \"updateTime\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1fb31a87-f54e-4897-958e-4811675124dc", "documentation": "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.", "method": "get", "endpoint": "v1/invitations", "responses": [ { "uuid": "28053749-7b3e-4f13-901e-3914aee27a69", "body": "{\n \"invitations\": [\n {\n \"courseId\": \"\",\n \"id\": \"\",\n \"role\": \"{{oneOf (array 'COURSE_ROLE_UNSPECIFIED' 'STUDENT' 'TEACHER' 'OWNER')}}\",\n \"userId\": \"\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d950cbf1-c4d2-4043-b306-482ffba281fa", "documentation": "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.", "method": "post", "endpoint": "v1/invitations", "responses": [ { "uuid": "1df6d459-758b-496b-bf81-890fccbc3c1d", "body": "{\n \"courseId\": \"\",\n \"id\": \"\",\n \"role\": \"{{oneOf (array 'COURSE_ROLE_UNSPECIFIED' 'STUDENT' 'TEACHER' 'OWNER')}}\",\n \"userId\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "47da757e-073b-4085-a13f-521c2c58a0eb", "documentation": "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.", "method": "delete", "endpoint": "v1/invitations/:id", "responses": [ { "uuid": "7dad043f-7659-4fc1-b4ab-46d4f5b0ea10", "body": "{}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0d0a4e8c-7bc6-4347-b5bb-d03528f8942d", "documentation": "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.", "method": "get", "endpoint": "v1/invitations/:id", "responses": [ { "uuid": "9e9d6aff-9349-4f4b-b64a-294af0abf254", "body": "{\n \"courseId\": \"\",\n \"id\": \"\",\n \"role\": \"{{oneOf (array 'COURSE_ROLE_UNSPECIFIED' 'STUDENT' 'TEACHER' 'OWNER')}}\",\n \"userId\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "bbfa8546-9082-4a91-9015-23005750b33b", "documentation": "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.", "method": "post", "endpoint": "v1/invitations/:id:accept", "responses": [ { "uuid": "0287fa8b-440d-4f3e-86e4-91496576288d", "body": "{}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "01105aca-34dd-4ffa-871c-b099b7e0dba0", "documentation": "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.", "method": "post", "endpoint": "v1/registrations", "responses": [ { "uuid": "524f8da7-34df-4609-bcf9-88c7c8e33cb8", "body": "{\n \"cloudPubsubTopic\": {\n \"topicName\": \"\"\n },\n \"expiryTime\": \"\",\n \"feed\": {\n \"courseRosterChangesInfo\": {\n \"courseId\": \"\"\n },\n \"courseWorkChangesInfo\": {\n \"courseId\": \"\"\n },\n \"feedType\": \"{{oneOf (array 'FEED_TYPE_UNSPECIFIED' 'DOMAIN_ROSTER_CHANGES' 'COURSE_ROSTER_CHANGES' 'COURSE_WORK_CHANGES')}}\"\n },\n \"registrationId\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1826e8ac-9289-4da6-95fc-c86033d2f7b7", "documentation": "Deletes a `Registration`, causing Classroom to stop sending notifications for that `Registration`.", "method": "delete", "endpoint": "v1/registrations/:registrationId", "responses": [ { "uuid": "f084b45f-6a34-40c4-9f97-d24535f165b7", "body": "{}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "961aea81-9465-4f9c-9c7f-e14d9e8bbdcd", "documentation": "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.", "method": "get", "endpoint": "v1/userProfiles/:studentId/guardianInvitations", "responses": [ { "uuid": "8e10b754-c7d0-4d8d-8659-5368210cf75c", "body": "{\n \"guardianInvitations\": [\n {\n \"creationTime\": \"\",\n \"invitationId\": \"\",\n \"invitedEmailAddress\": \"\",\n \"state\": \"{{oneOf (array 'GUARDIAN_INVITATION_STATE_UNSPECIFIED' 'PENDING' 'COMPLETE')}}\",\n \"studentId\": \"\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "35aec5a8-e8ec-4c5b-859d-7291dfbf9925", "documentation": "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.", "method": "post", "endpoint": "v1/userProfiles/:studentId/guardianInvitations", "responses": [ { "uuid": "27c840cb-d7f2-4395-85ac-02aa2fa6f1f9", "body": "{\n \"creationTime\": \"\",\n \"invitationId\": \"\",\n \"invitedEmailAddress\": \"\",\n \"state\": \"{{oneOf (array 'GUARDIAN_INVITATION_STATE_UNSPECIFIED' 'PENDING' 'COMPLETE')}}\",\n \"studentId\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "cf9ce395-8189-437e-af52-b54201bf9165", "documentation": "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.", "method": "get", "endpoint": "v1/userProfiles/:studentId/guardianInvitations/:invitationId", "responses": [ { "uuid": "d8d949eb-924e-451e-91cd-af379b9dcc73", "body": "{\n \"creationTime\": \"\",\n \"invitationId\": \"\",\n \"invitedEmailAddress\": \"\",\n \"state\": \"{{oneOf (array 'GUARDIAN_INVITATION_STATE_UNSPECIFIED' 'PENDING' 'COMPLETE')}}\",\n \"studentId\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ef5798e8-9803-44de-a56b-0c4ba12a7e78", "documentation": "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.", "method": "patch", "endpoint": "v1/userProfiles/:studentId/guardianInvitations/:invitationId", "responses": [ { "uuid": "ada62ae7-2711-478a-8709-18f5b4f08279", "body": "{\n \"creationTime\": \"\",\n \"invitationId\": \"\",\n \"invitedEmailAddress\": \"\",\n \"state\": \"{{oneOf (array 'GUARDIAN_INVITATION_STATE_UNSPECIFIED' 'PENDING' 'COMPLETE')}}\",\n \"studentId\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f873b785-a034-4ef4-9713-42fde09722d3", "documentation": "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.", "method": "get", "endpoint": "v1/userProfiles/:studentId/guardians", "responses": [ { "uuid": "3a32f5b2-766f-455d-a470-f17edb4eeb30", "body": "{\n \"guardians\": [\n {\n \"guardianId\": \"\",\n \"guardianProfile\": {\n \"emailAddress\": \"\",\n \"id\": \"\",\n \"name\": {\n \"familyName\": \"\",\n \"fullName\": \"\",\n \"givenName\": \"\"\n },\n \"permissions\": [\n {\n \"permission\": \"{{oneOf (array 'PERMISSION_UNSPECIFIED' 'CREATE_COURSE')}}\"\n }\n ],\n \"photoUrl\": \"\",\n \"verifiedTeacher\": {{faker 'datatype.boolean'}}\n },\n \"invitedEmailAddress\": \"\",\n \"studentId\": \"\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "74090d61-75f4-44cf-8ffa-014d19ce1ff2", "documentation": "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`.", "method": "delete", "endpoint": "v1/userProfiles/:studentId/guardians/:guardianId", "responses": [ { "uuid": "bb5b795a-c5b2-4ea6-8bb1-96823c638a1f", "body": "{}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d5130a54-14b8-462a-b021-cc37b6c15f43", "documentation": "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`.", "method": "get", "endpoint": "v1/userProfiles/:studentId/guardians/:guardianId", "responses": [ { "uuid": "81ea376e-2661-4973-9756-614745aa4de8", "body": "{\n \"guardianId\": \"\",\n \"guardianProfile\": {\n \"emailAddress\": \"\",\n \"id\": \"\",\n \"name\": {\n \"familyName\": \"\",\n \"fullName\": \"\",\n \"givenName\": \"\"\n },\n \"permissions\": [\n {\n \"permission\": \"{{oneOf (array 'PERMISSION_UNSPECIFIED' 'CREATE_COURSE')}}\"\n }\n ],\n \"photoUrl\": \"\",\n \"verifiedTeacher\": {{faker 'datatype.boolean'}}\n },\n \"invitedEmailAddress\": \"\",\n \"studentId\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ecce8bcd-04dc-4898-ab43-c6c2f8db5146", "documentation": "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.", "method": "get", "endpoint": "v1/userProfiles/:userId", "responses": [ { "uuid": "8a8dac88-ff09-4ca2-8b1a-271a9eeb13f4", "body": "{\n \"emailAddress\": \"\",\n \"id\": \"\",\n \"name\": {\n \"familyName\": \"\",\n \"fullName\": \"\",\n \"givenName\": \"\"\n },\n \"permissions\": [\n {\n \"permission\": \"{{oneOf (array 'PERMISSION_UNSPECIFIED' 'CREATE_COURSE')}}\"\n }\n ],\n \"photoUrl\": \"\",\n \"verifiedTeacher\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "c13b4201-265b-4c47-85b1-b9ddec67890e" }, { "type": "route", "uuid": "df1fe726-c4c6-4c41-8b00-5e4084e4694c" }, { "type": "route", "uuid": "e502aa39-99a8-44ca-8817-bb4b361aa9a7" }, { "type": "route", "uuid": "18b3ae2b-943f-421f-8146-9eb2b4818c97" }, { "type": "route", "uuid": "90457008-d532-42df-82a5-519983ecd28f" }, { "type": "route", "uuid": "5ef0f49b-a9b1-4cff-afa2-dbe65c779221" }, { "type": "route", "uuid": "eef93f05-f79d-4be2-957a-7c6557b4ae0f" }, { "type": "route", "uuid": "7d8d5d82-ea2a-41d0-962f-258bc663a4b7" }, { "type": "route", "uuid": "577eb31e-2fa9-41eb-9ca5-933174590e1c" }, { "type": "route", "uuid": "d532f637-f250-4462-a023-57238ab32e0c" }, { "type": "route", "uuid": "e0b63bac-f027-410c-8860-b621a989ecfd" }, { "type": "route", "uuid": "8a18a59a-21a2-4d6c-b994-2b9f985d5ab1" }, { "type": "route", "uuid": "7138acdc-3439-4b34-ab4a-4bc0877dc5c1" }, { "type": "route", "uuid": "0c3bb12e-30e1-4beb-8351-70fff4546071" }, { "type": "route", "uuid": "c26c1533-2aa2-4179-af84-c2f6784db5b3" }, { "type": "route", "uuid": "1904381a-481c-4584-82b3-d9d56f8bc64c" }, { "type": "route", "uuid": "65178f2b-7057-431e-aa62-6c2cfcb55ec4" }, { "type": "route", "uuid": "e37b4bce-3f6f-4b63-9f60-c57b5987003a" }, { "type": "route", "uuid": "fa837f3a-1ac8-4e2f-88eb-6f2f034df1d3" }, { "type": "route", "uuid": "1d566b4e-0036-467b-83f0-df85b9bb0a56" }, { "type": "route", "uuid": "985490bc-bdae-41fa-9f1b-05a647cfcdae" }, { "type": "route", "uuid": "20ada2fe-14ff-47f3-a50d-cc3215b7824c" }, { "type": "route", "uuid": "348b7968-0819-4289-acee-03199a1c1871" }, { "type": "route", "uuid": "471031fa-dc51-4add-863e-2796d6511dba" }, { "type": "route", "uuid": "f12621c2-ba7f-45a5-93bf-91a1d9046655" }, { "type": "route", "uuid": "3420fb33-64e3-4e1e-b42e-7cdf4a574091" }, { "type": "route", "uuid": "90133fe7-d72e-4a80-9b95-f42ce828b875" }, { "type": "route", "uuid": "55c4d1ce-f19e-48ab-9215-b355c930acb6" }, { "type": "route", "uuid": "e76c6e0b-9c56-4d85-8e28-720151513f17" }, { "type": "route", "uuid": "a891d038-d8d5-4a7f-a7f0-2129055e1ff4" }, { "type": "route", "uuid": "eaf7f17e-2aed-4bba-8b56-b22d866b0a25" }, { "type": "route", "uuid": "86538ec7-f598-4102-b95e-b9c0dae3c956" }, { "type": "route", "uuid": "4eef0c22-600f-4a6b-8215-14712f06145d" }, { "type": "route", "uuid": "bbe9a5c9-6dec-4e13-9457-2cddf10eaf03" }, { "type": "route", "uuid": "3e1bb432-db99-458c-b4d2-847c3ea6bed4" }, { "type": "route", "uuid": "d92b35b6-a4ec-4785-99ad-09e41b7335ef" }, { "type": "route", "uuid": "af4a9884-5fcd-4d5d-baef-10f189fb7752" }, { "type": "route", "uuid": "5211d4f0-d003-470a-82a1-8812ea9184d9" }, { "type": "route", "uuid": "847e5400-ad0a-492e-b6b7-60bc55abc53e" }, { "type": "route", "uuid": "9b1b43b0-51f9-494c-b234-a9332a11e1f2" }, { "type": "route", "uuid": "ed7e4fad-8997-4f0d-aa30-1dcea4ef6040" }, { "type": "route", "uuid": "10d4566c-fa5a-4e1c-8071-89a8ead285b1" }, { "type": "route", "uuid": "6a8cd050-e5ae-48e6-b464-ce552b264a6e" }, { "type": "route", "uuid": "ef8054ec-663b-4099-b333-9ceaaccbc71e" }, { "type": "route", "uuid": "ead174a2-f603-4d8a-baa8-302ee2bdaa5d" }, { "type": "route", "uuid": "4277ac66-b5cb-4638-a1b6-3e0b22cbe568" }, { "type": "route", "uuid": "1fb31a87-f54e-4897-958e-4811675124dc" }, { "type": "route", "uuid": "d950cbf1-c4d2-4043-b306-482ffba281fa" }, { "type": "route", "uuid": "47da757e-073b-4085-a13f-521c2c58a0eb" }, { "type": "route", "uuid": "0d0a4e8c-7bc6-4347-b5bb-d03528f8942d" }, { "type": "route", "uuid": "bbfa8546-9082-4a91-9015-23005750b33b" }, { "type": "route", "uuid": "01105aca-34dd-4ffa-871c-b099b7e0dba0" }, { "type": "route", "uuid": "1826e8ac-9289-4da6-95fc-c86033d2f7b7" }, { "type": "route", "uuid": "961aea81-9465-4f9c-9c7f-e14d9e8bbdcd" }, { "type": "route", "uuid": "35aec5a8-e8ec-4c5b-859d-7291dfbf9925" }, { "type": "route", "uuid": "cf9ce395-8189-437e-af52-b54201bf9165" }, { "type": "route", "uuid": "ef5798e8-9803-44de-a56b-0c4ba12a7e78" }, { "type": "route", "uuid": "f873b785-a034-4ef4-9713-42fde09722d3" }, { "type": "route", "uuid": "74090d61-75f4-44cf-8ffa-014d19ce1ff2" }, { "type": "route", "uuid": "d5130a54-14b8-462a-b021-cc37b6c15f43" }, { "type": "route", "uuid": "ecce8bcd-04dc-4898-ab43-c6c2f8db5146" } ] }