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"> 78 <code><a href="#delete">delete(studentId, guardianId, x__xgafv=None)</a></code></p> 79<p class="firstline">Deletes a guardian.</p> 80<p class="toc_element"> 81 <code><a href="#get">get(studentId, guardianId, x__xgafv=None)</a></code></p> 82<p class="firstline">Returns a specific guardian.</p> 83<p class="toc_element"> 84 <code><a href="#list">list(studentId, 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> 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"> 91 <code class="details" id="delete">delete(studentId, 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`. 110 111Args: 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) 117 guardianId: string, The `id` field from a `Guardian`. (required) 118 x__xgafv: string, V1 error format. 119 Allowed values 120 1 - v1 error format 121 2 - v2 error format 122 123Returns: 124 An object of the form: 125 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 `{}`. 135 }</pre> 136</div> 137 138<div class="method"> 139 <code class="details" id="get">get(studentId, 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`. 155 156Args: 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) 162 guardianId: string, The `id` field from a `Guardian`. (required) 163 x__xgafv: string, V1 error format. 164 Allowed values 165 1 - v1 error format 166 2 - v2 error format 167 168Returns: 169 An object of the form: 170 171 { # Association between a student and a guardian of that student. The guardian 172 # may receive information about the student's course work. 173 "guardianId": "A String", # Identifier for the guardian. 174 "invitedEmailAddress": "A String", # The email address to which the initial guardian invitation was sent. 175 # This field is only visible to domain administrators. 176 "studentId": "A String", # Identifier for the student to whom the guardian relationship applies. 177 "guardianProfile": { # Global information for a user. # User profile for the guardian. 178 "name": { # Details of the user's name. # Name of the user. 179 # 180 # Read-only. 181 "fullName": "A String", # The user's full name formed by concatenating the first and last name 182 # values. 183 # 184 # Read-only. 185 "givenName": "A String", # The user's first name. 186 # 187 # Read-only. 188 "familyName": "A String", # The user's last name. 189 # 190 # Read-only. 191 }, 192 "photoUrl": "A String", # URL of user's profile photo. 193 # 194 # Read-only. 195 "emailAddress": "A String", # Email address of the user. 196 # 197 # Read-only. 198 "verifiedTeacher": True or False, # Represents whether a G Suite for Education user's domain administrator has 199 # explicitly verified them as being a teacher. If the user is not a member of 200 # a G Suite for Education domain, than this field will always be false. 201 # 202 # Read-only 203 "id": "A String", # Identifier of the user. 204 # 205 # Read-only. 206 "permissions": [ # Global permissions of the user. 207 # 208 # Read-only. 209 { # Global user permission description. 210 "permission": "A String", # Permission value. 211 }, 212 ], 213 }, 214 }</pre> 215</div> 216 217<div class="method"> 218 <code class="details" id="list">list(studentId, invitedEmailAddress=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 219 <pre>Returns a list of guardians that the requesting user is permitted to 220view, restricted to those that match the request. 221 222To list guardians for any student that the requesting user may view 223guardians for, use the literal character `-` for the student ID. 224 225This method returns the following error codes: 226 227* `PERMISSION_DENIED` if a `student_id` is specified, and the requesting 228 user is not permitted to view guardian information for that student, if 229 `"-"` is specified as the `student_id` and the user is not a domain 230 administrator, if guardians are not enabled for the domain in question, 231 if the `invited_email_address` filter is set by a user who is not a 232 domain administrator, or for other access errors. 233* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot 234 be recognized (it is not an email address, nor a `student_id` from the 235 API, nor the literal string `me`). May also be returned if an invalid 236 `page_token` is provided. 237* `NOT_FOUND` if a `student_id` is specified, and its format can be 238 recognized, but Classroom has no record of that student. 239 240Args: 241 studentId: string, Filter results by the student who the guardian is linked to. 242The identifier can be one of the following: 243 244* the numeric identifier for the user 245* the email address of the user 246* the string literal `"me"`, indicating the requesting user 247* the string literal `"-"`, indicating that results should be returned for 248 all students that the requesting user has access to view. (required) 249 invitedEmailAddress: string, Filter results by the email address that the original invitation was sent 250to, resulting in this guardian link. 251This filter can only be used by domain administrators. 252 pageSize: integer, Maximum number of items to return. Zero or unspecified indicates that the 253server may assign a maximum. 254 255The server may return fewer than the specified number of results. 256 pageToken: string, nextPageToken 257value returned from a previous 258list call, 259indicating that the subsequent page of results should be returned. 260 261The list request 262must be otherwise identical to the one that resulted in this token. 263 x__xgafv: string, V1 error format. 264 Allowed values 265 1 - v1 error format 266 2 - v2 error format 267 268Returns: 269 An object of the form: 270 271 { # Response when listing guardians. 272 "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further 273 # results are available. 274 "guardians": [ # Guardians on this page of results that met the criteria specified in 275 # the request. 276 { # Association between a student and a guardian of that student. The guardian 277 # may receive information about the student's course work. 278 "guardianId": "A String", # Identifier for the guardian. 279 "invitedEmailAddress": "A String", # The email address to which the initial guardian invitation was sent. 280 # This field is only visible to domain administrators. 281 "studentId": "A String", # Identifier for the student to whom the guardian relationship applies. 282 "guardianProfile": { # Global information for a user. # User profile for the guardian. 283 "name": { # Details of the user's name. # Name of the user. 284 # 285 # Read-only. 286 "fullName": "A String", # The user's full name formed by concatenating the first and last name 287 # values. 288 # 289 # Read-only. 290 "givenName": "A String", # The user's first name. 291 # 292 # Read-only. 293 "familyName": "A String", # The user's last name. 294 # 295 # Read-only. 296 }, 297 "photoUrl": "A String", # URL of user's profile photo. 298 # 299 # Read-only. 300 "emailAddress": "A String", # Email address of the user. 301 # 302 # Read-only. 303 "verifiedTeacher": True or False, # Represents whether a G Suite for Education user's domain administrator has 304 # explicitly verified them as being a teacher. If the user is not a member of 305 # a G Suite for Education domain, than this field will always be false. 306 # 307 # Read-only 308 "id": "A String", # Identifier of the user. 309 # 310 # Read-only. 311 "permissions": [ # Global permissions of the user. 312 # 313 # Read-only. 314 { # Global user permission description. 315 "permission": "A String", # Permission value. 316 }, 317 ], 318 }, 319 }, 320 ], 321 }</pre> 322</div> 323 324<div class="method"> 325 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 326 <pre>Retrieves the next page of results. 327 328Args: 329 previous_request: The request for the previous page. (required) 330 previous_response: The response from the request for the previous page. (required) 331 332Returns: 333 A request object that you can call 'execute()' on to request the next 334 page. Returns None if there are no more items in the collection. 335 </pre> 336</div> 337 338</body></html>