Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3e4b5db2a4aeceb4b99f280e8a843c65284c2f9f / . / docs / dyn / classroom_v1.userProfiles.guardians.html
blob: c8d7b71b8f0703cc5f0088706417b47f41867fd4 [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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]81 <code><a href="#delete">delete(studentId, guardianId, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]82<p class="firstline">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`.</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="#get">get(studentId, guardianId, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]85<p class="firstline">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`.</p>
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]86<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]87 <code><a href="#list">list(studentId, invitedEmailAddress=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]88<p class="firstline">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.</p>
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<h3>Method Details</h3>
93<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]94 <code class="details" id="close">close()</code>
95 <pre>Close httplib2 connections.</pre>
96</div>
97
98<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]99 <code class="details" id="delete">delete(studentId, guardianId, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]100 <pre>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`.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]101
102Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]103 studentId: string, The student whose guardian is to be deleted. One of the following: * the numeric identifier for the user * the email address of the user * the string literal `&quot;me&quot;`, indicating the requesting user (required)
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]104 guardianId: string, The `id` field from a `Guardian`. (required)
105 x__xgafv: string, V1 error format.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]106 Allowed values
107 1 - v1 error format
108 2 - v2 error format
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]109
110Returns:
111 An object of the form:
112
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]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 `{}`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]114}</pre>
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]115</div>
116
117<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]118 <code class="details" id="get">get(studentId, guardianId, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]119 <pre>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`.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]120
121Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]122 studentId: string, The student whose guardian is being requested. One of the following: * the numeric identifier for the user * the email address of the user * the string literal `&quot;me&quot;`, indicating the requesting user (required)
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]123 guardianId: string, The `id` field from a `Guardian`. (required)
124 x__xgafv: string, V1 error format.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]125 Allowed values
126 1 - v1 error format
127 2 - v2 error format
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]128
129Returns:
130 An object of the form:
131
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]132 { # Association between a student and a guardian of that student. The guardian may receive information about the student&#x27;s course work.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]133 &quot;guardianId&quot;: &quot;A String&quot;, # Identifier for the guardian.
134 &quot;guardianProfile&quot;: { # Global information for a user. # User profile for the guardian.
135 &quot;emailAddress&quot;: &quot;A String&quot;, # Email address of the user. Read-only.
136 &quot;id&quot;: &quot;A String&quot;, # Identifier of the user. Read-only.
137 &quot;name&quot;: { # Details of the user&#x27;s name. # Name of the user. Read-only.
138 &quot;familyName&quot;: &quot;A String&quot;, # The user&#x27;s last name. Read-only.
139 &quot;fullName&quot;: &quot;A String&quot;, # The user&#x27;s full name formed by concatenating the first and last name values. Read-only.
140 &quot;givenName&quot;: &quot;A String&quot;, # The user&#x27;s first name. Read-only.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]141 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]142 &quot;permissions&quot;: [ # Global permissions of the user. Read-only.
143 { # Global user permission description.
144 &quot;permission&quot;: &quot;A String&quot;, # Permission value.
145 },
146 ],
147 &quot;photoUrl&quot;: &quot;A String&quot;, # URL of user&#x27;s profile photo. Read-only.
148 &quot;verifiedTeacher&quot;: True or False, # Represents whether a G Suite for Education user&#x27;s domain administrator has explicitly verified them as being a teacher. If the user is not a member of a G Suite for Education domain, than this field is always false. Read-only
149 },
150 &quot;invitedEmailAddress&quot;: &quot;A String&quot;, # The email address to which the initial guardian invitation was sent. This field is only visible to domain administrators.
151 &quot;studentId&quot;: &quot;A String&quot;, # Identifier for the student to whom the guardian relationship applies.
152}</pre>
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]153</div>
154
155<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]156 <code class="details" id="list">list(studentId, invitedEmailAddress=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]157 <pre>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 `&quot;-&quot;` 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.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]158
159Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]160 studentId: string, 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 `&quot;me&quot;`, indicating the requesting user * the string literal `&quot;-&quot;`, indicating that results should be returned for all students that the requesting user has access to view. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]161 invitedEmailAddress: string, 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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]162 pageSize: integer, 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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]163 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.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]164 x__xgafv: string, V1 error format.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]165 Allowed values
166 1 - v1 error format
167 2 - v2 error format
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]168
169Returns:
170 An object of the form:
171
172 { # Response when listing guardians.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]173 &quot;guardians&quot;: [ # Guardians on this page of results that met the criteria specified in the request.
174 { # Association between a student and a guardian of that student. The guardian may receive information about the student&#x27;s course work.
175 &quot;guardianId&quot;: &quot;A String&quot;, # Identifier for the guardian.
176 &quot;guardianProfile&quot;: { # Global information for a user. # User profile for the guardian.
177 &quot;emailAddress&quot;: &quot;A String&quot;, # Email address of the user. Read-only.
178 &quot;id&quot;: &quot;A String&quot;, # Identifier of the user. Read-only.
179 &quot;name&quot;: { # Details of the user&#x27;s name. # Name of the user. Read-only.
180 &quot;familyName&quot;: &quot;A String&quot;, # The user&#x27;s last name. Read-only.
181 &quot;fullName&quot;: &quot;A String&quot;, # The user&#x27;s full name formed by concatenating the first and last name values. Read-only.
182 &quot;givenName&quot;: &quot;A String&quot;, # The user&#x27;s first name. Read-only.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]183 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]184 &quot;permissions&quot;: [ # Global permissions of the user. Read-only.
185 { # Global user permission description.
186 &quot;permission&quot;: &quot;A String&quot;, # Permission value.
187 },
188 ],
189 &quot;photoUrl&quot;: &quot;A String&quot;, # URL of user&#x27;s profile photo. Read-only.
190 &quot;verifiedTeacher&quot;: True or False, # Represents whether a G Suite for Education user&#x27;s domain administrator has explicitly verified them as being a teacher. If the user is not a member of a G Suite for Education domain, than this field is always false. Read-only
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]191 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]192 &quot;invitedEmailAddress&quot;: &quot;A String&quot;, # The email address to which the initial guardian invitation was sent. This field is only visible to domain administrators.
193 &quot;studentId&quot;: &quot;A String&quot;, # Identifier for the student to whom the guardian relationship applies.
194 },
195 ],
196 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token identifying the next page of results to return. If empty, no further results are available.
197}</pre>
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]198</div>
199
200<div class="method">
201 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
202 <pre>Retrieves the next page of results.
203
204Args:
205 previous_request: The request for the previous page. (required)
206 previous_response: The response from the request for the previous page. (required)
207
208Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]209 A request object that you can call &#x27;execute()&#x27; on to request the next
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]210 page. Returns None if there are no more items in the collection.
211 </pre>
212</div>
213
214</body></html>