Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 98b51f044ede8b9b24e584ab9680e3f35f4bd469 / . / docs / dyn / classroom_v1.userProfiles.guardianInvitations.html
blob: ae27ed4d8583f352c2142465f93a4beb13c6c8b6 [file] [log] [blame]
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]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.userProfiles.html">userProfiles</a> . <a href="classroom_v1.userProfiles.guardianInvitations.html">guardianInvitations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#create">create(studentId, body, x__xgafv=None)</a></code></p>
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]79<p class="firstline">Creates a guardian invitation, and sends an email to the guardian asking</p>
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]80<p class="toc_element">
81 <code><a href="#get">get(studentId, invitationId, x__xgafv=None)</a></code></p>
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]82<p class="firstline">Returns a specific guardian invitation.</p>
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]83<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]84 <code><a href="#list">list(studentId, invitedEmailAddress=None, pageSize=None, states=None, pageToken=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]85<p class="firstline">Returns a list of guardian invitations that the requesting user is</p>
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]86<p class="toc_element">
87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<p class="toc_element">
90 <code><a href="#patch">patch(studentId, invitationId, body, updateMask=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]91<p class="firstline">Modifies a guardian invitation.</p>
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="create">create(studentId, body, x__xgafv=None)</code>
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]95 <pre>Creates a guardian invitation, and sends an email to the guardian asking
96them to confirm that they are the student's guardian.
97
98Once the guardian accepts the invitation, their `state` will change to
99`COMPLETED` and they will start receiving guardian notifications. A
100`Guardian` resource will also be created to represent the active guardian.
101
102The request object must have the `student_id` and
103`invited_email_address` fields set. Failing to set these fields, or
104setting any other fields in the request, will result in an error.
105
106This method returns the following error codes:
107
108* `PERMISSION_DENIED` if the current user does not have permission to
109 manage guardians, if the guardian in question has already rejected
110 too many requests for that student, if guardians are not enabled for the
111 domain in question, or for other access errors.
112* `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian
113 link limit.
114* `INVALID_ARGUMENT` if the guardian email address is not valid (for
115 example, if it is too long), or if the format of the student ID provided
116 cannot be recognized (it is not an email address, nor a `user_id` from
117 this API). This error will also be returned if read-only fields are set,
118 or if the `state` field is set to to a value other than `PENDING`.
119* `NOT_FOUND` if the student ID provided is a valid student ID, but
120 Classroom has no record of that student.
121* `ALREADY_EXISTS` if there is already a pending guardian invitation for
122 the student and `invited_email_address` provided, or if the provided
123 `invited_email_address` matches the Google account of an existing
124 `Guardian` for this user.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]125
126Args:
127 studentId: string, ID of the student (in standard format) (required)
128 body: object, The request body. (required)
129 The object takes the form of:
130
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]131{ # An invitation to become the guardian of a specified user, sent to a specified
132 # email address.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]133 "invitationId": "A String", # Unique identifier for this invitation.
134 #
135 # Read-only.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]136 "studentId": "A String", # ID of the student (in standard format)
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]137 "creationTime": "A String", # The time that this invitation was created.
138 #
139 # Read-only.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]140 "state": "A String", # The state that this invitation is in.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]141 "invitedEmailAddress": "A String", # Email address that the invitation was sent to.
142 # This field is only visible to domain administrators.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]143 }
144
145 x__xgafv: string, V1 error format.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]146 Allowed values
147 1 - v1 error format
148 2 - v2 error format
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]149
150Returns:
151 An object of the form:
152
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]153 { # An invitation to become the guardian of a specified user, sent to a specified
154 # email address.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]155 "invitationId": "A String", # Unique identifier for this invitation.
156 #
157 # Read-only.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]158 "studentId": "A String", # ID of the student (in standard format)
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]159 "creationTime": "A String", # The time that this invitation was created.
160 #
161 # Read-only.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]162 "state": "A String", # The state that this invitation is in.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]163 "invitedEmailAddress": "A String", # Email address that the invitation was sent to.
164 # This field is only visible to domain administrators.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]165 }</pre>
166</div>
167
168<div class="method">
169 <code class="details" id="get">get(studentId, invitationId, x__xgafv=None)</code>
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]170 <pre>Returns a specific guardian invitation.
171
172This method returns the following error codes:
173
174* `PERMISSION_DENIED` if the requesting user is not permitted to view
175 guardian invitations for the student identified by the `student_id`, if
176 guardians are not enabled for the domain in question, or for other
177 access errors.
178* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot
179 be recognized (it is not an email address, nor a `student_id` from the
180 API, nor the literal string `me`).
181* `NOT_FOUND` if Classroom cannot find any record of the given student or
182 `invitation_id`. May also be returned if the student exists, but the
183 requesting user does not have access to see that student.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]184
185Args:
186 studentId: string, The ID of the student whose guardian invitation is being requested. (required)
187 invitationId: string, The `id` field of the `GuardianInvitation` being requested. (required)
188 x__xgafv: string, V1 error format.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]189 Allowed values
190 1 - v1 error format
191 2 - v2 error format
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]192
193Returns:
194 An object of the form:
195
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]196 { # An invitation to become the guardian of a specified user, sent to a specified
197 # email address.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]198 "invitationId": "A String", # Unique identifier for this invitation.
199 #
200 # Read-only.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]201 "studentId": "A String", # ID of the student (in standard format)
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]202 "creationTime": "A String", # The time that this invitation was created.
203 #
204 # Read-only.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]205 "state": "A String", # The state that this invitation is in.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]206 "invitedEmailAddress": "A String", # Email address that the invitation was sent to.
207 # This field is only visible to domain administrators.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]208 }</pre>
209</div>
210
211<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]212 <code class="details" id="list">list(studentId, invitedEmailAddress=None, pageSize=None, states=None, pageToken=None, x__xgafv=None)</code>
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]213 <pre>Returns a list of guardian invitations that the requesting user is
214permitted to view, filtered by the parameters provided.
215
216This method returns the following error codes:
217
218* `PERMISSION_DENIED` if a `student_id` is specified, and the requesting
219 user is not permitted to view guardian invitations for that student, if
220 `"-"` is specified as the `student_id` and the user is not a domain
221 administrator, if guardians are not enabled for the domain in question,
222 or for other access errors.
223* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot
224 be recognized (it is not an email address, nor a `student_id` from the
225 API, nor the literal string `me`). May also be returned if an invalid
226 `page_token` or `state` is provided.
227* `NOT_FOUND` if a `student_id` is specified, and its format can be
228 recognized, but Classroom has no record of that student.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]229
230Args:
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]231 studentId: string, The ID of the student whose guardian invitations are to be returned.
232The identifier can be one of the following:
233
234* the numeric identifier for the user
235* the email address of the user
236* the string literal `"me"`, indicating the requesting user
237* the string literal `"-"`, indicating that results should be returned for
238 all students that the requesting user is permitted to view guardian
239 invitations. (required)
240 invitedEmailAddress: string, If specified, only results with the specified `invited_email_address`
241will be returned.
242 pageSize: integer, Maximum number of items to return. Zero or unspecified indicates that the
243server may assign a maximum.
244
245The server may return fewer than the specified number of results.
246 states: string, If specified, only results with the specified `state` values will be
247returned. Otherwise, results with a `state` of `PENDING` will be returned. (repeated)
248 pageToken: string, nextPageToken
249value returned from a previous
250list call,
251indicating that the subsequent page of results should be returned.
252
253The list request
254must be otherwise identical to the one that resulted in this token.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]255 x__xgafv: string, V1 error format.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]256 Allowed values
257 1 - v1 error format
258 2 - v2 error format
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]259
260Returns:
261 An object of the form:
262
263 { # Response when listing guardian invitations.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]264 "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further
265 # results are available.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]266 "guardianInvitations": [ # Guardian invitations that matched the list request.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]267 { # An invitation to become the guardian of a specified user, sent to a specified
268 # email address.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]269 "invitationId": "A String", # Unique identifier for this invitation.
270 #
271 # Read-only.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]272 "studentId": "A String", # ID of the student (in standard format)
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]273 "creationTime": "A String", # The time that this invitation was created.
274 #
275 # Read-only.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]276 "state": "A String", # The state that this invitation is in.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]277 "invitedEmailAddress": "A String", # Email address that the invitation was sent to.
278 # This field is only visible to domain administrators.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]279 },
280 ],
281 }</pre>
282</div>
283
284<div class="method">
285 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
286 <pre>Retrieves the next page of results.
287
288Args:
289 previous_request: The request for the previous page. (required)
290 previous_response: The response from the request for the previous page. (required)
291
292Returns:
293 A request object that you can call 'execute()' on to request the next
294 page. Returns None if there are no more items in the collection.
295 </pre>
296</div>
297
298<div class="method">
299 <code class="details" id="patch">patch(studentId, invitationId, body, updateMask=None, x__xgafv=None)</code>
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]300 <pre>Modifies a guardian invitation.
301
302Currently, the only valid modification is to change the `state` from
303`PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation.
304
305This method returns the following error codes:
306
307* `PERMISSION_DENIED` if the current user does not have permission to
308 manage guardians, if guardians are not enabled for the domain in question
309 or for other access errors.
310* `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state.
311* `INVALID_ARGUMENT` if the format of the student ID provided
312 cannot be recognized (it is not an email address, nor a `user_id` from
313 this API), or if the passed `GuardianInvitation` has a `state` other than
314 `COMPLETE`, or if it modifies fields other than `state`.
315* `NOT_FOUND` if the student ID provided is a valid student ID, but
316 Classroom has no record of that student, or if the `id` field does not
317 refer to a guardian invitation known to Classroom.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]318
319Args:
320 studentId: string, The ID of the student whose guardian invitation is to be modified. (required)
321 invitationId: string, The `id` field of the `GuardianInvitation` to be modified. (required)
322 body: object, The request body. (required)
323 The object takes the form of:
324
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]325{ # An invitation to become the guardian of a specified user, sent to a specified
326 # email address.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]327 "invitationId": "A String", # Unique identifier for this invitation.
328 #
329 # Read-only.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]330 "studentId": "A String", # ID of the student (in standard format)
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]331 "creationTime": "A String", # The time that this invitation was created.
332 #
333 # Read-only.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]334 "state": "A String", # The state that this invitation is in.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]335 "invitedEmailAddress": "A String", # Email address that the invitation was sent to.
336 # This field is only visible to domain administrators.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]337 }
338
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]339 updateMask: string, Mask that identifies which fields on the course to update.
340This field is required to do an update. The update will fail if invalid
341fields are specified. The following fields are valid:
342
343* `state`
344
345When set in a query parameter, this field should be specified as
346
347`updateMask=<field1>,<field2>,...`
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]348 x__xgafv: string, V1 error format.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]349 Allowed values
350 1 - v1 error format
351 2 - v2 error format
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]352
353Returns:
354 An object of the form:
355
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]356 { # An invitation to become the guardian of a specified user, sent to a specified
357 # email address.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]358 "invitationId": "A String", # Unique identifier for this invitation.
359 #
360 # Read-only.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]361 "studentId": "A String", # ID of the student (in standard format)
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]362 "creationTime": "A String", # The time that this invitation was created.
363 #
364 # Read-only.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]365 "state": "A String", # The state that this invitation is in.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]366 "invitedEmailAddress": "A String", # Email address that the invitation was sent to.
367 # This field is only visible to domain administrators.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]368 }</pre>
369</div>
370
371</body></html>