Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / e833b79ffee531ae64e11175718bb2fffc504950 / . / docs / dyn / classroom_v1.userProfiles.guardians.html
blob: d6b335f77f6ccf3a0779363a42210f8a9ba5aa9c [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.guardians.html">guardians</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]78 <code><a href="#delete">delete(studentId=None, guardianId, x__xgafv=None)</a></code></p>
79<p class="firstline">Deletes a guardian.</p>
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]80<p class="toc_element">
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]81 <code><a href="#get">get(studentId=None, guardianId, x__xgafv=None)</a></code></p>
82<p class="firstline">Returns a specific guardian.</p>
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]83<p class="toc_element">
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]84 <code><a href="#list">list(studentId=None, invitedEmailAddress=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Returns a list of guardians that the requesting user is permitted to</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<h3>Method Details</h3>
90<div class="method">
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]91 <code class="details" id="delete">delete(studentId=None, guardianId, x__xgafv=None)</code>
92 <pre>Deletes a guardian.
93
94The guardian will no longer receive guardian notifications and the guardian
95will no longer be accessible via the API.
96
97This method returns the following error codes:
98
99* `PERMISSION_DENIED` if no user that matches the provided `student_id`
100 is visible to the requesting user, if the requesting user is not
101 permitted to manage guardians for the student identified by the
102 `student_id`, if guardians are not enabled for the domain in question,
103 or for other access errors.
104* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot
105 be recognized (it is not an email address, nor a `student_id` from the
106 API).
107* `NOT_FOUND` if the requesting user is permitted to modify guardians for
108 the requested `student_id`, but no `Guardian` record exists for that
109 student with the provided `guardian_id`.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]110
111Args:
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]112 studentId: string, The student whose guardian is to be deleted. One of the following:
113
114* the numeric identifier for the user
115* the email address of the user
116* the string literal `"me"`, indicating the requesting user (required)
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]117 guardianId: string, The `id` field from a `Guardian`. (required)
118 x__xgafv: string, V1 error format.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]119 Allowed values
120 1 - v1 error format
121 2 - v2 error format
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]122
123Returns:
124 An object of the form:
125
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]126 { # A generic empty message that you can re-use to avoid defining duplicated
127 # empty messages in your APIs. A typical example is to use it as the request
128 # or the response type of an API method. For instance:
129 #
130 # service Foo {
131 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
132 # }
133 #
134 # The JSON representation for `Empty` is empty JSON object `{}`.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]135 }</pre>
136</div>
137
138<div class="method">
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]139 <code class="details" id="get">get(studentId=None, guardianId, x__xgafv=None)</code>
140 <pre>Returns a specific guardian.
141
142This method returns the following error codes:
143
144* `PERMISSION_DENIED` if no user that matches the provided `student_id`
145 is visible to the requesting user, if the requesting user is not
146 permitted to view guardian information for the student identified by the
147 `student_id`, if guardians are not enabled for the domain in question,
148 or for other access errors.
149* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot
150 be recognized (it is not an email address, nor a `student_id` from the
151 API, nor the literal string `me`).
152* `NOT_FOUND` if the requesting user is permitted to view guardians for
153 the requested `student_id`, but no `Guardian` record exists for that
154 student that matches the provided `guardian_id`.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]155
156Args:
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]157 studentId: string, The student whose guardian is being requested. One of the following:
158
159* the numeric identifier for the user
160* the email address of the user
161* the string literal `"me"`, indicating the requesting user (required)
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]162 guardianId: string, The `id` field from a `Guardian`. (required)
163 x__xgafv: string, V1 error format.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]164 Allowed values
165 1 - v1 error format
166 2 - v2 error format
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]167
168Returns:
169 An object of the form:
170
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]171 { # Association between a student and a guardian of that student. The guardian
172 # may receive information about the student's course work.
173 "studentId": "A String", # Identifier for the student to whom the guardian relationship applies.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]174 "guardianId": "A String", # Identifier for the guardian.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]175 "invitedEmailAddress": "A String", # The email address to which the initial guardian invitation was sent.
176 # This field is only visible to domain administrators.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]177 "guardianProfile": { # Global information for a user. # User profile for the guardian.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]178 "photoUrl": "A String", # URL of user's profile photo.
179 #
180 # Read-only.
181 "emailAddress": "A String", # Email address of the user.
182 #
183 # Read-only.
184 "id": "A String", # Identifier of the user.
185 #
186 # Read-only.
187 "name": { # Details of the user's name. # Name of the user.
188 #
189 # Read-only.
190 "fullName": "A String", # The user's full name formed by concatenating the first and last name
191 # values.
192 #
193 # Read-only.
194 "givenName": "A String", # The user's first name.
195 #
196 # Read-only.
197 "familyName": "A String", # The user's last name.
198 #
199 # Read-only.
200 },
201 "permissions": [ # Global permissions of the user.
202 #
203 # Read-only.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]204 { # Global user permission description.
205 "permission": "A String", # Permission value.
206 },
207 ],
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]208 },
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]209 }</pre>
210</div>
211
212<div class="method">
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]213 <code class="details" id="list">list(studentId=None, invitedEmailAddress=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
214 <pre>Returns a list of guardians that the requesting user is permitted to
215view, restricted to those that match the request.
216
217To list guardians for any student that the requesting user may view
218guardians for, use the literal character `-` for the student ID.
219
220This method returns the following error codes:
221
222* `PERMISSION_DENIED` if a `student_id` is specified, and the requesting
223 user is not permitted to view guardian information for that student, if
224 `"-"` is specified as the `student_id` and the user is not a domain
225 administrator, if guardians are not enabled for the domain in question,
226 if the `invited_email_address` filter is set by a user who is not a
227 domain administrator, or for other access errors.
228* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot
229 be recognized (it is not an email address, nor a `student_id` from the
230 API, nor the literal string `me`). May also be returned if an invalid
231 `page_token` is provided.
232* `NOT_FOUND` if a `student_id` is specified, and its format can be
233 recognized, but Classroom has no record of that student.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]234
235Args:
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]236 studentId: string, Filter results by the student who the guardian is linked to.
237The identifier can be one of the following:
238
239* the numeric identifier for the user
240* the email address of the user
241* the string literal `"me"`, indicating the requesting user
242* the string literal `"-"`, indicating that results should be returned for
243 all students that the requesting user has access to view. (required)
244 invitedEmailAddress: string, Filter results by the email address that the original invitation was sent
245to, resulting in this guardian link.
246This filter can only be used by domain administrators.
247 pageSize: integer, Maximum number of items to return. Zero or unspecified indicates that the
248server may assign a maximum.
249
250The server may return fewer than the specified number of results.
251 pageToken: string, nextPageToken
252value returned from a previous
253list call,
254indicating that the subsequent page of results should be returned.
255
256The list request
257must be otherwise identical to the one that resulted in this token.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]258 x__xgafv: string, V1 error format.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]259 Allowed values
260 1 - v1 error format
261 2 - v2 error format
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]262
263Returns:
264 An object of the form:
265
266 { # Response when listing guardians.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]267 "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further
268 # results are available.
269 "guardians": [ # Guardians on this page of results that met the criteria specified in
270 # the request.
271 { # Association between a student and a guardian of that student. The guardian
272 # may receive information about the student's course work.
273 "studentId": "A String", # Identifier for the student to whom the guardian relationship applies.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]274 "guardianId": "A String", # Identifier for the guardian.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]275 "invitedEmailAddress": "A String", # The email address to which the initial guardian invitation was sent.
276 # This field is only visible to domain administrators.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]277 "guardianProfile": { # Global information for a user. # User profile for the guardian.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]278 "photoUrl": "A String", # URL of user's profile photo.
279 #
280 # Read-only.
281 "emailAddress": "A String", # Email address of the user.
282 #
283 # Read-only.
284 "id": "A String", # Identifier of the user.
285 #
286 # Read-only.
287 "name": { # Details of the user's name. # Name of the user.
288 #
289 # Read-only.
290 "fullName": "A String", # The user's full name formed by concatenating the first and last name
291 # values.
292 #
293 # Read-only.
294 "givenName": "A String", # The user's first name.
295 #
296 # Read-only.
297 "familyName": "A String", # The user's last name.
298 #
299 # Read-only.
300 },
301 "permissions": [ # Global permissions of the user.
302 #
303 # Read-only.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]304 { # Global user permission description.
305 "permission": "A String", # Permission value.
306 },
307 ],
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]308 },
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]309 },
310 ],
311 }</pre>
312</div>
313
314<div class="method">
315 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
316 <pre>Retrieves the next page of results.
317
318Args:
319 previous_request: The request for the previous page. (required)
320 previous_response: The response from the request for the previous page. (required)
321
322Returns:
323 A request object that you can call 'execute()' on to request the next
324 page. Returns None if there are no more items in the collection.
325 </pre>
326</div>
327
328</body></html>