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.courses.html">courses</a> . <a href="classroom_v1.courses.aliases.html">aliases</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#create">create(courseId, body, x__xgafv=None)</a></code></p>
79<p class="firstline">Creates an alias for a course.</p>
80<p class="toc_element">
81  <code><a href="#delete">delete(courseId, alias, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes an alias of a course.</p>
83<p class="toc_element">
84  <code><a href="#list">list(courseId, pageSize=None, x__xgafv=None, pageToken=None)</a></code></p>
85<p class="firstline">Returns a list of aliases for a course.</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="create">create(courseId, body, x__xgafv=None)</code>
92  <pre>Creates an alias for a course.
93
94This method returns the following error codes:
95
96* `PERMISSION_DENIED` if the requesting user is not permitted to create the
97alias or for access errors.
98* `NOT_FOUND` if the course does not exist.
99* `ALREADY_EXISTS` if the alias already exists.
100* `FAILED_PRECONDITION` if the alias requested does not make sense for the
101  requesting user or course (for example, if a user not in a domain
102  attempts to access a domain-scoped alias).
103
104Args:
105  courseId: string, Identifier of the course to alias.
106This identifier can be either the Classroom-assigned identifier or an
107alias. (required)
108  body: object, The request body. (required)
109    The object takes the form of:
110
111{ # Alternative identifier for a course.
112      #
113      # An alias uniquely identifies a course. It must be unique within one of the
114      # following scopes:
115      #
116      # * domain: A domain-scoped alias is visible to all users within the alias
117      # creator's domain and can be created only by a domain admin. A domain-scoped
118      # alias is often used when a course has an identifier external to Classroom.
119      #
120      # * project: A project-scoped alias is visible to any request from an
121      # application using the Developer Console project ID that created the alias
122      # and can be created by any project. A project-scoped alias is often used when
123      # an application has alternative identifiers. A random value can also be used
124      # to avoid duplicate courses in the event of transmission failures, as retrying
125      # a request will return `ALREADY_EXISTS` if a previous one has succeeded.
126    "alias": "A String", # Alias string. The format of the string indicates the desired alias scoping.
127        #
128        # * `d:<name>` indicates a domain-scoped alias.
129        #   Example: `d:math_101`
130        # * `p:<name>` indicates a project-scoped alias.
131        #   Example: `p:abc123`
132        #
133        # This field has a maximum length of 256 characters.
134  }
135
136  x__xgafv: string, V1 error format.
137    Allowed values
138      1 - v1 error format
139      2 - v2 error format
140
141Returns:
142  An object of the form:
143
144    { # Alternative identifier for a course.
145        #
146        # An alias uniquely identifies a course. It must be unique within one of the
147        # following scopes:
148        #
149        # * domain: A domain-scoped alias is visible to all users within the alias
150        # creator's domain and can be created only by a domain admin. A domain-scoped
151        # alias is often used when a course has an identifier external to Classroom.
152        #
153        # * project: A project-scoped alias is visible to any request from an
154        # application using the Developer Console project ID that created the alias
155        # and can be created by any project. A project-scoped alias is often used when
156        # an application has alternative identifiers. A random value can also be used
157        # to avoid duplicate courses in the event of transmission failures, as retrying
158        # a request will return `ALREADY_EXISTS` if a previous one has succeeded.
159      "alias": "A String", # Alias string. The format of the string indicates the desired alias scoping.
160          #
161          # * `d:<name>` indicates a domain-scoped alias.
162          #   Example: `d:math_101`
163          # * `p:<name>` indicates a project-scoped alias.
164          #   Example: `p:abc123`
165          #
166          # This field has a maximum length of 256 characters.
167    }</pre>
168</div>
169
170<div class="method">
171    <code class="details" id="delete">delete(courseId, alias, x__xgafv=None)</code>
172  <pre>Deletes an alias of a course.
173
174This method returns the following error codes:
175
176* `PERMISSION_DENIED` if the requesting user is not permitted to remove the
177alias or for access errors.
178* `NOT_FOUND` if the alias does not exist.
179* `FAILED_PRECONDITION` if the alias requested does not make sense for the
180  requesting user or course (for example, if a user not in a domain
181  attempts to delete a domain-scoped alias).
182
183Args:
184  courseId: string, Identifier of the course whose alias should be deleted.
185This identifier can be either the Classroom-assigned identifier or an
186alias. (required)
187  alias: string, Alias to delete.
188This may not be the Classroom-assigned identifier. (required)
189  x__xgafv: string, V1 error format.
190    Allowed values
191      1 - v1 error format
192      2 - v2 error format
193
194Returns:
195  An object of the form:
196
197    { # A generic empty message that you can re-use to avoid defining duplicated
198      # empty messages in your APIs. A typical example is to use it as the request
199      # or the response type of an API method. For instance:
200      #
201      #     service Foo {
202      #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
203      #     }
204      #
205      # The JSON representation for `Empty` is empty JSON object `{}`.
206  }</pre>
207</div>
208
209<div class="method">
210    <code class="details" id="list">list(courseId, pageSize=None, x__xgafv=None, pageToken=None)</code>
211  <pre>Returns a list of aliases for a course.
212
213This method returns the following error codes:
214
215* `PERMISSION_DENIED` if the requesting user is not permitted to access the
216course or for access errors.
217* `NOT_FOUND` if the course does not exist.
218
219Args:
220  courseId: string, The identifier of the course.
221This identifier can be either the Classroom-assigned identifier or an
222alias. (required)
223  pageSize: integer, Maximum number of items to return. Zero or unspecified indicates that the
224server may assign a maximum.
225
226The server may return fewer than the specified number of results.
227  x__xgafv: string, V1 error format.
228    Allowed values
229      1 - v1 error format
230      2 - v2 error format
231  pageToken: string, nextPageToken
232value returned from a previous
233list call,
234indicating that the subsequent page of results should be returned.
235
236The list request
237must be otherwise identical to the one that resulted in this token.
238
239Returns:
240  An object of the form:
241
242    { # Response when listing course aliases.
243    "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further
244        # results are available.
245    "aliases": [ # The course aliases.
246      { # Alternative identifier for a course.
247            #
248            # An alias uniquely identifies a course. It must be unique within one of the
249            # following scopes:
250            #
251            # * domain: A domain-scoped alias is visible to all users within the alias
252            # creator's domain and can be created only by a domain admin. A domain-scoped
253            # alias is often used when a course has an identifier external to Classroom.
254            #
255            # * project: A project-scoped alias is visible to any request from an
256            # application using the Developer Console project ID that created the alias
257            # and can be created by any project. A project-scoped alias is often used when
258            # an application has alternative identifiers. A random value can also be used
259            # to avoid duplicate courses in the event of transmission failures, as retrying
260            # a request will return `ALREADY_EXISTS` if a previous one has succeeded.
261          "alias": "A String", # Alias string. The format of the string indicates the desired alias scoping.
262              #
263              # * `d:<name>` indicates a domain-scoped alias.
264              #   Example: `d:math_101`
265              # * `p:<name>` indicates a project-scoped alias.
266              #   Example: `p:abc123`
267              #
268              # This field has a maximum length of 256 characters.
269        },
270    ],
271  }</pre>
272</div>
273
274<div class="method">
275    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
276  <pre>Retrieves the next page of results.
277
278Args:
279  previous_request: The request for the previous page. (required)
280  previous_response: The response from the request for the previous page. (required)
281
282Returns:
283  A request object that you can call 'execute()' on to request the next
284  page. Returns None if there are no more items in the collection.
285    </pre>
286</div>
287
288</body></html>