Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c30d2b5d4478b230246dcaaa9f1c533ca3304387 / . / docs / dyn / classroom_v1.userProfiles.guardianInvitations.html
blob: f9a6e16c496eaa7e8399fd15eb1133991740976a [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>
79<p class="firstline">Creates a guardian invitation, and sends an email to the guardian asking them to confirm that they are the student's guardian. Once the guardian accepts the invitation, their `state` will change to `COMPLETED` and they will start receiving guardian notifications. A `Guardian` resource will also be created to represent the active guardian. The request object must have the `student_id` and `invited_email_address` fields set. Failing to set these fields, or setting any other fields in the request, will result in an error. This method returns the following error codes: * `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if the guardian in question has already rejected too many requests for that student, if guardians are not enabled for the domain in question, or for other access errors. * `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian link limit. * `INVALID_ARGUMENT` if the guardian email address is not valid (for example, if it is too long), or if the format of the student ID provided cannot be recognized (it is not an email address, nor a `user_id` from this API). This error will also be returned if read-only fields are set, or if the `state` field is set to to a value other than `PENDING`. * `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student. * `ALREADY_EXISTS` if there is already a pending guardian invitation for the student and `invited_email_address` provided, or if the provided `invited_email_address` matches the Google account of an existing `Guardian` for this user.</p>
80<p class="toc_element">
81 <code><a href="#get">get(studentId, invitationId, x__xgafv=None)</a></code></p>
82<p class="firstline">Returns a specific guardian invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view guardian invitations 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 Classroom cannot find any record of the given student or `invitation_id`. May also be returned if the student exists, but the requesting user does not have access to see that student.</p>
83<p class="toc_element">
84 <code><a href="#list">list(studentId, invitedEmailAddress=None, pageSize=None, states=None, pageToken=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Returns a list of guardian invitations that the requesting user is permitted to view, filtered by the parameters provided. 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 invitations 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, 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` or `state` 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>
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>
91<p class="firstline">Modifies a guardian invitation. Currently, the only valid modification is to change the `state` from `PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if guardians are not enabled for the domain in question or for other access errors. * `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state. * `INVALID_ARGUMENT` if the format of the student ID provided cannot be recognized (it is not an email address, nor a `user_id` from this API), or if the passed `GuardianInvitation` has a `state` other than `COMPLETE`, or if it modifies fields other than `state`. * `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student, or if the `id` field does not refer to a guardian invitation known to Classroom.</p>
92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="create">create(studentId, body, x__xgafv=None)</code>
95 <pre>Creates a guardian invitation, and sends an email to the guardian asking them to confirm that they are the student's guardian. Once the guardian accepts the invitation, their `state` will change to `COMPLETED` and they will start receiving guardian notifications. A `Guardian` resource will also be created to represent the active guardian. The request object must have the `student_id` and `invited_email_address` fields set. Failing to set these fields, or setting any other fields in the request, will result in an error. This method returns the following error codes: * `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if the guardian in question has already rejected too many requests for that student, if guardians are not enabled for the domain in question, or for other access errors. * `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian link limit. * `INVALID_ARGUMENT` if the guardian email address is not valid (for example, if it is too long), or if the format of the student ID provided cannot be recognized (it is not an email address, nor a `user_id` from this API). This error will also be returned if read-only fields are set, or if the `state` field is set to to a value other than `PENDING`. * `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student. * `ALREADY_EXISTS` if there is already a pending guardian invitation for the student and `invited_email_address` provided, or if the provided `invited_email_address` matches the Google account of an existing `Guardian` for this user.
96
97Args:
98 studentId: string, ID of the student (in standard format) (required)
99 body: object, The request body. (required)
100 The object takes the form of:
101
102{ # An invitation to become the guardian of a specified user, sent to a specified email address.
103 "invitationId": "A String", # Unique identifier for this invitation. Read-only.
104 "studentId": "A String", # ID of the student (in standard format)
105 "creationTime": "A String", # The time that this invitation was created. Read-only.
106 "invitedEmailAddress": "A String", # Email address that the invitation was sent to. This field is only visible to domain administrators.
107 "state": "A String", # The state that this invitation is in.
108 }
109
110 x__xgafv: string, V1 error format.
111
112Returns:
113 An object of the form:
114
115 { # An invitation to become the guardian of a specified user, sent to a specified email address.
116 "invitationId": "A String", # Unique identifier for this invitation. Read-only.
117 "studentId": "A String", # ID of the student (in standard format)
118 "creationTime": "A String", # The time that this invitation was created. Read-only.
119 "invitedEmailAddress": "A String", # Email address that the invitation was sent to. This field is only visible to domain administrators.
120 "state": "A String", # The state that this invitation is in.
121 }</pre>
122</div>
123
124<div class="method">
125 <code class="details" id="get">get(studentId, invitationId, x__xgafv=None)</code>
126 <pre>Returns a specific guardian invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view guardian invitations 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 Classroom cannot find any record of the given student or `invitation_id`. May also be returned if the student exists, but the requesting user does not have access to see that student.
127
128Args:
129 studentId: string, The ID of the student whose guardian invitation is being requested. (required)
130 invitationId: string, The `id` field of the `GuardianInvitation` being requested. (required)
131 x__xgafv: string, V1 error format.
132
133Returns:
134 An object of the form:
135
136 { # An invitation to become the guardian of a specified user, sent to a specified email address.
137 "invitationId": "A String", # Unique identifier for this invitation. Read-only.
138 "studentId": "A String", # ID of the student (in standard format)
139 "creationTime": "A String", # The time that this invitation was created. Read-only.
140 "invitedEmailAddress": "A String", # Email address that the invitation was sent to. This field is only visible to domain administrators.
141 "state": "A String", # The state that this invitation is in.
142 }</pre>
143</div>
144
145<div class="method">
146 <code class="details" id="list">list(studentId, invitedEmailAddress=None, pageSize=None, states=None, pageToken=None, x__xgafv=None)</code>
147 <pre>Returns a list of guardian invitations that the requesting user is permitted to view, filtered by the parameters provided. 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 invitations 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, 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` or `state` is provided. * `NOT_FOUND` if a `student_id` is specified, and its format can be recognized, but Classroom has no record of that student.
148
149Args:
150 studentId: string, The ID of the student whose guardian invitations are to be returned. 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 * the string literal `"-"`, indicating that results should be returned for all students that the requesting user is permitted to view guardian invitations. (required)
151 invitedEmailAddress: string, If specified, only results with the specified `invited_email_address` will be returned.
152 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.
153 states: string, If specified, only results with the specified `state` values will be returned. Otherwise, results with a `state` of `PENDING` will be returned. (repeated)
154 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.
155 x__xgafv: string, V1 error format.
156
157Returns:
158 An object of the form:
159
160 { # Response when listing guardian invitations.
161 "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available.
162 "guardianInvitations": [ # Guardian invitations that matched the list request.
163 { # An invitation to become the guardian of a specified user, sent to a specified email address.
164 "invitationId": "A String", # Unique identifier for this invitation. Read-only.
165 "studentId": "A String", # ID of the student (in standard format)
166 "creationTime": "A String", # The time that this invitation was created. Read-only.
167 "invitedEmailAddress": "A String", # Email address that the invitation was sent to. This field is only visible to domain administrators.
168 "state": "A String", # The state that this invitation is in.
169 },
170 ],
171 }</pre>
172</div>
173
174<div class="method">
175 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
176 <pre>Retrieves the next page of results.
177
178Args:
179 previous_request: The request for the previous page. (required)
180 previous_response: The response from the request for the previous page. (required)
181
182Returns:
183 A request object that you can call 'execute()' on to request the next
184 page. Returns None if there are no more items in the collection.
185 </pre>
186</div>
187
188<div class="method">
189 <code class="details" id="patch">patch(studentId, invitationId, body, updateMask=None, x__xgafv=None)</code>
190 <pre>Modifies a guardian invitation. Currently, the only valid modification is to change the `state` from `PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if guardians are not enabled for the domain in question or for other access errors. * `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state. * `INVALID_ARGUMENT` if the format of the student ID provided cannot be recognized (it is not an email address, nor a `user_id` from this API), or if the passed `GuardianInvitation` has a `state` other than `COMPLETE`, or if it modifies fields other than `state`. * `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student, or if the `id` field does not refer to a guardian invitation known to Classroom.
191
192Args:
193 studentId: string, The ID of the student whose guardian invitation is to be modified. (required)
194 invitationId: string, The `id` field of the `GuardianInvitation` to be modified. (required)
195 body: object, The request body. (required)
196 The object takes the form of:
197
198{ # An invitation to become the guardian of a specified user, sent to a specified email address.
199 "invitationId": "A String", # Unique identifier for this invitation. Read-only.
200 "studentId": "A String", # ID of the student (in standard format)
201 "creationTime": "A String", # The time that this invitation was created. Read-only.
202 "invitedEmailAddress": "A String", # Email address that the invitation was sent to. This field is only visible to domain administrators.
203 "state": "A String", # The state that this invitation is in.
204 }
205
206 updateMask: string, Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: * `state` When set in a query parameter, this field should be specified as `updateMask=,,...`
207 x__xgafv: string, V1 error format.
208
209Returns:
210 An object of the form:
211
212 { # An invitation to become the guardian of a specified user, sent to a specified email address.
213 "invitationId": "A String", # Unique identifier for this invitation. Read-only.
214 "studentId": "A String", # ID of the student (in standard format)
215 "creationTime": "A String", # The time that this invitation was created. Read-only.
216 "invitedEmailAddress": "A String", # Email address that the invitation was sent to. This field is only visible to domain administrators.
217 "state": "A String", # The state that this invitation is in.
218 }</pre>
219</div>
220
221</body></html>