-
Notifications
You must be signed in to change notification settings - Fork 24
/
Copy pathenrollment_terms.json
304 lines (303 loc) · 10.2 KB
/
enrollment_terms.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
{
"apiVersion": "1.0",
"swaggerVersion": "1.2",
"basePath": "https://canvas.instructure.com/api",
"resourcePath": "/enrollment_terms",
"produces": [
"application/json"
],
"apis": [
{
"path": "/v1/accounts/{account_id}/terms",
"description": "Create a new enrollment term for the specified account.",
"operations": [
{
"method": "POST",
"summary": "Create enrollment term",
"notes": "Create a new enrollment term for the specified account.",
"nickname": "create_enrollment_term",
"parameters": [
{
"paramType": "path",
"name": "account_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "form",
"name": "enrollment_term[name]",
"description": "The name of the term.",
"type": "string",
"format": null,
"required": false
},
{
"paramType": "form",
"name": "enrollment_term[start_at]",
"description": "The day/time the term starts.\nAccepts times in ISO 8601 format, e.g. 2015-01-10T18:48:00Z.",
"type": "DateTime",
"format": null,
"required": false
},
{
"paramType": "form",
"name": "enrollment_term[end_at]",
"description": "The day/time the term ends.\nAccepts times in ISO 8601 format, e.g. 2015-01-10T18:48:00Z.",
"type": "DateTime",
"format": null,
"required": false
},
{
"paramType": "form",
"name": "enrollment_term[sis_term_id]",
"description": "The unique SIS identifier for the term.",
"type": "string",
"format": null,
"required": false
},
{
"paramType": "form",
"name": "enrollment_term[overrides][enrollment_type][start_at]",
"description": "The day/time the term starts, overridden for the given enrollment type.\n*enrollment_type* can be one of StudentEnrollment, TeacherEnrollment, TaEnrollment, or DesignerEnrollment",
"type": "DateTime",
"format": null,
"required": false
},
{
"paramType": "form",
"name": "enrollment_term[overrides][enrollment_type][end_at]",
"description": "The day/time the term ends, overridden for the given enrollment type.\n*enrollment_type* can be one of StudentEnrollment, TeacherEnrollment, TaEnrollment, or DesignerEnrollment",
"type": "DateTime",
"format": null,
"required": false
}
],
"type": "EnrollmentTerm"
}
]
},
{
"path": "/v1/accounts/{account_id}/terms/{id}",
"description": "Update an existing enrollment term for the specified account.",
"operations": [
{
"method": "PUT",
"summary": "Update enrollment term",
"notes": "Update an existing enrollment term for the specified account.",
"nickname": "update_enrollment_term",
"parameters": [
{
"paramType": "path",
"name": "account_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "path",
"name": "id",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "form",
"name": "enrollment_term[name]",
"description": "The name of the term.",
"type": "string",
"format": null,
"required": false
},
{
"paramType": "form",
"name": "enrollment_term[start_at]",
"description": "The day/time the term starts.\nAccepts times in ISO 8601 format, e.g. 2015-01-10T18:48:00Z.",
"type": "DateTime",
"format": null,
"required": false
},
{
"paramType": "form",
"name": "enrollment_term[end_at]",
"description": "The day/time the term ends.\nAccepts times in ISO 8601 format, e.g. 2015-01-10T18:48:00Z.",
"type": "DateTime",
"format": null,
"required": false
},
{
"paramType": "form",
"name": "enrollment_term[sis_term_id]",
"description": "The unique SIS identifier for the term.",
"type": "string",
"format": null,
"required": false
},
{
"paramType": "form",
"name": "enrollment_term[overrides][enrollment_type][start_at]",
"description": "The day/time the term starts, overridden for the given enrollment type.\n*enrollment_type* can be one of StudentEnrollment, TeacherEnrollment, TaEnrollment, or DesignerEnrollment",
"type": "DateTime",
"format": null,
"required": false
},
{
"paramType": "form",
"name": "enrollment_term[overrides][enrollment_type][end_at]",
"description": "The day/time the term ends, overridden for the given enrollment type.\n*enrollment_type* can be one of StudentEnrollment, TeacherEnrollment, TaEnrollment, or DesignerEnrollment",
"type": "DateTime",
"format": null,
"required": false
}
],
"type": "EnrollmentTerm"
}
]
},
{
"path": "/v1/accounts/{account_id}/terms/{id}",
"description": "Delete the specified enrollment term.",
"operations": [
{
"method": "DELETE",
"summary": "Delete enrollment term",
"notes": "Delete the specified enrollment term.",
"nickname": "delete_enrollment_term",
"parameters": [
{
"paramType": "path",
"name": "account_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "path",
"name": "id",
"description": "ID",
"type": "string",
"format": null,
"required": true
}
],
"type": "EnrollmentTerm"
}
]
},
{
"path": "/v1/accounts/{account_id}/terms",
"description": "A paginated list of all of the terms in the account.",
"operations": [
{
"method": "GET",
"summary": "List enrollment terms",
"notes": "A paginated list of all of the terms in the account.",
"nickname": "list_enrollment_terms",
"parameters": [
{
"paramType": "path",
"name": "account_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "query",
"name": "workflow_state",
"description": "If set, only returns terms that are in the given state.\nDefaults to 'active'.",
"type": "array",
"format": null,
"required": false,
"enum": [
"active",
"deleted",
"all"
],
"items": {
"type": "string"
}
},
{
"paramType": "query",
"name": "include",
"description": "Array of additional information to include.\n\n\"overrides\":: term start/end dates overridden for different enrollment types",
"type": "array",
"format": null,
"required": false,
"enum": [
"overrides"
],
"items": {
"type": "string"
}
}
],
"type": "array",
"items": {
"$ref": "EnrollmentTerm"
}
}
]
}
],
"models": {
"EnrollmentTerm": {
"id": "EnrollmentTerm",
"description": "",
"required": [
],
"properties": {
"id": {
"description": "The unique identifier for the enrollment term.",
"example": "1",
"type": "integer"
},
"sis_term_id": {
"description": "The SIS id of the term. Only included if the user has permission to view SIS information.",
"example": "Sp2014",
"type": "string"
},
"sis_import_id": {
"description": "the unique identifier for the SIS import. This field is only included if the user has permission to manage SIS information.",
"example": 34,
"type": "integer"
},
"name": {
"description": "The name of the term.",
"example": "Spring 2014",
"type": "string"
},
"start_at": {
"description": "The datetime of the start of the term.",
"example": "2014-01-06T08:00:00-05:00",
"type": "datetime"
},
"end_at": {
"description": "The datetime of the end of the term.",
"example": "2014-05-16T05:00:00-04:00",
"type": "datetime"
},
"workflow_state": {
"description": "The state of the term. Can be 'active' or 'deleted'.",
"example": "active",
"type": "string"
},
"overrides": {
"description": "Term date overrides for specific enrollment types",
"example": {
"StudentEnrollment": {
"start_at": "2014-01-07T08:00:00-05:00",
"end_at": "2014-05-14T05:00:00-04:0"
}
},
"type": "object"
}
}
}
}
}