1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="classroom_v1.html">Google Classroom API</a> . <a href="classroom_v1.invitations.html">invitations</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#accept">accept(id, x__xgafv=None)</a></code></p> 79<p class="firstline">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.</p> 80<p class="toc_element"> 81 <code><a href="#close">close()</a></code></p> 82<p class="firstline">Close httplib2 connections.</p> 83<p class="toc_element"> 84 <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p> 85<p class="firstline">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.</p> 86<p class="toc_element"> 87 <code><a href="#delete">delete(id, x__xgafv=None)</a></code></p> 88<p class="firstline">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.</p> 89<p class="toc_element"> 90 <code><a href="#get">get(id, x__xgafv=None)</a></code></p> 91<p class="firstline">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.</p> 92<p class="toc_element"> 93 <code><a href="#list">list(courseId=None, pageSize=None, pageToken=None, userId=None, x__xgafv=None)</a></code></p> 94<p class="firstline">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.</p> 95<p class="toc_element"> 96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 97<p class="firstline">Retrieves the next page of results.</p> 98<h3>Method Details</h3> 99<div class="method"> 100 <code class="details" id="accept">accept(id, x__xgafv=None)</code> 101 <pre>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. 102 103Args: 104 id: string, Identifier of the invitation to accept. (required) 105 x__xgafv: string, V1 error format. 106 Allowed values 107 1 - v1 error format 108 2 - v2 error format 109 110Returns: 111 An object of the form: 112 113 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 114}</pre> 115</div> 116 117<div class="method"> 118 <code class="details" id="close">close()</code> 119 <pre>Close httplib2 connections.</pre> 120</div> 121 122<div class="method"> 123 <code class="details" id="create">create(body=None, x__xgafv=None)</code> 124 <pre>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. 125 126Args: 127 body: object, The request body. 128 The object takes the form of: 129 130{ # An invitation to join a course. 131 "courseId": "A String", # Identifier of the course to invite the user to. 132 "id": "A String", # Identifier assigned by Classroom. Read-only. 133 "role": "A String", # Role to invite the user to have. Must not be `COURSE_ROLE_UNSPECIFIED`. 134 "userId": "A String", # Identifier of the invited user. When specified as a parameter of a request, this identifier can be set to one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user 135} 136 137 x__xgafv: string, V1 error format. 138 Allowed values 139 1 - v1 error format 140 2 - v2 error format 141 142Returns: 143 An object of the form: 144 145 { # An invitation to join a course. 146 "courseId": "A String", # Identifier of the course to invite the user to. 147 "id": "A String", # Identifier assigned by Classroom. Read-only. 148 "role": "A String", # Role to invite the user to have. Must not be `COURSE_ROLE_UNSPECIFIED`. 149 "userId": "A String", # Identifier of the invited user. When specified as a parameter of a request, this identifier can be set to one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user 150}</pre> 151</div> 152 153<div class="method"> 154 <code class="details" id="delete">delete(id, x__xgafv=None)</code> 155 <pre>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. 156 157Args: 158 id: string, Identifier of the invitation to delete. (required) 159 x__xgafv: string, V1 error format. 160 Allowed values 161 1 - v1 error format 162 2 - v2 error format 163 164Returns: 165 An object of the form: 166 167 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 168}</pre> 169</div> 170 171<div class="method"> 172 <code class="details" id="get">get(id, x__xgafv=None)</code> 173 <pre>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. 174 175Args: 176 id: string, Identifier of the invitation to return. (required) 177 x__xgafv: string, V1 error format. 178 Allowed values 179 1 - v1 error format 180 2 - v2 error format 181 182Returns: 183 An object of the form: 184 185 { # An invitation to join a course. 186 "courseId": "A String", # Identifier of the course to invite the user to. 187 "id": "A String", # Identifier assigned by Classroom. Read-only. 188 "role": "A String", # Role to invite the user to have. Must not be `COURSE_ROLE_UNSPECIFIED`. 189 "userId": "A String", # Identifier of the invited user. When specified as a parameter of a request, this identifier can be set to one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user 190}</pre> 191</div> 192 193<div class="method"> 194 <code class="details" id="list">list(courseId=None, pageSize=None, pageToken=None, userId=None, x__xgafv=None)</code> 195 <pre>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. 196 197Args: 198 courseId: string, Restricts returned invitations to those for a course with the specified identifier. 199 pageSize: integer, Maximum number of items to return. The default is 500 if unspecified or `0`. The server may return fewer than the specified number of results. 200 pageToken: string, 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. 201 userId: string, Restricts returned invitations to those for a specific user. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user 202 x__xgafv: string, V1 error format. 203 Allowed values 204 1 - v1 error format 205 2 - v2 error format 206 207Returns: 208 An object of the form: 209 210 { # Response when listing invitations. 211 "invitations": [ # Invitations that match the list request. 212 { # An invitation to join a course. 213 "courseId": "A String", # Identifier of the course to invite the user to. 214 "id": "A String", # Identifier assigned by Classroom. Read-only. 215 "role": "A String", # Role to invite the user to have. Must not be `COURSE_ROLE_UNSPECIFIED`. 216 "userId": "A String", # Identifier of the invited user. When specified as a parameter of a request, this identifier can be set to one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user 217 }, 218 ], 219 "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available. 220}</pre> 221</div> 222 223<div class="method"> 224 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 225 <pre>Retrieves the next page of results. 226 227Args: 228 previous_request: The request for the previous page. (required) 229 previous_response: The response from the request for the previous page. (required) 230 231Returns: 232 A request object that you can call 'execute()' on to request the next 233 page. Returns None if there are no more items in the collection. 234 </pre> 235</div> 236 237</body></html>