Api-roll 42: 2016-11-08

discovery/googleapis/classroom__v1.json

 {
     "auth": {
         "oauth2": {
             "scopes": {
                 "https://www.googleapis.com/auth/classroom.course-work.readonly": {
                     "description": "View instructions for teacher-assigned work in your Google Classroom classes"
                 },
                 "https://www.googleapis.com/auth/classroom.courses": {
                     "description": "Manage your Google Classroom classes"
                 },
@@ skipping 32 matching lines @@
                 }
             }
         }
     },
     "basePath": "",
     "baseUrl": "https://classroom.googleapis.com/",
     "batchPath": "batch",
     "description": "Manages classes, rosters, and invitations in Google Classroom.",
     "discoveryVersion": "v1",
     "documentationLink": "https://developers.google.com/classroom/",
-    "etag": "\"C5oy1hgQsABtYOYIOXWcR3BgYqU/YsDe4FXJlhWXueJei0_RXQqm_4I\"",
+    "etag": "\"C5oy1hgQsABtYOYIOXWcR3BgYqU/mk_oLjlaBwJ1BcBJ5yykCFb6u3w\"",
     "icons": {
         "x16": "http://www.google.com/images/icons/product/search-16.gif",
         "x32": "http://www.google.com/images/icons/product/search-32.gif"
     },
     "id": "classroom:v1",
     "kind": "discovery#restDescription",
     "name": "classroom",
     "ownerDomain": "google.com",
     "ownerName": "Google",
     "parameters": {
@@ skipping 206 matching lines @@
                         "studentId": {
                             "description": "Restricts returned courses to those having a student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
                             "location": "query",
                             "type": "string"
                         },
                         "teacherId": {
                             "description": "Restricts returned courses to those having a teacher with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
                             "location": "query",
                             "type": "string"
                         },
+                        "courseStates": {
+                            "description": "Restricts returned courses to those in one of the specified states",
+                            "enum": [
+                                "COURSE_STATE_UNSPECIFIED",
+                                "ACTIVE",
+                                "ARCHIVED",
+                                "PROVISIONED",
+                                "DECLINED"
+                            ],
+                            "location": "query",
+                            "repeated": true,
+                            "type": "string"
+                        },
                         "pageSize": {
                             "description": "Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.",
                             "format": "int32",
                             "location": "query",
                             "type": "integer"
                         },
                         "pageToken": {
                             "description": "nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.",
                             "location": "query",
                             "type": "string"
@@ skipping 851 matching lines @@
                         "https://www.googleapis.com/auth/classroom.profile.photos",
                         "https://www.googleapis.com/auth/classroom.rosters",
                         "https://www.googleapis.com/auth/classroom.rosters.readonly"
                     ]
                 }
             },
             "resources": {
                 "guardianInvitations": {
                     "methods": {
                         "list": {
-                            "description": "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 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.",
+                            "description": "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.",
                             "httpMethod": "GET",
                             "id": "classroom.userProfiles.guardianInvitations.list",
                             "parameterOrder": [
                                 "studentId"
                             ],
                             "parameters": {
                                 "studentId": {
-                                    "description": "The ID of the student whose guardian invitations are to be returned. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
+                                    "description": "The ID of the student whose guardian invitations are to be returned. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user * the string literal `\"-\"`, indicating that results should be returned for all students that the requesting user is permitted to view guardian invitations.",
                                     "location": "path",
                                     "required": true,
                                     "type": "string"
                                 },
                                 "invitedEmailAddress": {
                                     "description": "If specified, only results with the specified `invited_email_address` will be returned.",
                                     "location": "query",
                                     "type": "string"
                                 },
                                 "states": {
@@ skipping 107 matching lines @@
                             },
                             "response": {
                                 "$ref": "GuardianInvitation"
                             }
                         }
                     }
                 },
                 "guardians": {
                     "methods": {
                         "list": {
-                            "description": "Returns a list of guardians that the requesting user is permitted to view, restricted to those that match the request. 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 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.",
+                            "description": "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.",
                             "httpMethod": "GET",
                             "id": "classroom.userProfiles.guardians.list",
                             "parameterOrder": [
                                 "studentId"
                             ],
                             "parameters": {
                                 "studentId": {
-                                    "description": "Filter results by the student who the guardian is linked to. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
+                                    "description": "Filter results by the student who the guardian is linked to. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user * the string literal `\"-\"`, indicating that results should be returned for all students that the requesting user has access to view.",
                                     "location": "path",
                                     "required": true,
                                     "type": "string"
                                 },
                                 "invitedEmailAddress": {
                                     "description": "Filter results by the email address that the original invitation was sent to, resulting in this guardian link. This filter can only be used by domain administrators.",
                                     "location": "query",
                                     "type": "string"
                                 },
                                 "pageToken": {
@@ skipping 190 matching lines @@
                     "response": {
                         "$ref": "Empty"
                     },
                     "scopes": [
                         "https://www.googleapis.com/auth/classroom.rosters"
                     ]
                 }
             }
         }
     },
-    "revision": "20160816",
+    "revision": "20161006",
     "rootUrl": "https://classroom.googleapis.com/",
     "schemas": {
         "Course": {
             "description": "A Course in Classroom.",
             "id": "Course",
             "properties": {
                 "id": {
                     "description": "Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error.",
                     "type": "string"
                 },
@@ skipping 59 matching lines @@
                 "teacherFolder": {
                     "$ref": "DriveFolder",
                     "description": "Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only."
                 },
                 "courseMaterialSets": {
                     "description": "Sets of materials that appear on the \"about\" page of this course. Read-only.",
                     "items": {
                         "$ref": "CourseMaterialSet"
                     },
                     "type": "array"
+                },
+                "guardiansEnabled": {
+                    "description": "Whether or not guardian notifications are enabled for this course. Read-only.",
+                    "type": "boolean"
                 }
             },
             "type": "object"
         },
         "DriveFolder": {
             "description": "Representation of a Google Drive folder.",
             "id": "DriveFolder",
             "properties": {
                 "id": {
                     "description": "Drive API resource ID.",
@@ skipping 893 matching lines @@
                     "type": "array"
                 }
             },
             "type": "object"
         }
     },
     "servicePath": "",
     "title": "Google Classroom API",
     "version": "v1"
 }