Dyr9Hfev

1openapi: 3.0.0
2info:
3  title: Semestry TermTime API
4  description: API for adding objects to TermTime and querying.
5  version: 1.1.203
6  contact:
7      name: TermTime Support
8      url: https://semestry.zendesk.com/
9      email: support@semestry.com
10servers:
11  - url: 'https://hostname/v1/api'
12    description: API URL
13tags: [
14  name: activity templates,
15  name: activity type,
16  name: activity,
17  name: assessment types,
18  name: assessmentperiod,
19  name: booking type,
20  name: building,
21  name: campus,
22  name: capability,
23  name: contact requirement,
24  name: course,
25  name: database,
26  name: department,
27  name: exams,
28  name: exemption,
29  name: floor,
30  name: location,
31  name: module,
32  name: offer,
33  name: optiongroups,
34  name: performance,
35  name: ping,
36  name: repeat group,
37  name: report,
38  name: room booking,
39  name: room,
40  name: schedule,
41  name: staff pool,
42  name: staff,
43  name: student group,
44  name: student,
45  name: timeframe,
46  name: timetable,
47  name: webhook
48]
49paths:
50  /activities:
51    get:
52      summary: Get all Activities
53      description: Return JSON array of all Activities
54      tags: ["activity"]
55      operationId: getActivities
56      parameters:
57        - $ref: '#/components/parameters/activityReady'
58        - $ref: '#/components/parameters/activityMeetingRequired'
59        - $ref: '#/components/parameters/user1FilterParam'
60        - $ref: '#/components/parameters/user2FilterParam'
61        - $ref: '#/components/parameters/user3FilterParam'
62      requestBody:
63        description: >-
64          List of offer/module codes or offer alt codes to filter results by.
65          If offer alt codes ("altc") are provided they are used for filtering,
66          and properties "n" and "m" are ignored. If no "altc" properties are given,
67          the filtering is done using offer names and module codes ("n", "m").
68        required: false
69        content:
70          application/json:
71            schema:
72              $ref: '#/components/schemas/OfferFilterBodyArray'
73      responses:
74        '200':
75          description: A JSON array of Activity objects
76          content:
77            application/json:
78              schema:
79                type: array
80                items:
81                  $ref: '#/components/schemas/ActivityResponse'
82  '/activity/{c}':
83    get:
84      summary: Get one Activity
85      description: Get details for one Activity
86      tags: ["activity"]
87      operationId: getActivityC
88      parameters:
89        - $ref: '#/components/parameters/activityCodeParam'
90        - $ref: '#/components/parameters/useUser2Param'
91      responses:
92        '200':
93          description: An Activity object
94          content:
95            application/json:
96              schema:
97                $ref: '#/components/schemas/ActivityResponse'
98    put:
99      summary: Update a Activity
100      description: Update an existing Activity
101      tags: ["activity"]
102      operationId: putActivityC
103      parameters:
104        - $ref: '#/components/parameters/activityCodeParam'
105        - $ref: '#/components/parameters/activityNameQueryParamOpt'
106        - $ref: '#/components/parameters/activityDurationQueryParamOpt'
107        - $ref: '#/components/parameters/activityWeeksPatternQueryParamOpt'
108        - $ref: '#/components/parameters/activityOfferQueryParamOpt'
109        - $ref: '#/components/parameters/activityTypeQueryParam'
110        - $ref: '#/components/parameters/activityVirtualQueryParamOpt'
111        - $ref: '#/components/parameters/activityMeetingRequiredQueryParamOpt'
112        - $ref: '#/components/parameters/activityPlanSizeQueryParamOpt'
113        - $ref: '#/components/parameters/activityFriendlyNameQueryParam'
114        - $ref: '#/components/parameters/activityUser1QueryParam'
115        - $ref: '#/components/parameters/activityUser2QueryParam'
116        - $ref: '#/components/parameters/activityUser3QueryParam'
117        - $ref: '#/components/parameters/activityUser4QueryParam'
118        - $ref: '#/components/parameters/activityUser5QueryParam'
119        - $ref: '#/components/parameters/activityUser6QueryParam'
120        - $ref: '#/components/parameters/activityUser7QueryParam'
121        - $ref: '#/components/parameters/activityNoPublishStudentQueryParam'
122        - $ref: '#/components/parameters/activityNoPublishStaffQueryParam'
123        - $ref: '#/components/parameters/useUser2Param'
124        - $ref: '#/components/parameters/activitySchedRoomQueryParam'
125        - $ref: '#/components/parameters/activitySchedDayQueryParam'
126        - $ref: '#/components/parameters/activitySchedHourQueryParam'
127        - $ref: '#/components/parameters/activityScheduleQueryParam'
128        - $ref: '#/components/parameters/activityOptInParam'
129        - $ref: '#/components/parameters/activityReadyParam'
130        - $ref: '#/components/parameters/fixedDayParam'
131        - $ref: '#/components/parameters/fixedTimeParam'
132        - $ref: '#/components/parameters/fixedRoomsParam'
133        - $ref: '#/components/parameters/Capabilities2Param'
134      requestBody:
135        description: >-
136          Request body parameters in JSON format <br>
137          Example: {"BodyParamB": "Value1", "BodyParamB": "Value2", ..., etc}
138        required: false
139        content:
140          application/json:
141            schema:
142              $ref: '#/components/schemas/ActivityMeetingUrlBody'
143      responses:
144        '200':
145          description: Success - the Activity was updated
146        '400':
147          $ref: '#/components/responses/BadRequest'
148        '401':
149          $ref: '#/components/responses/Unauthorized'
150        '500':
151          $ref: '#/components/responses/InternalServerError'
152    delete:
153      summary: Delete an Activity
154      description: Delete an Activity
155      tags: ["activity"]
156      operationId: deleteActivityC
157      parameters:
158        - $ref: '#/components/parameters/activityCodeParam'
159        - $ref: '#/components/parameters/useUser2Param'
160      responses:
161        '200':
162          description: Success - the Activity was deleted
163        '400':
164          $ref: '#/components/responses/BadRequest'
165        '401':
166          $ref: '#/components/responses/Unauthorized'
167        '500':
168          $ref: '#/components/responses/InternalServerError'
169  /activity:
170    post:
171      summary: Create an Activity
172      description: Create a new Activity
173      tags: ["activity"]
174      operationId: postActivity
175      parameters:
176        - $ref: '#/components/parameters/activityNameQueryParam'
177        - $ref: '#/components/parameters/activityDurationQueryParam'
178        - $ref: '#/components/parameters/activityWeeksPatternQueryParam'
179        - $ref: '#/components/parameters/activityOfferQueryParam'
180        - $ref: '#/components/parameters/activityTypeQueryParamReq'
181        - $ref: '#/components/parameters/activityVirtualQueryParam'
182        - $ref: '#/components/parameters/activityMeetingRequiredQueryParamOpt'
183        - $ref: '#/components/parameters/activityPlanSizeQueryParam'
184        - $ref: '#/components/parameters/activityFriendlyNameQueryParam'
185        - $ref: '#/components/parameters/activityUser1QueryParam'
186        - $ref: '#/components/parameters/activityUser2QueryParam'
187        - $ref: '#/components/parameters/activityUser3QueryParam'
188        - $ref: '#/components/parameters/activityUser4QueryParam'
189        - $ref: '#/components/parameters/activityUser5QueryParam'
190        - $ref: '#/components/parameters/activityUser6QueryParam'
191        - $ref: '#/components/parameters/activityUser7QueryParam'
192        - $ref: '#/components/parameters/activityNoPublishStudentQueryParam'
193        - $ref: '#/components/parameters/activityNoPublishStaffQueryParam'
194        - $ref: '#/components/parameters/activitySchedRoomQueryParam'
195        - $ref: '#/components/parameters/activitySchedDayQueryParam'
196        - $ref: '#/components/parameters/activitySchedHourQueryParam'
197        - $ref: '#/components/parameters/activityScheduleQueryParam'
198        - $ref: '#/components/parameters/fixedDayParam'
199        - $ref: '#/components/parameters/fixedTimeParam'
200        - $ref: '#/components/parameters/fixedRoomsParam'
201        - $ref: '#/components/parameters/Capabilities2Param'
202      requestBody:
203        description: >-
204          Request body parameters in JSON format <br>
205          Example: {"BodyParamB": "Value1", "BodyParamB": "Value2", ..., etc}
206        required: false
207        content:
208          application/json:
209            schema:
210              $ref: '#/components/schemas/ActivityMeetingUrlBody'
211      responses:
212        '200':
213          $ref: '#/components/responses/OperationSucceededReturnsCodes'
214        '400':
215          $ref: '#/components/responses/BadRequest'
216        '401':
217          $ref: '#/components/responses/Unauthorized'
218        '500':
219          $ref: '#/components/responses/InternalServerError'
220  /ping:
221    get:
222      summary: Ping the API
223      description: A ping request that checks if the API is accessible
224      tags: ["ping"]
225      operationId: getPing
226      responses:
227        '200':
228          description: The ping was successful
229          content:
230            application/json:
231              schema:
232                type: object
233                properties:
234                  ping:
235                    type: number
236                    example: 1
237                  version:
238                    type: string
239                    example: 1.1.145
240                    description: >-
241                      The API specification version, i.e., the version of this document
242                  database:
243                    type: string
244                    example: LondonDemo
245                    description: The name of the database the API is using
246                  user:
247                    type: string
248                    example: UserName
249                    description: The user linked to the API key
250  /students:
251    get:
252      summary: Get the list of all Students
253      description: Return JSON array of students
254      tags: ["student"]
255      operationId: getStudents
256      parameters:
257        - $ref: '#/components/parameters/useOfferAltCodeParam'
258        - $ref: '#/components/parameters/filterByParam'
259        - $ref: '#/components/parameters/filterValueParam'
260      responses:
261        '200':
262          description: A JSON array of Student objects
263          content:
264            application/json:
265              schema:
266                type: array
267                items:
268                  $ref: '#/components/schemas/Student'
269  '/student/{c}':
270    get:
271      summary: Get one Student
272      description: Get details for one Student
273      tags: ["student"]
274      operationId: getStudentC
275      parameters:
276        - $ref: '#/components/parameters/codeParam'
277        - $ref: '#/components/parameters/queryStudentByParam'
278        - $ref: '#/components/parameters/useOfferAltCodeParam'
279      responses:
280        '200':
281          description: A Student object
282          content:
283            application/json:
284              schema:
285                $ref: '#/components/schemas/Student'
286        '400':
287          $ref: '#/components/responses/BadRequest'
288        '401':
289          $ref: '#/components/responses/Unauthorized'
290        '500':
291          $ref: '#/components/responses/InternalServerError'
292    post:
293      summary: Create a new Student
294      description: Create a new student
295      tags: ["student"]
296      operationId: postStudentC
297      parameters:
298        - $ref: '#/components/parameters/codeParam'
299        - $ref: '#/components/parameters/nameParamReq'
300        - $ref: '#/components/parameters/courseCodesParamQuery'
301        - $ref: '#/components/parameters/principalNameParam'
302        - $ref: '#/components/parameters/email1Param'
303        - $ref: '#/components/parameters/email2Param'
304        - $ref: '#/components/parameters/mobParam'
305        - $ref: '#/components/parameters/addressParam'
306        - $ref: '#/components/parameters/capsParam'
307        - $ref: '#/components/parameters/rbDaysAdvanceParam'
308        - $ref: '#/components/parameters/rbHoursPerWeekParam'
309        - $ref: '#/components/parameters/rbHoursPerDayParam'
310        - $ref: '#/components/parameters/rbMaxBookingParam'
311        - $ref: '#/components/parameters/rbMinGapParam'
312        - $ref: '#/components/parameters/rbRoomPoolParam'
313        - $ref: '#/components/parameters/studentSpecialRequirements'
314        - $ref: '#/components/parameters/user1Param'
315        - $ref: '#/components/parameters/user2Param'
316        - $ref: '#/components/parameters/user3Param'
317        - $ref: '#/components/parameters/user4Param'
318        - $ref: '#/components/parameters/user5Param'
319        - $ref: '#/components/parameters/user6Param'
320      responses:
321        '200':
322          $ref: '#/components/responses/OperationSucceeded'
323        '400':
324          $ref: '#/components/responses/BadRequest'
325        '401':
326          $ref: '#/components/responses/Unauthorized'
327        '500':
328          $ref: '#/components/responses/InternalServerError'
329    put:
330      summary: Update an existing Student
331      description: Update an existing Student
332      tags: ["student"]
333      operationId: putStudentC
334      parameters:
335        - $ref: '#/components/parameters/codeParam'
336        - $ref: '#/components/parameters/queryStudentByParam'
337        - $ref: '#/components/parameters/nameParam'
338        - $ref: '#/components/parameters/newIdnParam'
339        - $ref: '#/components/parameters/courseCodesParamQuery'
340        - $ref: '#/components/parameters/offersParamQuery'
341        - $ref: '#/components/parameters/principalNameParam'
342        - $ref: '#/components/parameters/email1Param'
343        - $ref: '#/components/parameters/email2Param'
344        - $ref: '#/components/parameters/mobParam'
345        - $ref: '#/components/parameters/addressParam'
346        - $ref: '#/components/parameters/capsParam'
347        - $ref: '#/components/parameters/rbDaysAdvanceParam'
348        - $ref: '#/components/parameters/rbHoursPerWeekParam'
349        - $ref: '#/components/parameters/rbHoursPerDayParam'
350        - $ref: '#/components/parameters/rbMaxBookingParam'
351        - $ref: '#/components/parameters/rbMinGapParam'
352        - $ref: '#/components/parameters/rbRoomPoolParam'
353        - $ref: '#/components/parameters/studentSpecialRequirements'
354        - $ref: '#/components/parameters/tdParam'
355        - $ref: '#/components/parameters/user1Param'
356        - $ref: '#/components/parameters/user2Param'
357        - $ref: '#/components/parameters/user3Param'
358        - $ref: '#/components/parameters/user4Param'
359        - $ref: '#/components/parameters/user5Param'
360        - $ref: '#/components/parameters/user6Param'
361        - $ref: '#/components/parameters/addOffersParamQuery'
362        - $ref: '#/components/parameters/removeOffersParamQuery'
363      responses:
364        '200':
365          $ref: '#/components/responses/OperationSucceeded'
366        '400':
367          $ref: '#/components/responses/BadRequest'
368        '401':
369          $ref: '#/components/responses/Unauthorized'
370        '500':
371          $ref: '#/components/responses/InternalServerError'
372    delete:
373      summary: Delete a Student
374      description: Delete a Student
375      tags: ["student"]
376      operationId: deleteStudentC
377      parameters:
378        - $ref: '#/components/parameters/codeParam'
379        - $ref: '#/components/parameters/mergeIntoStudentParam'
380        - $ref: '#/components/parameters/softDeleteStudentParam'
381      responses:
382        '200':
383          description: Success - the Student was deleted
384        '400':
385          $ref: '#/components/responses/BadRequest'
386        '401':
387          $ref: '#/components/responses/Unauthorized'
388        '500':
389          $ref: '#/components/responses/InternalServerError'
390  /students/courses:
391    get:
392      summary: Get all Student-Course mappings
393      description: Get all Student-Course mappings
394      tags: ["student"]
395      operationId: getStudentsCourses
396      parameters: []
397      responses:
398        '200':
399          description: A Student-Course mapping object
400          content:
401            application/json:
402              schema:
403                $ref: '#/components/schemas/StudentCourseMapping'
404        '400':
405          $ref: '#/components/responses/BadRequest'
406        '401':
407          $ref: '#/components/responses/Unauthorized'
408        '500':
409          $ref: '#/components/responses/InternalServerError'
410    delete:
411      summary: Delete all Student-Course mappings
412      description: Delete all Student-Course mappings (use with caution!)
413      tags: ["student"]
414      operationId: deleteStudentsCourses
415      parameters: []
416      responses:
417        '200':
418          description: Success - all the Student-Courses mappings were deleted
419        '400':
420          $ref: '#/components/responses/BadRequest'
421        '401':
422          $ref: '#/components/responses/Unauthorized'
423        '500':
424          $ref: '#/components/responses/InternalServerError'
425  /students/offers:
426    get:
427      summary: Get all Student-Offer mappings
428      description: Get all Student-Offer mappings
429      tags: ["student"]
430      operationId: getStudentsOffers
431      parameters: []
432      responses:
433        '200':
434          description: A Student-Offer mapping object
435          content:
436            application/json:
437              schema:
438                $ref: '#/components/schemas/StudentOfferMappings'
439        '400':
440          $ref: '#/components/responses/BadRequest'
441        '401':
442          $ref: '#/components/responses/Unauthorized'
443        '500':
444          $ref: '#/components/responses/InternalServerError'
445    delete:
446      summary: Delete all Student-Offer mappings
447      description: Delete all Student-Offer mappings (use with caution!)
448      tags: ["student"]
449      operationId: deleteStudentsOffers
450      parameters: []
451      responses:
452        '200':
453          description: Success - all the Student-Offer mappings were deleted
454        '400':
455          $ref: '#/components/responses/BadRequest'
456        '401':
457          $ref: '#/components/responses/Unauthorized'
458        '500':
459          $ref: '#/components/responses/InternalServerError'
460  /studentgroups:
461    get:
462      summary: Get all Student Groups
463      description: Get the list of all Student Groups
464      tags: ["student group"]
465      operationId: getStudentgroups
466      parameters:
467        - $ref: '#/components/parameters/useOfferAltCodeParam'
468      responses:
469        '200':
470          description: A JSON array of Student Groups
471          content:
472            application/json:
473              schema:
474                type: array
475                items:
476                  $ref: '#/components/schemas/StudentGroup'
477  '/studentgroup/{gc}':
478    get:
479      summary: Get one Student Group
480      description: Get details for one Student Group
481      tags: ["student group"]
482      operationId: getStudentgroupGC
483      parameters:
484        - $ref: '#/components/parameters/groupCodeParam2'
485        - $ref: '#/components/parameters/useOfferAltCodeParam'
486      responses:
487        '200':
488          description: A Student Group object
489          content:
490            application/json:
491              schema:
492                $ref: '#/components/schemas/StudentGroupWithStudents'
493        '400':
494          $ref: '#/components/responses/BadRequest'
495        '401':
496          $ref: '#/components/responses/Unauthorized'
497        '500':
498          $ref: '#/components/responses/InternalServerError'
499    post:
500      summary: Create a new Student Group
501      description: Create a new Student Group
502      tags: ["student group"]
503      operationId: postStudentgroupGC
504      parameters:
505        - $ref: '#/components/parameters/groupCodeParam2'
506        - $ref: '#/components/parameters/groupNameParamReq'
507        - $ref: '#/components/parameters/courseCodeParamQuery'
508        - $ref: '#/components/parameters/sizeParam'
509      responses:
510        '200':
511          $ref: '#/components/responses/OperationSucceeded'
512        '400':
513          $ref: '#/components/responses/BadRequest'
514        '401':
515          $ref: '#/components/responses/Unauthorized'
516        '500':
517          $ref: '#/components/responses/InternalServerError'
518    put:
519      summary: Update an existing Student Group
520      description: Update an existing Student Group
521      tags: ["student group"]
522      operationId: putStudentgorupGC
523      parameters:
524        - $ref: '#/components/parameters/groupCodeParam2'
525        - $ref: '#/components/parameters/groupNameParam'
526        - $ref: '#/components/parameters/courseCodeParamQuery'
527        - $ref: '#/components/parameters/sizeParam'
528        - $ref: '#/components/parameters/examCodesParamQuery'
529        - $ref: '#/components/parameters/examModeParamQuery'
530      responses:
531        '200':
532          description: Success - the Student Group was created
533        '400':
534          $ref: '#/components/responses/BadRequest'
535        '401':
536          $ref: '#/components/responses/Unauthorized'
537        '500':
538          $ref: '#/components/responses/InternalServerError'
539    delete:
540      summary: Delete a Student Group
541      description: Delete a Student Group
542      tags: ["student group"]
543      operationId: deleteStudentgroupGC
544      parameters:
545        - $ref: '#/components/parameters/groupCodeParam2'
546        - $ref: '#/components/parameters/unlinkLinkedObjects'
547        - $ref: '#/components/parameters/deleteLinkedActivities'
548      responses:
549        '200':
550          description: Success - the Student Group was deleted
551        '400':
552          $ref: '#/components/responses/BadRequest'
553        '401':
554          $ref: '#/components/responses/Unauthorized'
555        '500':
556          $ref: '#/components/responses/InternalServerError'
557  '/studentgroup/{gc}/offer/{o}':
558    get:
559      summary: Get one Student Group-Module Offer mapping
560      description: Get details for one Student Group-Module Offer mapping
561      tags: ["student group"]
562      operationId: getStudentgroupGCOfferO
563      parameters:
564        - $ref: '#/components/parameters/groupCodeParam2'
565        - $ref: '#/components/parameters/offerNameParam'
566        - $ref: '#/components/parameters/moduleCodeQueryParam2'
567        - $ref: '#/components/parameters/useAltCodeParam'
568      responses:
569        '200':
570          description: A Student Group-Module Offer mapping
571          content:
572            application/json:
573              schema:
574                $ref: '#/components/schemas/StudentGroupOfferMapping'
575        '400':
576          $ref: '#/components/responses/BadRequest'
577        '401':
578          $ref: '#/components/responses/Unauthorized'
579        '500':
580          $ref: '#/components/responses/InternalServerError'
581    post:
582      summary: Put Student Group into Offer
583      description: Put the identified Student Group into the identified Offer
584      tags: ["student group"]
585      operationId: postStudentgroupGCOfferO
586      parameters:
587        - $ref: '#/components/parameters/groupCodeParam2'
588        - $ref: '#/components/parameters/offerNameParam'
589        - $ref: '#/components/parameters/moduleCodeQueryParam2'
590        - $ref: '#/components/parameters/useAltCodeParam'
591      requestBody:
592        description: >-
593          Request body parameters in JSON format <br>
594          Example: {"BodyParamB": "Value1", "BodyParamB": "Value2", ..., etc}
595        required: false
596        content:
597          application/json:
598            schema:
599              $ref: '#/components/schemas/GroupOfferUrlBody'
600      responses:
601        '200':
602          $ref: '#/components/responses/OperationSucceeded'
603        '400':
604          $ref: '#/components/responses/BadRequest'
605        '401':
606          $ref: '#/components/responses/Unauthorized'
607        '500':
608          $ref: '#/components/responses/InternalServerError'
609    put:
610      summary: Update a student group to offer mapping
611      description: Update a student group to offer mapping
612      tags: ["student group"]
613      operationId: putStudentgroupGCOfferO
614      parameters:
615        - $ref: '#/components/parameters/groupCodeParam2'
616        - $ref: '#/components/parameters/offerNameParam'
617        - $ref: '#/components/parameters/moduleCodeQueryParam2'
618        - $ref: '#/components/parameters/useAltCodeParam'
619      requestBody:
620        description: >-
621          Request body parameters in JSON format <br>
622          Example: {"BodyParamB": "Value1", "BodyParamB": "Value2", ..., etc}
623        required: false
624        content:
625          application/json:
626            schema:
627              $ref: '#/components/schemas/GroupOfferUrlBody'
628      responses:
629        '200':
630          $ref: '#/components/responses/OperationSucceeded'
631        '400':
632          $ref: '#/components/responses/BadRequest'
633        '401':
634          $ref: '#/components/responses/Unauthorized'
635        '500':
636          $ref: '#/components/responses/InternalServerError'
637    delete:
638      summary: Delete Student Group from Offer
639      description: Take the identified Student Group out of the identified Offer
640      tags: ["student group"]
641      operationId: deleteStudentgroupGCOfferO
642      parameters:
643        - $ref: '#/components/parameters/groupCodeParam2'
644        - $ref: '#/components/parameters/offerNameParam'
645        - $ref: '#/components/parameters/moduleCodeQueryParam2'
646        - $ref: '#/components/parameters/useAltCodeParam'
647      responses:
648        '200':
649          description: Success - the student was removed from the Offer
650        '400':
651          $ref: '#/components/responses/BadRequest'
652        '401':
653          $ref: '#/components/responses/Unauthorized'
654        '500':
655          $ref: '#/components/responses/InternalServerError'
656  /studentgroupmaps:
657    get:
658      summary: Get all Student-Group mappings
659      description: Get the list of all Student-Group mappings
660      tags: ["student group"]
661      operationId: getStudentgroupmaps
662      responses:
663        '200':
664          description: A JSON array of Student-Group mappings
665          content:
666            application/json:
667              schema:
668                type: array
669                items:
670                  $ref: '#/components/schemas/StudentGroupMap'
671  /studentgroup/{gc}/activity/{c}:
672    get:
673      summary: Get one Student Group-Activity mapping
674      description: Get details for one Student Group-Activity mapping
675      tags: ["student group"]
676      operationId: getStudentgroupGCActivityC
677      parameters:
678        - $ref: '#/components/parameters/groupCodeParam2'
679        - $ref: '#/components/parameters/activityCodeParam'
680        - $ref: '#/components/parameters/useUser2Param'
681        - $ref: '#/components/parameters/useExamCodeParam'
682      responses:
683        '200':
684          description: A Student Group-Activity mapping
685          content:
686            application/json:
687              schema:
688                $ref: '#/components/schemas/StudentGroupActivityMapping'
689        '400':
690          $ref: '#/components/responses/BadRequest'
691        '401':
692          $ref: '#/components/responses/Unauthorized'
693        '500':
694          $ref: '#/components/responses/InternalServerError'
695    post:
696      summary: Put a Student Group into an Activity
697      description: Put the identified Student Group into the identified Activity
698      tags: ["student group"]
699      operationId: postStudentgroupGCActivityC
700      parameters:
701        - $ref: '#/components/parameters/groupCodeParam2'
702        - $ref: '#/components/parameters/activityCodeParam'
703        - $ref: '#/components/parameters/useUser2Param'
704      responses:
705        '200':
706          $ref: '#/components/responses/OperationSucceeded'
707        '400':
708          $ref: '#/components/responses/BadRequest'
709        '401':
710          $ref: '#/components/responses/Unauthorized'
711        '500':
712          $ref: '#/components/responses/InternalServerError'
713    delete:
714      summary: Delete a Student Group from an Activity
715      description: Take the identified Student Group out of the identified Activity
716      tags: ["student group"]
717      operationId: deleteStudentgroupGCActivityC
718      parameters:
719        - $ref: '#/components/parameters/groupCodeParam2'
720        - $ref: '#/components/parameters/activityCodeParam'
721        - $ref: '#/components/parameters/useUser2Param'
722      responses:
723        '200':
724          description: Success - the student was removed from the Activity
725        '400':
726          $ref: '#/components/responses/BadRequest'
727        '401':
728          $ref: '#/components/responses/Unauthorized'
729        '500':
730          $ref: '#/components/responses/InternalServerError'
731  /student/{s}/group/{g}:
732    post:
733      summary: Put a Student into a Group
734      description: Put the identified Student into the identified Group
735      tags: ["student"]
736      operationId: postStudentSGroupG
737      parameters:
738        - $ref: '#/components/parameters/studentCodeParam'
739        - $ref: '#/components/parameters/groupCodeParam'
740      responses:
741        '200':
742          $ref: '#/components/responses/OperationSucceeded'
743        '400':
744          $ref: '#/components/responses/BadRequest'
745        '401':
746          $ref: '#/components/responses/Unauthorized'
747        '500':
748          $ref: '#/components/responses/InternalServerError'
749    delete:
750      summary: Delete a Student from a Group
751      description: Take the identified Student out of the identified Group
752      tags: ["student"]
753      operationId: deleteStudentSGroupG
754      parameters:
755        - $ref: '#/components/parameters/studentCodeParam'
756        - $ref: '#/components/parameters/groupCodeParam'
757      responses:
758        '200':
759          description: Success - the student was removed from the group
760        '400':
761          $ref: '#/components/responses/BadRequest'
762        '401':
763          $ref: '#/components/responses/Unauthorized'
764        '500':
765          $ref: '#/components/responses/InternalServerError'
766  /student/{s}/offer/{o}:
767    get:
768      summary: Get one Student-Offer mapping
769      description: Get details for one Student-Offer mapping
770      tags: ["student"]
771      operationId: getStudentSOfferO
772      parameters:
773        - $ref: '#/components/parameters/studentCodeParam'
774        - $ref: '#/components/parameters/offerNameParam'
775        - $ref: '#/components/parameters/moduleCodeQueryParam2'
776        - $ref: '#/components/parameters/useAltCodeParam'
777      responses:
778        '200':
779          description: A Student-Offer mapping object
780          content:
781            application/json:
782              schema:
783                $ref: '#/components/schemas/StudentOfferMapping'
784        '400':
785          $ref: '#/components/responses/BadRequest'
786        '401':
787          $ref: '#/components/responses/Unauthorized'
788        '500':
789          $ref: '#/components/responses/InternalServerError'
790    post:
791      summary: Put a Student into an Offer
792      description: Put the identified Student into the identified Offer
793      tags: ["student"]
794      operationId: postStudentSOfferO
795      parameters:
796        - $ref: '#/components/parameters/studentCodeParam'
797        - $ref: '#/components/parameters/offerNameParam'
798        - $ref: '#/components/parameters/moduleCodeQueryParam2'
799        - $ref: '#/components/parameters/useAltCodeParam'
800        - $ref: '#/components/parameters/studentOfferMapType'
801      responses:
802        '200':
803          $ref: '#/components/responses/OperationSucceeded'
804        '400':
805          $ref: '#/components/responses/BadRequest'
806        '401':
807          $ref: '#/components/responses/Unauthorized'
808        '500':
809          $ref: '#/components/responses/InternalServerError'
810    delete:
811      summary: Delete a Student from an Offer
812      description: >-
813        Delete the specified type of mapping between the specified Student and the specified Offer.
814        If the type of mapping is not specified, assume the type of mapping is 'DEF'.
815      tags: ["student"]
816      operationId: deleteStudentSOfferO
817      parameters:
818        - $ref: '#/components/parameters/studentCodeParam'
819        - $ref: '#/components/parameters/offerNameParam'
820        - $ref: '#/components/parameters/moduleCodeQueryParam2'
821        - $ref: '#/components/parameters/useAltCodeParam'
822        - $ref: '#/components/parameters/studentOfferMapType'
823      responses:
824        '200':
825          description: Success - the student was removed from the Offer
826        '400':
827          $ref: '#/components/responses/BadRequest'
828        '401':
829          $ref: '#/components/responses/Unauthorized'
830        '500':
831          $ref: '#/components/responses/InternalServerError'
832  /student/{s}/course/{cc}:
833    delete:
834      summary: Delete one Student-Course mapping
835      description: Delete one Student-Course mapping
836      tags:
837        - student
838      operationId: deleteStudentSCourseCC
839      parameters:
840        - $ref: '#/components/parameters/studentCodeParam'
841        - $ref: '#/components/parameters/courseCodeParamPath'
842      responses:
843        '200':
844          description: Success - The Student-Course mapping was deleted
845        '400':
846          $ref: '#/components/responses/BadRequest'
847        '401':
848          $ref: '#/components/responses/Unauthorized'
849        '500':
850          $ref: '#/components/responses/InternalServerError'
851  /staff:
852    get:
853      summary: Get all Staff
854      description: Return JSON array of all Staff members
855      tags: ["staff"]
856      operationId: getStaff
857      parameters:
858        - $ref: '#/components/parameters/useOfferAltCodeParam'
859        - $ref: '#/components/parameters/filterByParam'
860        - $ref: '#/components/parameters/filterValueParam'
861      responses:
862        '200':
863          description: A JSON array of Staff objects
864          content:
865            application/json:
866              schema:
867                type: array
868                items:
869                  $ref: '#/components/schemas/Staff'
870        '400':
871          $ref: '#/components/responses/BadRequest'
872        '401':
873          $ref: '#/components/responses/Unauthorized'
874        '500':
875          $ref: '#/components/responses/InternalServerError'
876  '/staff/{c}':
877    get:
878      summary: Get one Staff
879      description: Return object of staff details.
880      tags: ["staff"]
881      operationId: getStaffC
882      parameters:
883        - $ref: '#/components/parameters/staffCodeParam'
884        - $ref: '#/components/parameters/useAltCodeParam'
885      responses:
886        '200':
887          description: A Staff object
888          content:
889            application/json:
890              schema:
891                $ref: '#/components/schemas/Staff'
892        '400':
893          $ref: '#/components/responses/BadRequest'
894        '401':
895          $ref: '#/components/responses/Unauthorized'
896        '500':
897          $ref: '#/components/responses/InternalServerError'
898    post:
899      summary: Create a new Staff
900      description: Create member of staff with parameters in the query.
901      tags: ["staff"]
902      operationId: postStaffC
903      parameters:
904        - $ref: '#/components/parameters/staffCodeParam'
905        - $ref: '#/components/parameters/staffAltCodeParam'
906        - $ref: '#/components/parameters/nameParamReq'
907        - $ref: '#/components/parameters/principalNameParam'
908        - $ref: '#/components/parameters/email1Param'
909        - $ref: '#/components/parameters/email2Param'
910        - $ref: '#/components/parameters/mobParam'
911        - $ref: '#/components/parameters/departmentCodeParamReq'
912        - $ref: '#/components/parameters/nominalHoursParam'
913        - $ref: '#/components/parameters/nominalHoursAdjustParam'
914        - $ref: '#/components/parameters/rbDaysAdvanceParam'
915        - $ref: '#/components/parameters/rbHoursPerWeekParam'
916        - $ref: '#/components/parameters/rbHoursPerDayParam'
917        - $ref: '#/components/parameters/rbMaxBookingParam'
918        - $ref: '#/components/parameters/rbMinGapParam'
919        - $ref: '#/components/parameters/rbRoomPoolParam'
920        - $ref: '#/components/parameters/isAlsoStudentParam'
921        - $ref: '#/components/parameters/rolesParam'
922        - $ref: '#/components/parameters/staffGroupsParam'
923        - $ref: '#/components/parameters/user1Param'
924        - $ref: '#/components/parameters/user2Param'
925        - $ref: '#/components/parameters/user3Param'
926        - $ref: '#/components/parameters/user4Param'
927        - $ref: '#/components/parameters/user5Param'
928      responses:
929        '200':
930          $ref: '#/components/responses/OperationSucceeded'
931        '400':
932          $ref: '#/components/responses/BadRequest'
933        '401':
934          $ref: '#/components/responses/Unauthorized'
935        '500':
936          $ref: '#/components/responses/InternalServerError'
937    put:
938      summary: Update Staff member
939      description: Update the details of an existing staff member
940      tags: ["staff"]
941      operationId: putStaffC
942      parameters:
943        - $ref: '#/components/parameters/staffCodeParam'
944        - $ref: '#/components/parameters/useAltCodeParam'
945        - $ref: '#/components/parameters/staffAltCodeParam'
946        - $ref: '#/components/parameters/nameParam'
947        - $ref: '#/components/parameters/principalNameParam'
948        - $ref: '#/components/parameters/email1Param'
949        - $ref: '#/components/parameters/email2Param'
950        - $ref: '#/components/parameters/mobParam'
951        - $ref: '#/components/parameters/departmentCodeParam'
952        - $ref: '#/components/parameters/nominalHoursParam'
953        - $ref: '#/components/parameters/nominalHoursAdjustParam'
954        - $ref: '#/components/parameters/rbDaysAdvanceParam'
955        - $ref: '#/components/parameters/rbHoursPerWeekParam'
956        - $ref: '#/components/parameters/rbHoursPerDayParam'
957        - $ref: '#/components/parameters/rbMaxBookingParam'
958        - $ref: '#/components/parameters/rbMinGapParam'
959        - $ref: '#/components/parameters/rbRoomPoolParam'
960        - $ref: '#/components/parameters/isAlsoStudentParam'
961        - $ref: '#/components/parameters/tdParam'
962        - $ref: '#/components/parameters/newStaffCodeParam'
963        - $ref: '#/components/parameters/rolesParam'
964        - $ref: '#/components/parameters/staffGroupsParam'
965        - $ref: '#/components/parameters/user1Param'
966        - $ref: '#/components/parameters/user2Param'
967        - $ref: '#/components/parameters/user3Param'
968        - $ref: '#/components/parameters/user4Param'
969        - $ref: '#/components/parameters/user5Param'
970      responses:
971        '200':
972          description: Success - the Staff was updated
973    delete:
974      summary: Delete Staff member
975      description: Delete a member of the staff
976      tags: ["staff"]
977      operationId: deleteStaffC
978      parameters:
979        - $ref: '#/components/parameters/staffCodeParam'
980        - $ref: '#/components/parameters/useAltCodeParam'
981        - $ref: '#/components/parameters/softDeleteStaffParam'
982      responses:
983        '200':
984          description: Success - the Staff was deleted
985        '400':
986          $ref: '#/components/responses/BadRequest'
987        '401':
988          $ref: '#/components/responses/Unauthorized'
989        '500':
990          $ref: '#/components/responses/InternalServerError'
991  '/staff/{c}/activity/{ac}':
992    post:
993      summary: Add Staff member to Activity
994      description: Associate the identified Staff with the identified Activity using the specified Role
995      tags: ["staff"]
996      operationId: postStaffCActivityAC
997      parameters:
998        - $ref: '#/components/parameters/staffCodeParam'
999        - $ref: '#/components/parameters/activityCodeParam2'
1000        - $ref: '#/components/parameters/useAltCodeParam'
1001        - $ref: '#/components/parameters/useUser2Param'
1002        - $ref: '#/components/parameters/roleCodeParam'
1003      responses:
1004        '200':
1005          $ref: '#/components/responses/OperationSucceeded'
1006        '400':
1007          $ref: '#/components/responses/BadRequest'
1008        '401':
1009          $ref: '#/components/responses/Unauthorized'
1010        '500':
1011          $ref: '#/components/responses/InternalServerError'
1012    delete:
1013      summary: Delete Staff member from Activity
1014      description: Disassociate the identified Staff from the identified Activity
1015      tags: ["staff"]
1016      operationId: deleteStaffCActivityAC
1017      parameters:
1018        - $ref: '#/components/parameters/staffCodeParam'
1019        - $ref: '#/components/parameters/activityCodeParam2'
1020        - $ref: '#/components/parameters/useAltCodeParam'
1021        - $ref: '#/components/parameters/useUser2Param'
1022      responses:
1023        '200':
1024          description: Success - the Staff and Activity were disassociated
1025        '400':
1026          $ref: '#/components/responses/BadRequest'
1027        '401':
1028          $ref: '#/components/responses/Unauthorized'
1029        '500':
1030          $ref: '#/components/responses/InternalServerError'
1031  /courses:
1032    get:
1033      summary: Get all Courses
1034      description: Return JSON array of all Courses
1035      tags: ["course"]
1036      operationId: getCourses
1037      parameters:
1038        - $ref: '#/components/parameters/useOfferAltCodeParam'
1039      responses:
1040        '200':
1041          description: A JSON array of Course objects
1042          content:
1043            application/json:
1044              schema:
1045                type: array
1046                items:
1047                  $ref: '#/components/schemas/Course'
1048        '400':
1049          $ref: '#/components/responses/BadRequest'
1050        '401':
1051          $ref: '#/components/responses/Unauthorized'
1052        '500':
1053          $ref: '#/components/responses/InternalServerError'
1054  '/course/{cc}':
1055    get:
1056      summary: Get one Course
1057      description: Return object of Course details.
1058      tags: ["course"]
1059      operationId: getCourseCC
1060      parameters:
1061        - $ref: '#/components/parameters/courseCodeParamPath'
1062        - $ref: '#/components/parameters/useAltCodeParam'
1063        - $ref: '#/components/parameters/useOfferAltCodeParam'
1064      responses:
1065        '200':
1066          description: A Course object
1067          content:
1068            application/json:
1069              schema:
1070                $ref: '#/components/schemas/Course'
1071        '400':
1072          $ref: '#/components/responses/BadRequest'
1073        '401':
1074          $ref: '#/components/responses/Unauthorized'
1075        '500':
1076          $ref: '#/components/responses/InternalServerError'
1077    post:
1078      summary: Create a new Course
1079      description: Create Course with parameters in the query.
1080      tags: ["course"]
1081      operationId: postCourseCC
1082      parameters:
1083        - $ref: '#/components/parameters/courseCodeParamPath'
1084        - $ref: '#/components/parameters/nameParamReq'
1085        - $ref: '#/components/parameters/departmentCodeParamReq'
1086        - $ref: '#/components/parameters/levelParam'
1087        - $ref: '#/components/parameters/ownerParam'
1088        - $ref: '#/components/parameters/mincParam'
1089        - $ref: '#/components/parameters/maxcParam'
1090        - $ref: '#/components/parameters/moCoreParam'
1091        - $ref: '#/components/parameters/moOptionParam'
1092        - $ref: '#/components/parameters/user1ParamLong'
1093        - $ref: '#/components/parameters/user2Param'
1094        - $ref: '#/components/parameters/courseAltCodeParam'
1095        - $ref: '#/components/parameters/showFullCourseParam'
1096        - $ref: '#/components/parameters/useCoreOptionModulesParam'
1097        - $ref: '#/components/parameters/createGroupParam'
1098        - $ref: '#/components/parameters/toDeleteParam'
1099        - $ref: '#/components/parameters/courseDescriptionParam'
1100        - $ref: '#/components/parameters/plansizeParam'
1101        - $ref: '#/components/parameters/postCourseTagsParam'
1102      responses:
1103        '200':
1104          $ref: '#/components/responses/OperationSucceeded'
1105        '400':
1106          $ref: '#/components/responses/BadRequest'
1107        '401':
1108          $ref: '#/components/responses/Unauthorized'
1109        '500':
1110          $ref: '#/components/responses/InternalServerError'
1111    put:
1112      summary: Update a Course
1113      description: Update an existing Course
1114      tags: ["course"]
1115      operationId: putCourseCC
1116      parameters:
1117        - $ref: '#/components/parameters/courseCodeParamPath'
1118        - $ref: '#/components/parameters/nameParam'
1119        - $ref: '#/components/parameters/departmentCodeParam'
1120        - $ref: '#/components/parameters/levelParam'
1121        - $ref: '#/components/parameters/ownerParam'
1122        - $ref: '#/components/parameters/mincParam'
1123        - $ref: '#/components/parameters/maxcParam'
1124        - $ref: '#/components/parameters/moCoreParam'
1125        - $ref: '#/components/parameters/moOptionParam'
1126        - $ref: '#/components/parameters/user1ParamLong'
1127        - $ref: '#/components/parameters/user2Param'
1128        - $ref: '#/components/parameters/useAltCodeParam'
1129        - $ref: '#/components/parameters/courseAltCodeParam'
1130        - $ref: '#/components/parameters/courseCodeQueryParam'
1131        - $ref: '#/components/parameters/showFullCourseParam'
1132        - $ref: '#/components/parameters/useCoreOptionModulesParam'
1133        - $ref: '#/components/parameters/toDeleteParam'
1134        - $ref: '#/components/parameters/courseDescriptionParam'
1135        - $ref: '#/components/parameters/plansizeParam'
1136      responses:
1137        '200':
1138          description: Success - the Course was updated
1139        '400':
1140          $ref: '#/components/responses/BadRequest'
1141        '401':
1142          $ref: '#/components/responses/Unauthorized'
1143        '500':
1144          $ref: '#/components/responses/InternalServerError'
1145    delete:
1146      summary: Delete a Course
1147      description: Deletes a course and all maps related to the course
1148      tags: ["course"]
1149      operationId: deleteCourseCC
1150      parameters:
1151        - $ref: '#/components/parameters/courseCodeParamPath'
1152        - $ref: '#/components/parameters/useAltCodeParam'
1153      responses:
1154        '200':
1155          description: Success - the Course was deleted
1156        '400':
1157          $ref: '#/components/responses/BadRequest'
1158        '401':
1159          $ref: '#/components/responses/Unauthorized'
1160        '500':
1161          $ref: '#/components/responses/InternalServerError'
1162  /course/{cc}/offer/{o}:
1163    delete:
1164      summary: Delete one Course-Offer mapping
1165      description: Delete one Course-Offer mapping
1166      operationId: deleteCourseCCOfferO
1167      tags: ["course"]
1168      parameters:
1169        - $ref: '#/components/parameters/courseCodeParamPath'
1170        - $ref: '#/components/parameters/offerNameParam'
1171        - $ref: '#/components/parameters/moduleCodeParamReq'
1172      responses:
1173        '200':
1174          description: Success - all the Course-Offer mapping was deleted
1175        '400':
1176          $ref: '#/components/responses/BadRequest'
1177        '401':
1178          $ref: '#/components/responses/Unauthorized'
1179        '500':
1180          $ref: '#/components/responses/InternalServerError'
1181  /courses/offers:
1182    get:
1183      summary: Get all Course-Offer mappings
1184      description: Get all Course-Offer mappings
1185      tags: ["course"]
1186      operationId: getCoursesOffers
1187      parameters: []
1188      responses:
1189        '200':
1190          description: A Course-Offer mapping object
1191          content:
1192            application/json:
1193              schema:
1194                $ref: '#/components/schemas/CourseOfferMapping'
1195        '400':
1196          $ref: '#/components/responses/BadRequest'
1197        '401':
1198          $ref: '#/components/responses/Unauthorized'
1199        '500':
1200          $ref: '#/components/responses/InternalServerError'
1201    delete:
1202      summary: Delete all Course-Offer mappings
1203      description: Delete all Course-Offer mappings (use with caution!)
1204      tags: ["course"]
1205      operationId: deleteCoursesOffers
1206      parameters: []
1207      responses:
1208        '200':
1209          description: Success - all the Course-Offer mappings were deleted
1210        '400':
1211          $ref: '#/components/responses/BadRequest'
1212        '401':
1213          $ref: '#/components/responses/Unauthorized'
1214        '500':
1215          $ref: '#/components/responses/InternalServerError'
1216  /modules:
1217    get:
1218      summary: Get all Modules
1219      description: Return json array of all Modules
1220      tags: ["module"]
1221      operationId: getModules
1222      responses:
1223        '200':
1224          description: A JSON array of Module objects
1225          content:
1226            application/json:
1227              schema:
1228                type: array
1229                items:
1230                  $ref: '#/components/schemas/Module'
1231        '400':
1232          $ref: '#/components/responses/BadRequest'
1233        '401':
1234          $ref: '#/components/responses/Unauthorized'
1235        '500':
1236          $ref: '#/components/responses/InternalServerError'
1237  '/module/{c}':
1238    get:
1239      summary: Get one Module
1240      description: Return object of module details.
1241      tags: ["module"]
1242      operationId: getModuleC
1243      parameters:
1244        - $ref: '#/components/parameters/moduleCodeParam'
1245        - $ref: '#/components/parameters/useAltCodeParam'
1246      responses:
1247        '200':
1248          description: A Module object
1249          content:
1250            application/json:
1251              schema:
1252                $ref: '#/components/schemas/Module'
1253        '400':
1254          $ref: '#/components/responses/BadRequest'
1255        '401':
1256          $ref: '#/components/responses/Unauthorized'
1257        '500':
1258          $ref: '#/components/responses/InternalServerError'
1259    post:
1260      summary: Create a new Module
1261      description: Create a new Module
1262      tags: ["module"]
1263      operationId: postModuleC
1264      parameters:
1265        - $ref: '#/components/parameters/moduleCodeParam'
1266        - $ref: '#/components/parameters/moduleNameParamReq'
1267        - $ref: '#/components/parameters/departmentCodeParamReq'
1268        - $ref: '#/components/parameters/creditsParam'
1269        - $ref: '#/components/parameters/ownerParam'
1270        - $ref: '#/components/parameters/user1ParamLong'
1271        - $ref: '#/components/parameters/user2ParamLong'
1272        - $ref: '#/components/parameters/useAltCodeParam'
1273        - $ref: '#/components/parameters/moduleAltCodeParam'
1274        - $ref: '#/components/parameters/moduleCodeQueryParam'
1275        - $ref: '#/components/parameters/moduleDescriptionParam'
1276        - $ref: '#/components/parameters/moduleStaffRightsParam'
1277      responses:
1278        '200':
1279          $ref: '#/components/responses/OperationSucceeded'
1280        '400':
1281          $ref: '#/components/responses/BadRequest'
1282        '401':
1283          $ref: '#/components/responses/Unauthorized'
1284        '500':
1285          $ref: '#/components/responses/InternalServerError'
1286    put:
1287      summary: Update an existing Module
1288      description: Update an existing Module
1289      tags: ["module"]
1290      operationId: putModuleC
1291      parameters:
1292        - $ref: '#/components/parameters/moduleCodeParam'
1293        - $ref: '#/components/parameters/moduleNameParam'
1294        - $ref: '#/components/parameters/departmentCodeParam'
1295        - $ref: '#/components/parameters/creditsParam'
1296        - $ref: '#/components/parameters/ownerParam'
1297        - $ref: '#/components/parameters/user1ParamLong'
1298        - $ref: '#/components/parameters/user2ParamLong'
1299        - $ref: '#/components/parameters/useAltCodeParam'
1300        - $ref: '#/components/parameters/moduleAltCodeParam'
1301        - $ref: '#/components/parameters/moduleCodeQueryParam'
1302        - $ref: '#/components/parameters/moduleDescriptionParam'
1303        - $ref: '#/components/parameters/toDeleteParam'
1304        - $ref: '#/components/parameters/moduleStaffRightsParam'
1305      responses:
1306        '200':
1307          description: Success - the Module was updated
1308        '400':
1309          $ref: '#/components/responses/BadRequest'
1310        '401':
1311          $ref: '#/components/responses/Unauthorized'
1312        '500':
1313          $ref: '#/components/responses/InternalServerError'
1314    delete:
1315      summary: Delete a Module
1316      description: >-
1317        Deletes a Module and all maps related to the module. Deletion
1318        is prevented with an HTTP code 400 server response, if there are module
1319        offers attached to the module.
1320      tags: ["module"]
1321      operationId: deleteModuleC
1322      parameters:
1323        - $ref: '#/components/parameters/moduleCodeParam'
1324        - $ref: '#/components/parameters/useAltCodeParam'
1325      responses:
1326        '200':
1327          description: Success - the Module was deleted
1328        '400':
1329          $ref: '#/components/responses/BadRequest'
1330        '401':
1331          $ref: '#/components/responses/Unauthorized'
1332        '500':
1333          $ref: '#/components/responses/InternalServerError'
1334  /offers:
1335    get:
1336      summary: Get all Offers
1337      description: Return JSON array of Offer objects
1338      tags: ["offer"]
1339      operationId: getOffers
1340      parameters:
1341        - $ref: '#/components/parameters/offerQueryTimeframeCodes'
1342      requestBody:
1343        description: >-
1344          List of offer/module codes or offer alt codes to filter results by.
1345          If offer alt codes ("altc") are provided they are used for filtering,
1346          and properties "n" and "m" are ignored. If no "altc" properties are given,
1347          the filtering is done using offer names and module codes ("n", "m").
1348        required: false
1349        content:
1350          application/json:
1351            schema:
1352              $ref: '#/components/schemas/OfferFilterBodyArray'
1353      responses:
1354        '200':
1355          description: A JSON array of Offers
1356          content:
1357            application/json:
1358              schema:
1359                type: array
1360                items:
1361                  $ref: '#/components/schemas/Offer'
1362  '/offer/{n}':
1363    get:
1364      summary: Get one Offer
1365      description: Get details for one Offer
1366      tags: ["offer"]
1367      operationId: getOfferN
1368      parameters:
1369        - $ref: '#/components/parameters/offerNameParamReq'
1370        - $ref: '#/components/parameters/moduleCodeQueryParam'
1371        - $ref: '#/components/parameters/useAltCodeParam'
1372      responses:
1373        '200':
1374          description: An Offer object
1375          content:
1376            application/json:
1377              schema:
1378                $ref: '#/components/schemas/Offer'
1379        '400':
1380          $ref: '#/components/responses/BadRequest'
1381        '401':
1382          $ref: '#/components/responses/Unauthorized'
1383        '500':
1384          $ref: '#/components/responses/InternalServerError'
1385    post:
1386      summary: Create a new Offer
1387      description: Create a new Offer
1388      tags: ["offer"]
1389      operationId: postOfferN
1390      parameters:
1391        - $ref: '#/components/parameters/offerNameParamReq'
1392        - $ref: '#/components/parameters/offerNeedsNoTeaching'
1393        - $ref: '#/components/parameters/moduleCodeParamReq'
1394        - $ref: '#/components/parameters/timeframeCodeParamReq'
1395        - $ref: '#/components/parameters/ownerParam'
1396        - $ref: '#/components/parameters/daytemplateNameParam'
1397        - $ref: '#/components/parameters/runningParamReq'
1398        - $ref: '#/components/parameters/createActivitiesFromTemplateParamReq'
1399        - $ref: '#/components/parameters/plansizeParam'
1400        - $ref: '#/components/parameters/offerAltCodeParam'
1401        - $ref: '#/components/parameters/locationCodeParam'
1402        - $ref: '#/components/parameters/useModuleAltCodeParam'
1403        - $ref: '#/components/parameters/user1Param'
1404        - $ref: '#/components/parameters/user2Param'
1405      requestBody:
1406        description: >-
1407          Request body parameters in JSON format <br>
1408          Example: {"BodyParamB": "Value1", "BodyParamB": "Value2", ..., etc}
1409        required: false
1410        content:
1411          application/json:
1412            schema:
1413              $ref: '#/components/schemas/OfferUrlBody'
1414      responses:
1415        '200':
1416          $ref: '#/components/responses/OperationSucceeded'
1417        '400':
1418          $ref: '#/components/responses/BadRequest'
1419        '401':
1420          $ref: '#/components/responses/Unauthorized'
1421        '500':
1422          $ref: '#/components/responses/InternalServerError'
1423    put:
1424      summary: Update an Offer
1425      description: Update an existing Offer
1426      tags: ["offer"]
1427      operationId: putOfferN
1428      parameters:
1429        - $ref: '#/components/parameters/offerNameOrAltCodeParamReq'
1430        - $ref: '#/components/parameters/moduleCodeQueryParam2'
1431        - $ref: '#/components/parameters/timeframeCodeParam'
1432        - $ref: '#/components/parameters/offerNeedsNoTeaching'
1433        - $ref: '#/components/parameters/ownerParam'
1434        - $ref: '#/components/parameters/daytemplateNameParam'
1435        - $ref: '#/components/parameters/runningParam'
1436        - $ref: '#/components/parameters/createActivitiesFromTemplateParam'
1437        - $ref: '#/components/parameters/plansizeParam'
1438        - $ref: '#/components/parameters/useAltCodeParam'
1439        - $ref: '#/components/parameters/offerAltCodeParam'
1440        - $ref: '#/components/parameters/locationCodeParam'
1441        - $ref: '#/components/parameters/offerNameParamOpt'
1442        - $ref: '#/components/parameters/courseCodesParamQuery'
1443        - $ref: '#/components/parameters/coreCourseCodesParamQuery'
1444        - $ref: '#/components/parameters/optionalCourseCodesParamQuery'
1445        - $ref: '#/components/parameters/studentCodesParamQuery'
1446        - $ref: '#/components/parameters/tdParam'
1447      requestBody:
1448        description: >-
1449          Request body parameters in JSON format <br>
1450          Example: {"BodyParamB": "Value1", "BodyParamB": "Value2", ..., etc}
1451        required: false
1452        content:
1453          application/json:
1454            schema:
1455              $ref: '#/components/schemas/OfferUrlBody'
1456      responses:
1457        '200':
1458          description: Success - the Offer was updated
1459        '400':
1460          $ref: '#/components/responses/BadRequest'
1461        '401':
1462          $ref: '#/components/responses/Unauthorized'
1463        '500':
1464          $ref: '#/components/responses/InternalServerError'
1465    delete:
1466      summary: Delete an Offer
1467      description: Deletes a module offer
1468      tags: ["offer"]
1469      operationId: deleteOfferN
1470      parameters:
1471        - $ref: '#/components/parameters/offerNameParamReq'
1472        - $ref: '#/components/parameters/moduleCodeQueryParam2'
1473        - $ref: '#/components/parameters/useAltCodeParam'
1474      responses:
1475        '200':
1476          description: Success - the Offer was deleted
1477        '400':
1478          $ref: '#/components/responses/BadRequest'
1479        '401':
1480          $ref: '#/components/responses/Unauthorized'
1481        '500':
1482          $ref: '#/components/responses/InternalServerError'
1483  '/offer/{n}/activities':
1484    get:
1485      summary: Get all Offer Activities
1486      description: Return JSON array of all the Activities belonging to an Offer
1487      tags: [ "offer" ]
1488      operationId: getOfferActivitiesN
1489      parameters:
1490        - $ref: '#/components/parameters/offerNameParamReq'
1491        - $ref: '#/components/parameters/moduleCodeQueryParam'
1492        - $ref: '#/components/parameters/useAltCodeParam'
1493      responses:
1494        '200':
1495          description: An array of Activity Objects
1496          content:
1497            application/json:
1498              schema:
1499                $ref: '#/components/schemas/ActivityResponse'
1500        '400':
1501          $ref: '#/components/responses/BadRequest'
1502        '401':
1503          $ref: '#/components/responses/Unauthorized'
1504        '500':
1505          $ref: '#/components/responses/InternalServerError'
1506  /capabilities:
1507    get:
1508      summary: Get all Capabilities
1509      description: Return JSON array of all Capability objects
1510      tags: ["capability"]
1511      operationId: getCapabilities
1512      responses:
1513        '200':
1514          description: A JSON array of Capability objects
1515          content:
1516            application/json:
1517              schema:
1518                type: array
1519                items:
1520                  $ref: '#/components/schemas/Capability'
1521  '/capability/{c}':
1522    get:
1523      summary: Get one Capability
1524      description: Get details for one Capability
1525      tags: ["capability"]
1526      operationId: getCapabilityC
1527      parameters:
1528        - $ref: '#/components/parameters/capabilityCodeParam'
1529      responses:
1530        '200':
1531          description: A Capability object
1532          content:
1533            application/json:
1534              schema:
1535                $ref: '#/components/schemas/Capability'
1536        '400':
1537          $ref: '#/components/responses/BadRequest'
1538        '401':
1539          $ref: '#/components/responses/Unauthorized'
1540        '500':
1541          $ref: '#/components/responses/InternalServerError'
1542    post:
1543      summary: Create a new Capability
1544      description: Create a new Capability
1545      tags: ["capability"]
1546      operationId: postCapabilityC
1547      parameters:
1548        - $ref: '#/components/parameters/capabilityCodeParam'
1549        - $ref: '#/components/parameters/capabilityTypeParam'
1550      responses:
1551        '200':
1552          $ref: '#/components/responses/OperationSucceeded'
1553        '400':
1554          $ref: '#/components/responses/BadRequest'
1555        '401':
1556          $ref: '#/components/responses/Unauthorized'
1557        '500':
1558          $ref: '#/components/responses/InternalServerError'
1559    delete:
1560      summary: Delete a Capability
1561      description: Delete a Capability
1562      tags: ["capability"]
1563      operationId: deleteCapabilityC
1564      parameters:
1565        - $ref: '#/components/parameters/capabilityCodeParam'
1566      responses:
1567        '200':
1568          description: Success - the Capability was deleted
1569        '400':
1570          $ref: '#/components/responses/BadRequest'
1571        '401':
1572          $ref: '#/components/responses/Unauthorized'
1573        '500':
1574          $ref: '#/components/responses/InternalServerError'
1575  /departments:
1576    get:
1577      summary: Get all Departments
1578      description: Get the list of all Departments
1579      tags: ["department"]
1580      operationId: getDepartments
1581      responses:
1582        '200':
1583          description: A JSON array of Departments
1584          content:
1585            application/json:
1586              schema:
1587                type: array
1588                items:
1589                  $ref: '#/components/schemas/Department'
1590  '/department/{c}':
1591    get:
1592      summary: Get one Department
1593      description: Get details for one Department
1594      tags: ["department"]
1595      operationId: getDepartmentC
1596      parameters:
1597        - $ref: '#/components/parameters/departmentCodeParamP'
1598      responses:
1599        '200':
1600          description: A Department object
1601          content:
1602            application/json:
1603              schema:
1604                $ref: '#/components/schemas/Department'
1605        '400':
1606          $ref: '#/components/responses/BadRequest'
1607        '401':
1608          $ref: '#/components/responses/Unauthorized'
1609        '500':
1610          $ref: '#/components/responses/InternalServerError'
1611    post:
1612      summary: Create a new Department
1613      description: Create a new Department
1614      tags: ["department"]
1615      operationId: postDepartmentC
1616      parameters:
1617        - $ref: '#/components/parameters/departmentCodeParamP'
1618        - $ref: '#/components/parameters/departmentNameParamReq'
1619        - $ref: '#/components/parameters/departmentDescriptionParam'
1620        - $ref: '#/components/parameters/departmentParentCodeParam'
1621      responses:
1622        '200':
1623          $ref: '#/components/responses/OperationSucceeded'
1624        '400':
1625          $ref: '#/components/responses/BadRequest'
1626        '401':
1627          $ref: '#/components/responses/Unauthorized'
1628        '500':
1629          $ref: '#/components/responses/InternalServerError'
1630    put:
1631      summary: Update a Department
1632      description: Update an existing Department
1633      tags: ["department"]
1634      operationId: putDeaprtmentC
1635      parameters:
1636        - $ref: '#/components/parameters/departmentCodeParamP'
1637        - $ref: '#/components/parameters/departmentNameParam'
1638        - $ref: '#/components/parameters/departmentDescriptionParam'
1639        - $ref: '#/components/parameters/departmentParentCodeParam'
1640      responses:
1641        '200':
1642          description: Success - the Department was updated
1643        '400':
1644          $ref: '#/components/responses/BadRequest'
1645        '401':
1646          $ref: '#/components/responses/Unauthorized'
1647        '500':
1648          $ref: '#/components/responses/InternalServerError'
1649    delete:
1650      summary: Delete aDepartment
1651      description: Delete an existing Department
1652      tags: ["department"]
1653      operationId: deleteDepartmentC
1654      parameters:
1655        - $ref: '#/components/parameters/departmentCodeParamP'
1656      responses:
1657        '200':
1658          description: Success - the Department was deleted
1659        '400':
1660          $ref: '#/components/responses/BadRequest'
1661        '401':
1662          $ref: '#/components/responses/Unauthorized'
1663        '500':
1664          $ref: '#/components/responses/InternalServerError'
1665  /schedule/rooms:
1666    get:
1667      summary: Get the schedule for all rooms
1668      description: Returns JSON array of Offer objects
1669      tags: ["schedule"]
1670      operationId: getScheduleRooms
1671      parameters:
1672        - $ref: '#/components/parameters/startDateParam'
1673        - $ref: '#/components/parameters/daysParam'
1674        - $ref: '#/components/parameters/returnNotesParam'
1675      responses:
1676        '200':
1677          description: A JSON array of Event objects
1678          content:
1679            application/json:
1680              schema:
1681                type: array
1682                items:
1683                  $ref: '#/components/schemas/RoomsSchedule'
1684  /schedule/room/null:
1685    get:
1686      summary: Get the schedule for virtual activities
1687      description: Returns JSON array of Event objects
1688      tags: ["schedule"]
1689      operationId: getScheduleRoomNull
1690      parameters:
1691        - $ref: '#/components/parameters/startDateParam'
1692        - $ref: '#/components/parameters/daysParam'
1693        - $ref: '#/components/parameters/returnNotesParam'
1694      responses:
1695        '200':
1696          description: A JSON array of Event objects
1697          content:
1698            application/json:
1699              schema:
1700                type: array
1701                items:
1702                  $ref: '#/components/schemas/RoomsSchedule'
1703        '400':
1704          $ref: '#/components/responses/BadRequest'
1705        '401':
1706          $ref: '#/components/responses/Unauthorized'
1707        '500':
1708          $ref: '#/components/responses/InternalServerError'
1709  '/schedule/room/{c}':
1710    get:
1711      summary: Get the schedule for a room
1712      description: Returns JSON array of Event objects
1713      tags: ["schedule"]
1714      operationId: getScheduleRoomC
1715      parameters:
1716        - $ref: '#/components/parameters/roomCodeParamReq'
1717        - $ref: '#/components/parameters/startDateParam'
1718        - $ref: '#/components/parameters/daysParam'
1719        - $ref: '#/components/parameters/returnNotesParam'
1720      responses:
1721        '200':
1722          description: A JSON array of Event objects
1723          content:
1724            application/json:
1725              schema:
1726                type: array
1727                items:
1728                  $ref: '#/components/schemas/RoomsSchedule'
1729        '400':
1730          $ref: '#/components/responses/BadRequest'
1731        '401':
1732          $ref: '#/components/responses/Unauthorized'
1733        '500':
1734          $ref: '#/components/responses/InternalServerError'
1735  '/timetable/student/{c}':
1736    get:
1737      summary: Get timetable for one student
1738      description: >-
1739        Returns timetabled activities for today or for the requested date range,
1740        provided that the range is within the current academic year.
1741      tags: ["timetable"]
1742      operationId: getTimetableStudentC
1743      parameters:
1744        - $ref: '#/components/parameters/codeParam'
1745        - $ref: '#/components/parameters/startDateParam'
1746        - $ref: '#/components/parameters/endDateParam'
1747        - $ref: '#/components/parameters/actUser1FilterParam'
1748        - $ref: '#/components/parameters/actUser2FilterParam'
1749        - $ref: '#/components/parameters/actUser3FilterParam'
1750      responses:
1751        '200':
1752          description: >-
1753            An array of activities. When no activities are found an
1754            empty schedule array is returned.
1755          content:
1756            application/json:
1757              schema:
1758                $ref: '#/components/schemas/StudentResponseObject'
1759        '400':
1760          $ref: '#/components/responses/BadRequest'
1761        '401':
1762          $ref: '#/components/responses/Unauthorized'
1763        '500':
1764          $ref: '#/components/responses/InternalServerError'
1765  '/timetable/staff/{c}':
1766    get:
1767      summary: Get timetable for one staff member
1768      description: >-
1769        Returns timetabled activities for today or for the requested date range,
1770        provided that the range is within the current academic year.
1771      tags: ["timetable"]
1772      operationId: getTimetableStaffC
1773      parameters:
1774        - $ref: '#/components/parameters/staffCodeParam'
1775        - $ref: '#/components/parameters/startDateParam'
1776        - $ref: '#/components/parameters/endDateParam'
1777      responses:
1778        '200':
1779          description: >-
1780            An array of activities. When no activities are found an empty
1781            schedule array is returned.
1782          content:
1783            application/json:
1784              schema:
1785                $ref: '#/components/schemas/StaffResponseObject'
1786        '400':
1787          $ref: '#/components/responses/BadRequest'
1788        '401':
1789          $ref: '#/components/responses/Unauthorized'
1790        '500':
1791          $ref: '#/components/responses/InternalServerError'
1792  '/timetable/module/{c}':
1793    get:
1794      summary: Get timetable for one module
1795      description: >-
1796        Returns timetabled activities for today or for the requested date range,
1797        provided that the range is within the current academic year.
1798      tags: ["timetable"]
1799      operationId: getTimetableModuleC
1800      parameters:
1801        - $ref: '#/components/parameters/moduleCodeParam'
1802        - $ref: '#/components/parameters/startDateParam'
1803        - $ref: '#/components/parameters/endDateParam'
1804      responses:
1805        '200':
1806          description: >-
1807            An array of activities. When no activities are found an empty
1808            schedule array is returned.
1809          content:
1810            application/json:
1811              schema:
1812                $ref: '#/components/schemas/ModuleResponseObject'
1813        '400':
1814          $ref: '#/components/responses/BadRequest'
1815        '401':
1816          $ref: '#/components/responses/Unauthorized'
1817        '500':
1818          $ref: '#/components/responses/InternalServerError'
1819  '/timetable/offer/{o}':
1820    get:
1821      summary: Get timetable for one offer
1822      description: >-
1823        Returns timetabled activities for today or for the requested date range,
1824        provided that the range is within the current academic year.
1825      tags: ["timetable"]
1826      operationId: getTimetableOfferO
1827      parameters:
1828        - $ref: '#/components/parameters/offerNameParam'
1829        - $ref: '#/components/parameters/moduleCodeQueryParam3'
1830        - $ref: '#/components/parameters/useAltCodeParam'
1831        - $ref: '#/components/parameters/startDateParam'
1832        - $ref: '#/components/parameters/endDateParam'
1833      responses:
1834        '200':
1835          description: >-
1836            An array of activities. When no activities are found an empty
1837            schedule array is returned.
1838          content:
1839            application/json:
1840              schema:
1841                $ref: '#/components/schemas/OfferResponseObject'
1842        '400':
1843          $ref: '#/components/responses/BadRequest'
1844        '401':
1845          $ref: '#/components/responses/Unauthorized'
1846        '500':
1847          $ref: '#/components/responses/InternalServerError'
1848  '/timetable/course/{cc}':
1849    get:
1850      summary: Get timetable for a course
1851      description: >-
1852        Returns timetabled activities for today or for the requested date range,
1853        provided that the range is within the current academic year.
1854      tags: ["timetable"]
1855      operationId: getTimetableCourseCC
1856      parameters:
1857        - $ref: '#/components/parameters/courseCodeParamPath'
1858        - $ref: '#/components/parameters/startDateParam'
1859        - $ref: '#/components/parameters/endDateParam'
1860      responses:
1861        '200':
1862          description: >-
1863            An array of activities. When no activities are found an empty
1864            schedule array is returned.
1865          content:
1866            application/json:
1867              schema:
1868                $ref: '#/components/schemas/CourseResponseObject'
1869        '400':
1870          $ref: '#/components/responses/BadRequest'
1871        '401':
1872          $ref: '#/components/responses/Unauthorized'
1873        '500':
1874          $ref: '#/components/responses/InternalServerError'
1875  '/timetable/room/{c}':
1876    get:
1877      summary: Get timetable for a room
1878      description: >-
1879        Returns timetabled activities for today or for the requested date range,
1880        provided that the range is within the current academic year.
1881      tags: ["timetable"]
1882      operationId: getTimetableRoomC
1883      parameters:
1884        - $ref: '#/components/parameters/roomCodeParamReq'
1885        - $ref: '#/components/parameters/startDateParam'
1886        - $ref: '#/components/parameters/endDateParam'
1887      responses:
1888        '200':
1889          description: >-
1890            An array of activities. When no activities are found an empty
1891            schedule array is returned.
1892          content:
1893            application/json:
1894              schema:
1895                $ref: '#/components/schemas/RoomResponseObject'
1896        '400':
1897          $ref: '#/components/responses/BadRequest'
1898        '401':
1899          $ref: '#/components/responses/Unauthorized'
1900        '500':
1901          $ref: '#/components/responses/InternalServerError'
1902  '/timetable/building/{b}/{c}':
1903    get:
1904      summary: Get timetable for a building
1905      description: >-
1906        Returns timetabled activities for today or for the requested date range,
1907        provided that the range is within the current academic year.
1908      tags: ["timetable"]
1909      operationId: getTimetableBuildingBC
1910      parameters:
1911        - $ref: '#/components/parameters/buildingNameParam'
1912        - $ref: '#/components/parameters/campusNameParam'
1913        - $ref: '#/components/parameters/startDateParam'
1914        - $ref: '#/components/parameters/endDateParam'
1915      responses:
1916        '200':
1917          description: >-
1918            An array of activities. When no activities are found an empty
1919            schedule array is returned.
1920          content:
1921            application/json:
1922              schema:
1923                $ref: '#/components/schemas/BuildingResponseObject'
1924        '400':
1925          $ref: '#/components/responses/BadRequest'
1926        '401':
1927          $ref: '#/components/responses/Unauthorized'
1928        '500':
1929          $ref: '#/components/responses/InternalServerError'
1930  '/timetable/studentgroup/{gc}':
1931    get:
1932      summary: Get timetable for one student group
1933      description: >-
1934        Returns timetabled activities for today or for the requested date range,
1935        provided that the range is within the current academic year.
1936      tags: ["timetable"]
1937      operationId: getTimetableStudentgroupGC
1938      parameters:
1939        - $ref: '#/components/parameters/groupCodeParam2'
1940        - $ref: '#/components/parameters/useAltCodeParam'
1941        - $ref: '#/components/parameters/startDateParam'
1942        - $ref: '#/components/parameters/endDateParam'
1943      responses:
1944        '200':
1945          description: >-
1946            An array of activities. When no activities are found an empty
1947            schedule array is returned.
1948          content:
1949            application/json:
1950              schema:
1951                $ref: '#/components/schemas/StudentGroupResponseObject'
1952        '400':
1953          $ref: '#/components/responses/BadRequest'
1954        '401':
1955          $ref: '#/components/responses/Unauthorized'
1956        '500':
1957          $ref: '#/components/responses/InternalServerError'
1958  /performance:
1959    get:
1960      summary: Get all performance measurements
1961      description: The performance endpoint returns a list of all performance measurements.
1962      tags: ["performance"]
1963      operationId: getPerformance
1964      responses:
1965        '200':
1966          description: A JSON array of Measurement objects
1967          content:
1968            application/json:
1969              schema:
1970                type: array
1971                items:
1972                  $ref: '#/components/schemas/Measurement'
1973    post:
1974      summary: Create a new performance measurement
1975      description: Create a new performance measurement
1976      tags: ["performance"]
1977      operationId: postPerformance
1978      parameters:
1979        - $ref: '#/components/parameters/measurementCodeParam'
1980        - $ref: '#/components/parameters/measurementDescParam'
1981        - $ref: '#/components/parameters/dateTimeParam'
1982        - $ref: '#/components/parameters/millisecondsParam'
1983      responses:
1984        '200':
1985          $ref: '#/components/responses/OperationSucceeded'
1986        '400':
1987          $ref: '#/components/responses/BadRequest'
1988        '401':
1989          $ref: '#/components/responses/Unauthorized'
1990        '500':
1991          $ref: '#/components/responses/InternalServerError'
1992  /classicexams:
1993    get:
1994      summary: Get the list of all Classic Exams
1995      description: Return JSON array of Classic Exams
1996      tags: ["exams"]
1997      operationId: getClassicexams
1998      parameters:
1999        - $ref: '#/components/parameters/assessmentPeriodCodeParamReq'
2000        - $ref: '#/components/parameters/useModuleOfferAltCodeParam'
2001      responses:
2002        '200':
2003          description: A JSON array of Classic Exam objects
2004          content:
2005            application/json:
2006              schema:
2007                type: array
2008                items:
2009                  $ref: '#/components/schemas/ClassicExam'
2010  /classicexam/{c}:
2011    get:
2012      summary: Get one Classic Exam
2013      description: Get details for one Classic Exam
2014      tags: ["exams"]
2015      operationId: getClassicexamC
2016      parameters:
2017        - $ref: '#/components/parameters/examCodeParam'
2018        - $ref: '#/components/parameters/useModuleOfferAltCodeParam'
2019      responses:
2020        '200':
2021          description: A Classic Exam object
2022          content:
2023            application/json:
2024              schema:
2025                $ref: '#/components/schemas/ClassicExam'
2026    post:
2027      summary: Create a Classic Exam
2028      description: Create a new Classic Exam
2029      tags: ["exams"]
2030      operationId: postClassicexamC
2031      parameters:
2032        - $ref: '#/components/parameters/Capabilities2Param'
2033        - $ref: '#/components/parameters/assessmentPeriodCodeParamReq'
2034        - $ref: '#/components/parameters/assessmentTypeParam'
2035        - $ref: '#/components/parameters/buildingCodeParam'
2036        - $ref: '#/components/parameters/campusCodeParam'
2037        - $ref: '#/components/parameters/canCreateSessionsParam'
2038        - $ref: '#/components/parameters/classicColocationsParam'
2039        - $ref: '#/components/parameters/classicPredecessorsParam'
2040        - $ref: '#/components/parameters/complexityParam'
2041        - $ref: '#/components/parameters/daytemplateName2Param'
2042        - $ref: '#/components/parameters/descriptionParam'
2043        - $ref: '#/components/parameters/durationMinutesParam'
2044        - $ref: '#/components/parameters/endDate2Param'
2045        - $ref: '#/components/parameters/examCodeParamReq'
2046        - $ref: '#/components/parameters/examFriendlyNameQueryParam'
2047        - $ref: '#/components/parameters/examName255ParamReq'
2048        - $ref: '#/components/parameters/exclusiveStaffParam'
2049        - $ref: '#/components/parameters/fixedDayParam'
2050        - $ref: '#/components/parameters/fixedRoomsParam'
2051        - $ref: '#/components/parameters/fixedTimeParam'
2052        - $ref: '#/components/parameters/maxPerInvigilatorParam'
2053        - $ref: '#/components/parameters/minRoomSizeParam'
2054        - $ref: '#/components/parameters/moduleCodeParam4'
2055        - $ref: '#/components/parameters/noPublishStaffParam'
2056        - $ref: '#/components/parameters/noPublishStudentsParam'
2057        - $ref: '#/components/parameters/notesParamQ'
2058        - $ref: '#/components/parameters/offerCodeParam'
2059        - $ref: '#/components/parameters/personalDeadlineEnabledParam'
2060        - $ref: '#/components/parameters/planSizeParam'
2061        - $ref: '#/components/parameters/preferredStartParam'
2062        - $ref: '#/components/parameters/readyParam'
2063        - $ref: '#/components/parameters/roomPoolParam'
2064        - $ref: '#/components/parameters/sequenceParam'
2065        - $ref: '#/components/parameters/serialPredecessorsParam'
2066        - $ref: '#/components/parameters/setupTimeMinsParam'
2067        - $ref: '#/components/parameters/sharingParam'
2068        - $ref: '#/components/parameters/slotGroupParam'
2069        - $ref: '#/components/parameters/splittableParam'
2070        - $ref: '#/components/parameters/staffParam'
2071        - $ref: '#/components/parameters/startDate2Param'
2072        - $ref: '#/components/parameters/takedownTimeMinsParam'
2073        - $ref: '#/components/parameters/takehomePredecessorsParam'
2074        - $ref: '#/components/parameters/useOfferAltCodeParam'
2075        - $ref: '#/components/parameters/usePlanSizeParam'
2076        - $ref: '#/components/parameters/user1-256Param'
2077        - $ref: '#/components/parameters/user2-256Param'
2078        - $ref: '#/components/parameters/user3-256Param'
2079        - $ref: '#/components/parameters/skipStudentClashesParam'
2080      responses:
2081        '200':
2082          $ref: '#/components/responses/OperationSucceeded'
2083        '400':
2084          $ref: '#/components/responses/BadRequest'
2085        '401':
2086          $ref: '#/components/responses/Unauthorized'
2087        '500':
2088          $ref: '#/components/responses/InternalServerError'
2089    put:
2090      summary: Update a Classic Exam
2091      description: Update an existing Classic Exam
2092      tags: ["exams"]
2093      operationId: putClassicexamC
2094      parameters:
2095        - $ref: '#/components/parameters/Capabilities2Param'
2096        - $ref: '#/components/parameters/assessmentPeriodCodeParamOpt'
2097        - $ref: '#/components/parameters/assessmentTypeParam'
2098        - $ref: '#/components/parameters/buildingCodeParam'
2099        - $ref: '#/components/parameters/campusCodeParam'
2100        - $ref: '#/components/parameters/classicColocationsParam'
2101        - $ref: '#/components/parameters/classicPredecessorsParam'
2102        - $ref: '#/components/parameters/complexityParam'
2103        - $ref: '#/components/parameters/daytemplateName2Param'
2104        - $ref: '#/components/parameters/descriptionParam'
2105        - $ref: '#/components/parameters/durationMinutesOptParam'
2106        - $ref: '#/components/parameters/endDate2Param'
2107        - $ref: '#/components/parameters/examCodeParamReq'
2108        - $ref: '#/components/parameters/examFriendlyNameQueryParam'
2109        - $ref: '#/components/parameters/examName255ParamOpt'
2110        - $ref: '#/components/parameters/exclusiveStaffParam'
2111        - $ref: '#/components/parameters/fixedDayParam'
2112        - $ref: '#/components/parameters/fixedRoomsParam'
2113        - $ref: '#/components/parameters/fixedTimeParam'
2114        - $ref: '#/components/parameters/layoutTypeParam'
2115        - $ref: '#/components/parameters/maxPerInvigilatorParam'
2116        - $ref: '#/components/parameters/minRoomSizeParam'
2117        - $ref: '#/components/parameters/moduleCodeParam4'
2118        - $ref: '#/components/parameters/noPublishStaffParam'
2119        - $ref: '#/components/parameters/noPublishStudentsParam'
2120        - $ref: '#/components/parameters/notesParamQ'
2121        - $ref: '#/components/parameters/offerCodeOpt2Param'
2122        - $ref: '#/components/parameters/personalDeadlineEnabledParam'
2123        - $ref: '#/components/parameters/planSizeParam'
2124        - $ref: '#/components/parameters/preferredStartParam'
2125        - $ref: '#/components/parameters/readyParam'
2126        - $ref: '#/components/parameters/roomPoolParam'
2127        - $ref: '#/components/parameters/sequenceParam'
2128        - $ref: '#/components/parameters/serialPredecessorsParam'
2129        - $ref: '#/components/parameters/setupTimeMinsParam'
2130        - $ref: '#/components/parameters/sharingParam'
2131        - $ref: '#/components/parameters/slotGroupParam'
2132        - $ref: '#/components/parameters/splittableParam'
2133        - $ref: '#/components/parameters/staffParam'
2134        - $ref: '#/components/parameters/startDate2Param'
2135        - $ref: '#/components/parameters/takedownTimeMinsParam'
2136        - $ref: '#/components/parameters/takehomePredecessorsParam'
2137        - $ref: '#/components/parameters/useOfferAltCodeParam'
2138        - $ref: '#/components/parameters/usePlanSizeParam'
2139        - $ref: '#/components/parameters/user1-256Param'
2140        - $ref: '#/components/parameters/user2-256Param'
2141        - $ref: '#/components/parameters/user3-256Param'
2142        - $ref: '#/components/parameters/skipStudentClashesParam'
2143      responses:
2144        '200':
2145          $ref: '#/components/responses/OperationSucceeded'
2146        '400':
2147          $ref: '#/components/responses/BadRequest'
2148        '401':
2149          $ref: '#/components/responses/Unauthorized'
2150        '500':
2151          $ref: '#/components/responses/InternalServerError'
2152    delete:
2153      summary: Delete a Classic Exam
2154      description: Delete a Classic Exam
2155      tags: ["exams"]
2156      operationId: deleteClassicexamC
2157      parameters:
2158        - $ref: '#/components/parameters/examCodeParamReq'
2159      responses:
2160        '200':
2161          description: Success - the Classic Exam was deleted
2162        '400':
2163          $ref: '#/components/responses/BadRequest'
2164        '401':
2165          $ref: '#/components/responses/Unauthorized'
2166        '500':
2167          $ref: '#/components/responses/InternalServerError'
2168  /classicexam/{c}/student/{s}:
2169    post:
2170      summary: Enrol a Student in a Classic Exam
2171      description: |
2172        Enrol a Student in a Classic Exam to record the fact that the Student should take
2173        the Exam
2174      tags: ["exams"]
2175      operationId: postClassicexamStudent
2176      parameters:
2177        - $ref: '#/components/parameters/examCodeParam'
2178        - $ref: '#/components/parameters/studentCodeParam'
2179      requestBody:
2180        description: >-
2181          Additional body parameters that allow adding, removing and setting of
2182          special requirements to the student for the exam. Only one parameter
2183          can be accepted at a time. Passing more than one will result in API
2184          error 113. The format for each body parameter is either a CSV list,
2185          e.g., setSpecialRequirements: "Writer,Reader" or a JSON array, e.g.,
2186          addSpecialRequirements: "["Reader","Writer"]"
2187        required: false
2188        content:
2189          application/x-www-form-urlencoded:
2190            schema:
2191              $ref: '#/components/schemas/PerStudentPerExamSpecialRequirementBodyParams'
2192      responses:
2193        '200':
2194          description: The Student was enrolled
2195        '400':
2196          $ref: '#/components/responses/BadRequest'
2197        '401':
2198          $ref: '#/components/responses/Unauthorized'
2199        '500':
2200          $ref: '#/components/responses/InternalServerError'
2201    delete:
2202      summary: Un-enrol a Student from a Classic Exam
2203      description: |
2204        Un-enrol a Student from a Classic Exam because the Student is no longer taking
2205        the Exam
2206      tags: ["exams"]
2207      operationId: deleteClassicexamStudent
2208      parameters:
2209        - $ref: '#/components/parameters/examCodeParam'
2210        - $ref: '#/components/parameters/studentCodeParam'
2211      responses:
2212        '200':
2213          description: The Student was un-enrolled
2214        '400':
2215          $ref: '#/components/responses/BadRequest'
2216        '401':
2217          $ref: '#/components/responses/Unauthorized'
2218        '500':
2219          $ref: '#/components/responses/InternalServerError'
2220  /serialexams:
2221    get:
2222      summary: Get all Serial Exams
2223      description: Return JSON array of all Serial Exams
2224      tags: ["exams"]
2225      operationId: getSerialexams
2226      parameters:
2227        - $ref: '#/components/parameters/assessmentPeriodCodeParamReq'
2228        - $ref: '#/components/parameters/useAltCodeParam'
2229      responses:
2230        '200':
2231          description: A JSON array of Serial Exam objects
2232          content:
2233            application/json:
2234              schema:
2235                type: array
2236                items:
2237                  $ref: '#/components/schemas/SerialExam'
2238  /serialexam/{c}:
2239    get:
2240      summary: Get one Serial Exam
2241      description: Get details for one Serial Exam
2242      tags: ["exams"]
2243      operationId: getSerialexamC
2244      parameters:
2245        - $ref: '#/components/parameters/examCodeParam'
2246        - $ref: '#/components/parameters/useAltCodeParam'
2247      responses:
2248        '200':
2249          description: A Serial Exam object
2250          content:
2251            application/json:
2252              schema:
2253                $ref: '#/components/schemas/SerialExam'
2254    post:
2255      summary: Create a Serial Exam
2256      description: Create a new Serial Exam
2257      tags: ["exams"]
2258      operationId: postSerialexamC
2259      parameters:
2260        - $ref: '#/components/parameters/Capabilities2Param'
2261        - $ref: '#/components/parameters/assessmentPeriodCodeParamReq'
2262        - $ref: '#/components/parameters/assessmentTypeParam'
2263        - $ref: '#/components/parameters/breakDurationMinutesParam'
2264        - $ref: '#/components/parameters/buildingCodeParam'
2265        - $ref: '#/components/parameters/campusCodeParam'
2266        - $ref: '#/components/parameters/canCreateSessionsParam'
2267        - $ref: '#/components/parameters/classicPredecessorsParam'
2268        - $ref: '#/components/parameters/complexityParam'
2269        - $ref: '#/components/parameters/concurrencyParam'
2270        - $ref: '#/components/parameters/daytemplateName2Param'
2271        - $ref: '#/components/parameters/descriptionParam'
2272        - $ref: '#/components/parameters/endDate2Param'
2273        - $ref: '#/components/parameters/examCodeParamReq'
2274        - $ref: '#/components/parameters/examFriendlyNameQueryParam'
2275        - $ref: '#/components/parameters/examName255ParamReq'
2276        - $ref: '#/components/parameters/exclusiveStaffParam'
2277        - $ref: '#/components/parameters/fixedRoomsParam'
2278        - $ref: '#/components/parameters/maxPerInvigilatorParam'
2279        - $ref: '#/components/parameters/minutesBetweenBreaksParam'
2280        - $ref: '#/components/parameters/moduleCodeParam4'
2281        - $ref: '#/components/parameters/noPublishStaffParam'
2282        - $ref: '#/components/parameters/noPublishStudentsParam'
2283        - $ref: '#/components/parameters/notesParamQ'
2284        - $ref: '#/components/parameters/offerCodeParam'
2285        - $ref: '#/components/parameters/personalDeadlineEnabledParam'
2286        - $ref: '#/components/parameters/plannedSlotsPerTrackParam'
2287        - $ref: '#/components/parameters/plannedStartDateTimeParam'
2288        - $ref: '#/components/parameters/plannedStudentsPerTrackSlotParam'
2289        - $ref: '#/components/parameters/planSizeParam'
2290        - $ref: '#/components/parameters/preferredStartParam'
2291        - $ref: '#/components/parameters/readyParam'
2292        - $ref: '#/components/parameters/roomPoolParam'
2293        - $ref: '#/components/parameters/roomSizePerTrackParamReq'
2294        - $ref: '#/components/parameters/sequenceParam'
2295        - $ref: '#/components/parameters/serialPredecessorsParam'
2296        - $ref: '#/components/parameters/setupTimeMinsParam'
2297        - $ref: '#/components/parameters/slotGroupParam'
2298        - $ref: '#/components/parameters/staffParam'
2299        - $ref: '#/components/parameters/startDate2Param'
2300        - $ref: '#/components/parameters/takedownTimeMinsParam'
2301        - $ref: '#/components/parameters/takehomePredecessorsParam'
2302        - $ref: '#/components/parameters/trackSlotLengthMinsParamReq'
2303        - $ref: '#/components/parameters/useOfferAltCodeParam'
2304        - $ref: '#/components/parameters/usePlanSizeParam'
2305        - $ref: '#/components/parameters/user1-256Param'
2306        - $ref: '#/components/parameters/user2-256Param'
2307        - $ref: '#/components/parameters/user3-256Param'
2308        - $ref: '#/components/parameters/skipStudentClashesParam'
2309      responses:
2310        '200':
2311          $ref: '#/components/responses/OperationSucceeded'
2312        '400':
2313          $ref: '#/components/responses/BadRequest'
2314        '401':
2315          $ref: '#/components/responses/Unauthorized'
2316        '500':
2317          $ref: '#/components/responses/InternalServerError'
2318    put:
2319      summary: Update a Serial Exam
2320      description: Update an existing Serial Exam
2321      tags: ["exams"]
2322      operationId: putSerialexamC
2323      parameters:
2324        - $ref: '#/components/parameters/Capabilities2Param'
2325        - $ref: '#/components/parameters/assessmentPeriodCodeParamOpt'
2326        - $ref: '#/components/parameters/assessmentTypeParam'
2327        - $ref: '#/components/parameters/breakDurationMinutesParam'
2328        - $ref: '#/components/parameters/buildingCodeParam'
2329        - $ref: '#/components/parameters/campusCodeParam'
2330        - $ref: '#/components/parameters/classicPredecessorsParam'
2331        - $ref: '#/components/parameters/complexityParam'
2332        - $ref: '#/components/parameters/concurrencyParam'
2333        - $ref: '#/components/parameters/daytemplateName2Param'
2334        - $ref: '#/components/parameters/descriptionParam'
2335        - $ref: '#/components/parameters/endDate2Param'
2336        - $ref: '#/components/parameters/examCodeParamReq'
2337        - $ref: '#/components/parameters/examFriendlyNameQueryParam'
2338        - $ref: '#/components/parameters/examName255ParamOpt'
2339        - $ref: '#/components/parameters/exclusiveStaffParam'
2340        - $ref: '#/components/parameters/fixedRoomsParam'
2341        - $ref: '#/components/parameters/maxPerInvigilatorParam'
2342        - $ref: '#/components/parameters/minutesBetweenBreaksParam'
2343        - $ref: '#/components/parameters/moduleCodeParam4'
2344        - $ref: '#/components/parameters/noPublishStaffParam'
2345        - $ref: '#/components/parameters/noPublishStudentsParam'
2346        - $ref: '#/components/parameters/notesParamQ'
2347        - $ref: '#/components/parameters/offerCodeOpt2Param'
2348        - $ref: '#/components/parameters/personalDeadlineEnabledParam'
2349        - $ref: '#/components/parameters/plannedSlotsPerTrackParam'
2350        - $ref: '#/components/parameters/plannedStartDateTimeParam'
2351        - $ref: '#/components/parameters/plannedStudentsPerTrackSlotParam'
2352        - $ref: '#/components/parameters/planSizeParam'
2353        - $ref: '#/components/parameters/preferredStartParam'
2354        - $ref: '#/components/parameters/readyParam'
2355        - $ref: '#/components/parameters/roomPoolParam'
2356        - $ref: '#/components/parameters/roomSizePerTrackParam'
2357        - $ref: '#/components/parameters/sequenceParam'
2358        - $ref: '#/components/parameters/serialPredecessorsParam'
2359        - $ref: '#/components/parameters/setupTimeMinsParam'
2360        - $ref: '#/components/parameters/slotGroupParam'
2361        - $ref: '#/components/parameters/staffParam'
2362        - $ref: '#/components/parameters/startDate2Param'
2363        - $ref: '#/components/parameters/takedownTimeMinsParam'
2364        - $ref: '#/components/parameters/takehomePredecessorsParam'
2365        - $ref: '#/components/parameters/trackSlotLengthMinsParam'
2366        - $ref: '#/components/parameters/useOfferAltCodeParam'
2367        - $ref: '#/components/parameters/usePlanSizeParam'
2368        - $ref: '#/components/parameters/user1-256Param'
2369        - $ref: '#/components/parameters/user2-256Param'
2370        - $ref: '#/components/parameters/user3-256Param'
2371        - $ref: '#/components/parameters/skipStudentClashesParam'
2372      responses:
2373        '200':
2374          $ref: '#/components/responses/OperationSucceeded'
2375        '400':
2376          $ref: '#/components/responses/BadRequest'
2377        '401':
2378          $ref: '#/components/responses/Unauthorized'
2379        '500':
2380          $ref: '#/components/responses/InternalServerError'
2381    delete:
2382      summary: Delete a Serial Exam
2383      description: Delete a Serial Exam
2384      tags: ["exams"]
2385      operationId: deleteSerialexamC
2386      parameters:
2387        - $ref: '#/components/parameters/examCodeParamReq'
2388      responses:
2389        '200':
2390          description: Success - the Serial Exam was deleted
2391        '400':
2392          $ref: '#/components/responses/BadRequest'
2393        '401':
2394          $ref: '#/components/responses/Unauthorized'
2395        '500':
2396          $ref: '#/components/responses/InternalServerError'
2397  /serialexam/{c}/student/{s}:
2398    post:
2399      summary: Enrol a Student in a Serial Exam
2400      description: |
2401        Enrol a Student in a Serial Exam to record the fact that the Student should take
2402        the Exam
2403      tags: ["exams"]
2404      operationId: postSerialexamStudent
2405      parameters:
2406        - $ref: '#/components/parameters/examCodeParam'
2407        - $ref: '#/components/parameters/studentCodeParam'
2408      responses:
2409        '200':
2410          description: The Student was enrolled
2411        '400':
2412          $ref: '#/components/responses/BadRequest'
2413        '401':
2414          $ref: '#/components/responses/Unauthorized'
2415        '500':
2416          $ref: '#/components/responses/InternalServerError'
2417    delete:
2418      summary: Un-enrol a Student from a Serial Exam
2419      description: |
2420        Un-enrol a Student from a Serial Exam because the Student is no longer taking
2421        the Exam
2422      tags: ["exams"]
2423      operationId: deleteSerialexamStudent
2424      parameters:
2425        - $ref: '#/components/parameters/examCodeParam'
2426        - $ref: '#/components/parameters/studentCodeParam'
2427      responses:
2428        '200':
2429          description: The Student was un-enrolled
2430        '400':
2431          $ref: '#/components/responses/BadRequest'
2432        '401':
2433          $ref: '#/components/responses/Unauthorized'
2434        '500':
2435          $ref: '#/components/responses/InternalServerError'
2436  /takehomeexams:
2437    get:
2438      summary: Get all Takehome Exams
2439      description: Return JSON array of all Takehome Exams
2440      tags: ["exams"]
2441      operationId: getTakehomeexams
2442      parameters:
2443        - $ref: '#/components/parameters/assessmentPeriodCodeParamReq'
2444        - $ref: '#/components/parameters/useAltCodeParam'
2445      responses:
2446        '200':
2447          description: A JSON array of Takehome Exam objects
2448          content:
2449            application/json:
2450              schema:
2451                type: array
2452                items:
2453                  $ref: '#/components/schemas/TakehomeExam'
2454  /takehomeexam/{c}:
2455    get:
2456      summary: Get one Takehome Exam
2457      description: Get details for one Takehome Exam
2458      tags: ["exams"]
2459      operationId: getTakehomeexamC
2460      parameters:
2461        - $ref: '#/components/parameters/examCodeParam'
2462        - $ref: '#/components/parameters/useAltCodeParam'
2463      responses:
2464        '200':
2465          description: A Takehome Exam object
2466          content:
2467            application/json:
2468              schema:
2469                $ref: '#/components/schemas/TakehomeExam'
2470    post:
2471      summary: Create a Takehome Exam
2472      description: Create a new Takehome Exam
2473      tags: ["exams"]
2474      operationId: postTakehomeexamC
2475      parameters:
2476        - $ref: '#/components/parameters/assessmentPeriodCodeParamReq'
2477        - $ref: '#/components/parameters/assessmentTypeParam'
2478        - $ref: '#/components/parameters/classicPredecessorsParam'
2479        - $ref: '#/components/parameters/complexityParam'
2480        - $ref: '#/components/parameters/descriptionParam'
2481        - $ref: '#/components/parameters/durationMinutesParam'
2482        - $ref: '#/components/parameters/examCodeParamReq'
2483        - $ref: '#/components/parameters/examFriendlyNameQueryParam'
2484        - $ref: '#/components/parameters/examName255ParamReq'
2485        - $ref: '#/components/parameters/exclusiveParam'
2486        - $ref: '#/components/parameters/moduleCodeParam4'
2487        - $ref: '#/components/parameters/noPublishStaffParam'
2488        - $ref: '#/components/parameters/noPublishStudentsParam'
2489        - $ref: '#/components/parameters/notesParamQ'
2490        - $ref: '#/components/parameters/offerCodeParam'
2491        - $ref: '#/components/parameters/personalDeadlineEnabledParam'
2492        - $ref: '#/components/parameters/planSizeParam'
2493        - $ref: '#/components/parameters/readyParam'
2494        - $ref: '#/components/parameters/sequenceParam'
2495        - $ref: '#/components/parameters/serialPredecessorsParam'
2496        - $ref: '#/components/parameters/staffParam'
2497        - $ref: '#/components/parameters/submissionDateParam'
2498        - $ref: '#/components/parameters/submissionStartDateParam'
2499        - $ref: '#/components/parameters/takehomePredecessorsParam'
2500        - $ref: '#/components/parameters/useOfferAltCodeParam'
2501        - $ref: '#/components/parameters/usePlanSizeParam'
2502        - $ref: '#/components/parameters/user1-256Param'
2503        - $ref: '#/components/parameters/user2-256Param'
2504        - $ref: '#/components/parameters/user3-256Param'
2505        - $ref: '#/components/parameters/skipStudentClashesParam'
2506      responses:
2507        '200':
2508          $ref: '#/components/responses/OperationSucceeded'
2509        '400':
2510          $ref: '#/components/responses/BadRequest'
2511        '401':
2512          $ref: '#/components/responses/Unauthorized'
2513        '500':
2514          $ref: '#/components/responses/InternalServerError'
2515    put:
2516      summary: Update a Takehome Exam
2517      description: Update an existing Takehome Exam
2518      tags: ["exams"]
2519      operationId: putTakehomeexamC
2520      parameters:
2521        - $ref: '#/components/parameters/assessmentPeriodCodeParamOpt'
2522        - $ref: '#/components/parameters/assessmentTypeParam'
2523        - $ref: '#/components/parameters/classicPredecessorsParam'
2524        - $ref: '#/components/parameters/complexityParam'
2525        - $ref: '#/components/parameters/descriptionParam'
2526        - $ref: '#/components/parameters/durationMinutesOptParam'
2527        - $ref: '#/components/parameters/examCodeParamReq'
2528        - $ref: '#/components/parameters/examFriendlyNameQueryParam'
2529        - $ref: '#/components/parameters/examName255ParamOpt'
2530        - $ref: '#/components/parameters/exclusiveParam'
2531        - $ref: '#/components/parameters/moduleCodeParam4'
2532        - $ref: '#/components/parameters/noPublishStaffParam'
2533        - $ref: '#/components/parameters/noPublishStudentsParam'
2534        - $ref: '#/components/parameters/notesParamQ'
2535        - $ref: '#/components/parameters/offerCodeOpt2Param'
2536        - $ref: '#/components/parameters/personalDeadlineEnabledParam'
2537        - $ref: '#/components/parameters/planSizeParam'
2538        - $ref: '#/components/parameters/readyParam'
2539        - $ref: '#/components/parameters/sequenceParam'
2540        - $ref: '#/components/parameters/serialPredecessorsParam'
2541        - $ref: '#/components/parameters/staffParam'
2542        - $ref: '#/components/parameters/submissionDateParam'
2543        - $ref: '#/components/parameters/submissionStartDateParam'
2544        - $ref: '#/components/parameters/takehomePredecessorsParam'
2545        - $ref: '#/components/parameters/useOfferAltCodeParam'
2546        - $ref: '#/components/parameters/usePlanSizeParam'
2547        - $ref: '#/components/parameters/user1-256Param'
2548        - $ref: '#/components/parameters/user2-256Param'
2549        - $ref: '#/components/parameters/user3-256Param'
2550        - $ref: '#/components/parameters/skipStudentClashesParam'
2551      responses:
2552        '200':
2553          $ref: '#/components/responses/OperationSucceeded'
2554        '400':
2555          $ref: '#/components/responses/BadRequest'
2556        '401':
2557          $ref: '#/components/responses/Unauthorized'
2558        '500':
2559          $ref: '#/components/responses/InternalServerError'
2560    delete:
2561      summary: Delete a Takehome Exam
2562      description: Delete a Takehome Exam
2563      tags: ["exams"]
2564      operationId: deleteTakehomeexamC
2565      parameters:
2566        - $ref: '#/components/parameters/examCodeParamReq'
2567      responses:
2568        '200':
2569          description: Success - the Takehome Exam was deleted
2570        '400':
2571          $ref: '#/components/responses/BadRequest'
2572        '401':
2573          $ref: '#/components/responses/Unauthorized'
2574        '500':
2575          $ref: '#/components/responses/InternalServerError'
2576  /takehomeexam/{c}/student/{s}:
2577    post:
2578      summary: Enrol a Student in a Takehome Exam
2579      description: |
2580        Enrol a Student in a Takehome Exam to record the fact that the Student should take
2581        the Exam
2582      tags: ["exams"]
2583      operationId: postTakehomeexamStudent
2584      parameters:
2585        - $ref: '#/components/parameters/examCodeParam'
2586        - $ref: '#/components/parameters/studentCodeParam'
2587      responses:
2588        '200':
2589          description: The Student was enrolled
2590        '400':
2591          $ref: '#/components/responses/BadRequest'
2592        '401':
2593          $ref: '#/components/responses/Unauthorized'
2594        '500':
2595          $ref: '#/components/responses/InternalServerError'
2596    delete:
2597      summary: Un-enrol a Student from a Takehome Exam
2598      description: |
2599        Un-enrol a Student from a Takehome Exam because the Student is no longer taking
2600        the Exam
2601      tags: ["exams"]
2602      operationId: deleteTakehomeexamStudent
2603      parameters:
2604        - $ref: '#/components/parameters/examCodeParam'
2605        - $ref: '#/components/parameters/studentCodeParam'
2606      responses:
2607        '200':
2608          description: The Student was un-enrolled
2609        '400':
2610          $ref: '#/components/responses/BadRequest'
2611        '401':
2612          $ref: '#/components/responses/Unauthorized'
2613        '500':
2614          $ref: '#/components/responses/InternalServerError'
2615  /submissions:
2616    get:
2617      summary: Get all Submissions
2618      description: Return JSON array of all Submissions
2619      tags: ["exams"]
2620      operationId: getSubmissions
2621      parameters:
2622        - $ref: '#/components/parameters/assessmentPeriodCodeParamReq'
2623      responses:
2624        '200':
2625          description: A JSON array of Submission objects
2626          content:
2627            application/json:
2628              schema:
2629                type: array
2630                items:
2631                  $ref: '#/components/schemas/Submission'
2632  /submission/{c}:
2633    get:
2634      summary: Get one Submission
2635      description: Get details for one Submission
2636      tags: ["exams"]
2637      operationId: getSubmissionC
2638      parameters:
2639        - $ref: '#/components/parameters/examCodeParam'
2640      responses:
2641        '200':
2642          description: A Submission object
2643          content:
2644            application/json:
2645              schema:
2646                $ref: '#/components/schemas/Submission'
2647  /webhooks:
2648    get:
2649      summary: Get all webhooks
2650      description: Returns the list of all webhooks associated with the supplied API key.
2651      tags: ["webhook"]
2652      operationId: getWebhooks
2653      responses:
2654        '200':
2655          description: A JSON array of JSON objects describing each webhook.
2656          content:
2657            application/json:
2658              schema:
2659                type: array
2660                items:
2661                  $ref: '#/components/schemas/Webhook'
2662  '/webhook/{c}':
2663    get:
2664      summary: Get one webhook
2665      description: Returns the identified webhook associated with the supplied API key.
2666      tags: ["webhook"]
2667      operationId: getWebhookC
2668      parameters:
2669        - $ref: '#/components/parameters/webhookCodeParam'
2670      responses:
2671        '200':
2672          description: A JSON object describing the webhook.
2673          content:
2674            application/json:
2675              schema:
2676                $ref: '#/components/schemas/Webhook'
2677        '400':
2678          $ref: '#/components/responses/BadRequest'
2679        '401':
2680          $ref: '#/components/responses/Unauthorized'
2681        '500':
2682          $ref: '#/components/responses/InternalServerError'
2683    post:
2684      summary: Register a new webhook
2685      description: |
2686        The customer registers a new webhook with Semestry.
2687        The table below describes a list of available webhook types:
2688        <br>
2689        <table style="border: 1px solid black">
2690          <tr style="border: 1px solid black">
2691            <th style="border: 1px solid black">Type</th>
2692            <th style="border: 1px solid black">Fires when...</th>
2693          </tr>
2694          <tr style="border: 1px solid black">
2695            <td style="border: 1px solid black">activity.deleted</td>
2696            <td style="border: 1px solid black">An Activity is deleted in TermTime (via UI or API)</td>
2697          </tr>
2698          <tr style="border: 1px solid black">
2699            <td style="border: 1px solid black">activity.new</td>
2700            <td style="border: 1px solid black">An Activity is created in TermTime</td>
2701          </tr>
2702          <tr style="border: 1px solid black">
2703            <td style="border: 1px solid black">activity.updated</td>
2704            <td style="border: 1px solid black">An Activity is updated</td>
2705          </tr>
2706          <tr style="border: 1px solid black">
2707            <td style="border: 1px solid black">booking.deleted</td>
2708            <td style="border: 1px solid black">A Booking is deleted in TermTime (via UI or API)</td>
2709          </tr>
2710          <tr style="border: 1px solid black">
2711            <td style="border: 1px solid black">booking.new</td>
2712            <td style="border: 1px solid black">A Booking is created in TermTime</td>
2713          </tr>
2714          <tr style="border: 1px solid black">
2715            <td style="border: 1px solid black">booking.updated</td>
2716            <td style="border: 1px solid black">A Booking is updated</td>
2717          </tr>
2718          <tr style="border: 1px solid black">
2719            <td style="border: 1px solid black">timetable.group.updated</td>
2720            <td style="border: 1px solid black">A change to an Activity changes the schedule for one or more Student Groups</td>
2721          </tr>
2722          <tr style="border: 1px solid black">
2723            <td style="border: 1px solid black">timetable.room.updated</td>
2724            <td style="border: 1px solid black">A change to an Activity changes the schedule for one or more Rooms</td>
2725          </tr>
2726          <tr style="border: 1px solid black">
2727            <td style="border: 1px solid black">timetable.staff.updated</td>
2728            <td style="border: 1px solid black">A change to an Activity changes the schedule for one or more Staff</td>
2729          </tr>
2730          <tr style="border: 1px solid black">
2731            <td style="border: 1px solid black">timetable.student.updated</td>
2732            <td style="border: 1px solid black">A change to an Activity changes the schedule for one or more Students</td>
2733          </tr>
2734          <tr style="border: 1px solid black">
2735            <td style="border: 1px solid black">group.new</td>
2736            <td style="border: 1px solid black">A new student group is created in TermTime (via UI or API)</td>
2737          </tr>
2738          <tr style="border: 1px solid black">
2739            <td style="border: 1px solid black">group.deleted</td>
2740            <td style="border: 1px solid black">A student group is deleted in TermTime (via UI or API)</td>
2741          </tr>
2742          <tr style="border: 1px solid black">
2743            <td style="border: 1px solid black">group.changed</td>
2744            <td style="border: 1px solid black">Students are added or removed from a student group</td>
2745          </tr>
2746          <tr style="border: 1px solid black">
2747            <td style="border: 1px solid black">group.updated</td>
2748            <td style="border: 1px solid black">A change is made to a student group</td>
2749          </tr>
2750          <tr style="border: 1px solid black">
2751            <td style="border: 1px solid black">offer.new</td>
2752            <td style="border: 1px solid black">A new Module Offer is created in TermTime (via UI or API)</td>
2753          </tr>
2754          <tr style="border: 1px solid black">
2755            <td style="border: 1px solid black">offer.deleted</td>
2756            <td style="border: 1px solid black">A Module Offer is deleted in TermTime (via UI or API)</td>
2757          </tr>
2758          <tr style="border: 1px solid black">
2759            <td style="border: 1px solid black">offer.updated</td>
2760            <td style="border: 1px solid black">A change is made to a Module Offer. This includes adding or removing tags</td>
2761          </tr>
2762        </table>
2763        <p>The next section lists parameters that are sent in the query.  Alternatively, and for stronger
2764        security, all these parameters except 'c' can be send the request body formatted using
2765        JSON.  For example:
2766          <code>{"t":"activity.new","h":"XXX-AUTH-TOKEN: abc123","u":"https://myfoo.com","v":"PUT","e":"paul@foo.com"}</code>
2767        </p>
2768      tags: ["webhook"]
2769      operationId: postWebhookC
2770      parameters:
2771        - $ref: '#/components/parameters/webhookCodeParam'
2772        - $ref: '#/components/parameters/webhookTypeParamReq'
2773        - $ref: '#/components/parameters/webhookHeaderParam'
2774        - $ref: '#/components/parameters/webhookUrlParamReq'
2775        - $ref: '#/components/parameters/webhookVerbParam'
2776        - $ref: '#/components/parameters/webhookEmailParam'
2777      responses:
2778        '200':
2779          $ref: '#/components/responses/OperationSucceeded'
2780        '400':
2781          $ref: '#/components/responses/BadRequest'
2782        '401':
2783          $ref: '#/components/responses/Unauthorized'
2784        '500':
2785          $ref: '#/components/responses/InternalServerError'
2786    put:
2787      summary: Update a webhook
2788      description: |
2789        Used for updating the details of an existing webhook.
2790        The table below describes a list of available webhook types:
2791        <br>
2792        <table style="border: 1px solid black">
2793          <tr style="border: 1px solid black">
2794            <th style="border: 1px solid black">Type</th>
2795            <th style="border: 1px solid black">Fires when...</th>
2796          </tr>
2797          <tr style="border: 1px solid black">
2798            <td style="border: 1px solid black">activity.deleted</td>
2799            <td style="border: 1px solid black">An Activity is deleted in TermTime (via UI or API)</td>
2800          </tr>
2801          <tr style="border: 1px solid black">
2802            <td style="border: 1px solid black">activity.new</td>
2803            <td style="border: 1px solid black">An Activity is created in TermTime</td>
2804          </tr>
2805          <tr style="border: 1px solid black">
2806            <td style="border: 1px solid black">activity.updated</td>
2807            <td style="border: 1px solid black">An Activity is updated</td>
2808          </tr>
2809          <tr style="border: 1px solid black">
2810            <td style="border: 1px solid black">booking.deleted</td>
2811            <td style="border: 1px solid black">A Booking is deleted in TermTime (via UI or API)</td>
2812          </tr>
2813          <tr style="border: 1px solid black">
2814            <td style="border: 1px solid black">booking.new</td>
2815            <td style="border: 1px solid black">A Booking is created in TermTime</td>
2816          </tr>
2817          <tr style="border: 1px solid black">
2818            <td style="border: 1px solid black">booking.updated</td>
2819            <td style="border: 1px solid black">A Booking is updated</td>
2820          </tr>
2821          <tr style="border: 1px solid black">
2822            <td style="border: 1px solid black">timetable.group.updated</td>
2823            <td style="border: 1px solid black">A change to an Activity changes the schedule for one or more Student Groups</td>
2824          </tr>
2825          <tr style="border: 1px solid black">
2826            <td style="border: 1px solid black">timetable.room.updated</td>
2827            <td style="border: 1px solid black">A change to an Activity changes the schedule for one or more Rooms</td>
2828          </tr>
2829          <tr style="border: 1px solid black">
2830            <td style="border: 1px solid black">timetable.staff.updated</td>
2831            <td style="border: 1px solid black">A change to an Activity changes the schedule for one or more Staff</td>
2832          </tr>
2833          <tr style="border: 1px solid black">
2834            <td style="border: 1px solid black">timetable.student.updated</td>
2835            <td style="border: 1px solid black">A change to an Activity changes the schedule for one or more Students</td>
2836          </tr>
2837          <tr style="border: 1px solid black">
2838            <td style="border: 1px solid black">group.new</td>
2839            <td style="border: 1px solid black">A new student group is created in TermTime (via UI or API)</td>
2840          </tr>
2841          <tr style="border: 1px solid black">
2842            <td style="border: 1px solid black">group.delete</td>
2843            <td style="border: 1px solid black">A student group is deleted in TermTime (via UI or API)</td>
2844          </tr>
2845          <tr style="border: 1px solid black">
2846            <td style="border: 1px solid black">group.changed</td>
2847            <td style="border: 1px solid black">Students are added or removed from a student group</td>
2848          </tr>
2849          <tr style="border: 1px solid black">
2850            <td style="border: 1px solid black">group.updated</td>
2851            <td style="border: 1px solid black">A change is made to a student group</td>
2852          </tr>
2853          <tr style="border: 1px solid black">
2854            <td style="border: 1px solid black">offer.new</td>
2855            <td style="border: 1px solid black">A new Module Offer is created in TermTime (via UI or API)</td>
2856          </tr>
2857          <tr style="border: 1px solid black">
2858            <td style="border: 1px solid black">offer.deleted</td>
2859            <td style="border: 1px solid black">A Module Offer is deleted in TermTime (via UI or API)</td>
2860          </tr>
2861          <tr style="border: 1px solid black">
2862            <td style="border: 1px solid black">offer.updated</td>
2863            <td style="border: 1px solid black">A change is made to a Module Offer. This includes adding or removing tags</td>
2864          </tr>
2865        </table>
2866        <p>The next section lists parameters that are sent in the query.  Alternatively, and for stronger
2867        security, all these parameters except 'c' can be send the request body formatted using
2868        JSON.  For example:
2869          <code>{"t":"activity.new","h":"XXX-AUTH-TOKEN: abc123","u":"https://myfoo.com","v":"PUT","e":"paul@foo.com"}</code>
2870        </p>
2871      tags: ["webhook"]
2872      operationId: putWebhookC
2873      parameters:
2874        - $ref: '#/components/parameters/webhookCodeParam'
2875        - $ref: '#/components/parameters/webhookHeaderParam'
2876        - $ref: '#/components/parameters/webhookUrlParam'
2877        - $ref: '#/components/parameters/webhookVerbParam'
2878        - $ref: '#/components/parameters/webhookEmailParam'
2879      responses:
2880        '200':
2881          description: Success - the webhook was updated
2882        '400':
2883          $ref: '#/components/responses/BadRequest'
2884        '401':
2885          $ref: '#/components/responses/Unauthorized'
2886        '500':
2887          $ref: '#/components/responses/InternalServerError'
2888    delete:
2889      summary: Delete a webhook
2890      description: Delete an existing webhook
2891      tags: ["webhook"]
2892      operationId: deleteWebhookC
2893      parameters:
2894        - $ref: '#/components/parameters/webhookCodeParam'
2895      responses:
2896        '200':
2897          description: Success - the webhook was deleted
2898        '400':
2899          $ref: '#/components/responses/BadRequest'
2900        '401':
2901          $ref: '#/components/responses/Unauthorized'
2902        '500':
2903          $ref: '#/components/responses/InternalServerError'
2904  /webhook/timetable:
2905    get:
2906      summary: Get all timetable-related webhooks
2907      description: Returns the list of all webhooks associated with the supplied API key.
2908      tags: ["webhook"]
2909      operationId: getWebhookTimetable
2910      responses:
2911        '200':
2912          description: A JSON array of JSON objects describing each webhook.
2913          content:
2914            application/json:
2915              schema:
2916                type: array
2917                items:
2918                  $ref: '#/components/schemas/Webhook'
2919  '/webhook/timetable/{c}':
2920    get:
2921      summary: Get one timetable-related webhook
2922      description: Returns the identified webhook associated with the supplied API key.
2923      tags: ["webhook"]
2924      operationId: getWebhookTimetableC
2925      parameters:
2926        - $ref: '#/components/parameters/webhookCodeParam'
2927      responses:
2928        '200':
2929          description: A JSON object describing the webhook.
2930          content:
2931            application/json:
2932              schema:
2933                $ref: '#/components/schemas/Webhook'
2934        '400':
2935          $ref: '#/components/responses/BadRequest'
2936        '401':
2937          $ref: '#/components/responses/Unauthorized'
2938        '500':
2939          $ref: '#/components/responses/InternalServerError'
2940    post:
2941      summary: Register a new timetable-related webhook.
2942      description: |
2943        The customer registers a new webhook with Semestry.
2944        <p>The next section lists parameters that are sent in the query.  Alternatively, and for stronger
2945        security, all these parameters except 'c' can be send the request body formatted using
2946        JSON.  For example:
2947          <code>{"t":"activity.new","h":"XXX-AUTH-TOKEN: abc123","u":"https://myfoo.com","v":"PUT","e":"paul@foo.com"}</code>
2948        </p>
2949      tags: ["webhook"]
2950      operationId: postWebhookTimetableC
2951      parameters:
2952        - $ref: '#/components/parameters/webhookCodeParam'
2953        - $ref: '#/components/parameters/webhookTypeParamReq'
2954        - $ref: '#/components/parameters/webhookHeaderParam'
2955        - $ref: '#/components/parameters/webhookUrlParamReq'
2956        - $ref: '#/components/parameters/webhookVerbParam'
2957        - $ref: '#/components/parameters/webhookEmailParam'
2958      responses:
2959        '200':
2960          $ref: '#/components/responses/OperationSucceeded'
2961        '400':
2962          $ref: '#/components/responses/BadRequest'
2963        '401':
2964          $ref: '#/components/responses/Unauthorized'
2965        '500':
2966          $ref: '#/components/responses/InternalServerError'
2967    put:
2968      summary: Update an existing timetable-related webhook.
2969      description: |
2970        The customer updates an existing webhook with Semestry.
2971        <p>The next section lists parameters that are sent in the query.  Alternatively, and for stronger
2972        security, all these parameters except 'c' can be send the request body formatted using
2973        JSON.  For example:
2974          <code>{"t":"activity.new","h":"XXX-AUTH-TOKEN: abc123","u":"https://myfoo.com","v":"PUT","e":"paul@foo.com"}</code>
2975        </p>
2976      tags: ["webhook"]
2977      operationId: putWebhookTimetableC
2978      parameters:
2979        - $ref: '#/components/parameters/webhookCodeParam'
2980        - $ref: '#/components/parameters/webhookHeaderParam'
2981        - $ref: '#/components/parameters/webhookUrlParam'
2982        - $ref: '#/components/parameters/webhookVerbParam'
2983        - $ref: '#/components/parameters/webhookEmailParam'
2984      responses:
2985        '200':
2986          description: Success - the webhook was updated
2987        '400':
2988          $ref: '#/components/responses/BadRequest'
2989        '401':
2990          $ref: '#/components/responses/Unauthorized'
2991        '500':
2992          $ref: '#/components/responses/InternalServerError'
2993    delete:
2994      summary: Delete a timetable-related webhook
2995      description: Delete an existing timetable-related webhook.
2996      tags: ["webhook"]
2997      operationId: deleteWebhookTimetableC
2998      parameters:
2999        - $ref: '#/components/parameters/webhookCodeParam'
3000      responses:
3001        '200':
3002          description: Success - the webhook was deleted
3003        '400':
3004          $ref: '#/components/responses/BadRequest'
3005        '401':
3006          $ref: '#/components/responses/Unauthorized'
3007        '500':
3008          $ref: '#/components/responses/InternalServerError'
3009  /campuses:
3010    get:
3011      summary: Get all Campuses
3012      description: Return JSON array of Room objects
3013      tags: ["campus"]
3014      operationId: getCampuses
3015      responses:
3016        '200':
3017          description: A JSON array of Campus objects
3018          content:
3019            application/json:
3020              schema:
3021                type: array
3022                items:
3023                  $ref: '#/components/schemas/Campus'
3024  '/campus/{c}':
3025    get:
3026      summary: Get one Campus
3027      description: Get details for one Campus
3028      tags: ["campus"]
3029      operationId: getCampusC
3030      parameters:
3031        - $ref: '#/components/parameters/campusNameOrCodeParam'
3032        - $ref: '#/components/parameters/locationQueryByNameOrCodeParam'
3033      responses:
3034        '200':
3035          description: A Campus object
3036          content:
3037            application/json:
3038              schema:
3039                $ref: '#/components/schemas/Campus'
3040        '400':
3041          $ref: '#/components/responses/BadRequest'
3042        '401':
3043          $ref: '#/components/responses/Unauthorized'
3044        '500':
3045          $ref: '#/components/responses/InternalServerError'
3046    post:
3047      summary: Create a Campus
3048      description: Create a new Campus
3049      tags: ["campus"]
3050      operationId: postCampusC
3051      parameters:
3052        - $ref: '#/components/parameters/campusNameParam'
3053        - $ref: '#/components/parameters/campusCodeParamReq'
3054      responses:
3055        '200':
3056          $ref: '#/components/responses/OperationSucceeded'
3057        '400':
3058          $ref: '#/components/responses/BadRequest'
3059        '401':
3060          $ref: '#/components/responses/Unauthorized'
3061        '500':
3062          $ref: '#/components/responses/InternalServerError'
3063    put:
3064      summary: Update a Campus
3065      description: Update an existing Campus
3066      tags: ["campus"]
3067      operationId: putCampusC
3068      parameters:
3069        - $ref: '#/components/parameters/campusNameOrCodeParam'
3070        - $ref: '#/components/parameters/campusNewNameParam'
3071        - $ref: '#/components/parameters/campusNewCodeParam'
3072        - $ref: '#/components/parameters/locationQueryByNameOrCodeParam'
3073      responses:
3074        '200':
3075          description: Success - the Campus was updated
3076        '400':
3077          $ref: '#/components/responses/BadRequest'
3078        '401':
3079          $ref: '#/components/responses/Unauthorized'
3080        '500':
3081          $ref: '#/components/responses/InternalServerError'
3082    delete:
3083      summary: Delete a Campus
3084      description: Delete a Campus
3085      tags: ["campus"]
3086      operationId: deleteCampusC
3087      parameters:
3088        - $ref: '#/components/parameters/campusNameOrCodeParam'
3089        - $ref: '#/components/parameters/locationQueryByNameOrCodeParam'
3090      responses:
3091        '200':
3092          description: Success - the Campus was deleted
3093        '400':
3094          $ref: '#/components/responses/BadRequest'
3095        '401':
3096          $ref: '#/components/responses/Unauthorized'
3097        '500':
3098          $ref: '#/components/responses/InternalServerError'
3099  /buildings:
3100    get:
3101      summary: Get all Buildings
3102      description: Return JSON array of Building objects
3103      tags: ["building"]
3104      operationId: getBuildings
3105      responses:
3106        '200':
3107          description: A JSON array of Building objects
3108          content:
3109            application/json:
3110              schema:
3111                type: array
3112                items:
3113                  $ref: '#/components/schemas/Building'
3114  '/building/{b}/{c}':
3115    get:
3116      summary: Get one Building
3117      description: Get details for one Building in the Campus
3118      tags: ["building"]
3119      operationId: getBuildingBC
3120      parameters:
3121        - $ref: '#/components/parameters/buildingNameOrCodeParam'
3122        - $ref: '#/components/parameters/campusNameMayBeOptionalParam'
3123        - $ref: '#/components/parameters/locationQueryByNameOrCodeParam'
3124      responses:
3125        '200':
3126          description: A Building object
3127          content:
3128            application/json:
3129              schema:
3130                $ref: '#/components/schemas/Building'
3131        '400':
3132          $ref: '#/components/responses/BadRequest'
3133        '401':
3134          $ref: '#/components/responses/Unauthorized'
3135        '500':
3136          $ref: '#/components/responses/InternalServerError'
3137    post:
3138      summary: Create a Building
3139      description: Create a new Building
3140      tags: ["building"]
3141      operationId: postBuildingBC
3142      parameters:
3143        - $ref: '#/components/parameters/buildingNameParam'
3144        - $ref: '#/components/parameters/campusNameOrCodeParam'
3145        - $ref: '#/components/parameters/buildingCodeParamReq'
3146        - $ref: '#/components/parameters/locationQueryByNameOrCodeParam'
3147      responses:
3148        '200':
3149          $ref: '#/components/responses/OperationSucceeded'
3150        '400':
3151          $ref: '#/components/responses/BadRequest'
3152        '401':
3153          $ref: '#/components/responses/Unauthorized'
3154        '500':
3155          $ref: '#/components/responses/InternalServerError'
3156    put:
3157      summary: Update a Building
3158      description: Update an existing Building
3159      tags: ["building"]
3160      operationId: putBuildingBC
3161      parameters:
3162        - $ref: '#/components/parameters/buildingNameOrCodeParam'
3163        - $ref: '#/components/parameters/campusNameMayBeOptionalParam'
3164        - $ref: '#/components/parameters/newNameParam'
3165        - $ref: '#/components/parameters/newCodeParam'
3166        - $ref: '#/components/parameters/campusNewNameOrCodeParam'
3167        - $ref: '#/components/parameters/locationQueryByNameOrCodeParam'
3168      responses:
3169        '200':
3170          description: Success - the Building was updated
3171        '400':
3172          $ref: '#/components/responses/BadRequest'
3173        '401':
3174          $ref: '#/components/responses/Unauthorized'
3175        '500':
3176          $ref: '#/components/responses/InternalServerError'
3177    delete:
3178      summary: Delete a Building
3179      description: Delete a Building
3180      tags: ["building"]
3181      operationId: deleteBuildingBC
3182      parameters:
3183        - $ref: '#/components/parameters/buildingNameOrCodeParam'
3184        - $ref: '#/components/parameters/campusNameMayBeOptionalParam'
3185        - $ref: '#/components/parameters/locationQueryByNameOrCodeParam'
3186      responses:
3187        '200':
3188          description: Success - the Building was deleted
3189        '400':
3190          $ref: '#/components/responses/BadRequest'
3191        '401':
3192          $ref: '#/components/responses/Unauthorized'
3193        '500':
3194          $ref: '#/components/responses/InternalServerError'
3195  /floors:
3196    get:
3197      summary: Get all Floors
3198      description: Return JSON array of all Floor objects
3199      tags: ["floor"]
3200      operationId: getFloors
3201      responses:
3202        '200':
3203          description: A JSON array of Floor objects
3204          content:
3205            application/json:
3206              schema:
3207                type: array
3208                items:
3209                  $ref: '#/components/schemas/Floor'
3210  '/floor/{f}/{b}/{c}':
3211    get:
3212      summary: Get one Floor
3213      description: Get details for one Floor in the Building in the Campus
3214      tags: ["floor"]
3215      operationId: getFloorFBC
3216      parameters:
3217        - $ref: '#/components/parameters/floorNameOrCodeParam'
3218        - $ref: '#/components/parameters/buildingNameMayBeOptionalParam'
3219        - $ref: '#/components/parameters/campusNameMayBeOptionalParam'
3220        - $ref: '#/components/parameters/locationQueryByNameOrCodeParam'
3221      responses:
3222        '200':
3223          description: A Floor object
3224          content:
3225            application/json:
3226              schema:
3227                $ref: '#/components/schemas/Floor'
3228        '400':
3229          $ref: '#/components/responses/BadRequest'
3230        '401':
3231          $ref: '#/components/responses/Unauthorized'
3232        '500':
3233          $ref: '#/components/responses/InternalServerError'
3234    post:
3235      summary: Create a Floor
3236      description: Create a new Floor
3237      tags: ["floor"]
3238      operationId: postFloorFBC
3239      parameters:
3240        - $ref: '#/components/parameters/floorNameParam'
3241        - $ref: '#/components/parameters/buildingNameOrCodeParam'
3242        - $ref: '#/components/parameters/campusNameOrCodeParam'
3243        - $ref: '#/components/parameters/floorCodeParam'
3244        - $ref: '#/components/parameters/locationQueryByNameOrCodeParam'
3245      responses:
3246        '200':
3247          $ref: '#/components/responses/OperationSucceeded'
3248        '400':
3249          $ref: '#/components/responses/BadRequest'
3250        '401':
3251          $ref: '#/components/responses/Unauthorized'
3252        '500':
3253          $ref: '#/components/responses/InternalServerError'
3254    put:
3255      summary: Update a floor
3256      description: Update an existing floor
3257      tags: ["floor"]
3258      operationId: putFloorFBC
3259      parameters:
3260        - $ref: '#/components/parameters/floorNameOrCodeParam'
3261        - $ref: '#/components/parameters/buildingNameMayBeOptionalParam'
3262        - $ref: '#/components/parameters/campusNameMayBeOptionalParam'
3263        - $ref: '#/components/parameters/newNameParam'
3264        - $ref: '#/components/parameters/newCodeParam'
3265        - $ref: '#/components/parameters/buildingNewNameOrCodeParam'
3266        - $ref: '#/components/parameters/locationQueryByNameOrCodeParam'
3267      responses:
3268        '200':
3269          description: Success - the Floor was updated
3270        '400':
3271          $ref: '#/components/responses/BadRequest'
3272        '401':
3273          $ref: '#/components/responses/Unauthorized'
3274        '500':
3275          $ref: '#/components/responses/InternalServerError'
3276    delete:
3277      summary: Delete a floor
3278      description: Delete a floor
3279      tags: ["floor"]
3280      operationId: deleteFloorFBC
3281      parameters:
3282        - $ref: '#/components/parameters/floorNameOrCodeParam'
3283        - $ref: '#/components/parameters/buildingNameMayBeOptionalParam'
3284        - $ref: '#/components/parameters/campusNameMayBeOptionalParam'
3285        - $ref: '#/components/parameters/locationQueryByNameOrCodeParam'
3286      responses:
3287        '200':
3288          description: Success - the Floor was deleted
3289        '400':
3290          $ref: '#/components/responses/BadRequest'
3291        '401':
3292          $ref: '#/components/responses/Unauthorized'
3293        '500':
3294          $ref: '#/components/responses/InternalServerError'
3295  /rooms:
3296    get:
3297      summary: Get all Rooms
3298      description: Return JSON array of all Room objects
3299      tags: ["room"]
3300      operationId: getRooms
3301      requestBody:
3302        description: List of buildings to filter results by.
3303        required: false
3304        content:
3305          application/json:
3306            schema:
3307              $ref: '#/components/schemas/BuildingsArray'
3308      responses:
3309        '200':
3310          description: A JSON array of Room objects
3311          content:
3312            application/json:
3313              schema:
3314                type: array
3315                items:
3316                  $ref: '#/components/schemas/Room'
3317  '/room/{c}':
3318    get:
3319      summary: Get one Room
3320      description: Get details for one Room
3321      tags: ["room"]
3322      operationId: getRoomC
3323      parameters:
3324        - $ref: '#/components/parameters/roomCodeParamReq'
3325      responses:
3326        '200':
3327          description: A Room object
3328          content:
3329            application/json:
3330              schema:
3331                $ref: '#/components/schemas/Room'
3332        '400':
3333          $ref: '#/components/responses/BadRequest'
3334        '401':
3335          $ref: '#/components/responses/Unauthorized'
3336        '500':
3337          $ref: '#/components/responses/InternalServerError'
3338    post:
3339      summary: Create a Room
3340      description: Create a new Room
3341      tags: ["room"]
3342      operationId: postRoomC
3343      parameters:
3344        - $ref: '#/components/parameters/roomCodeParamReq'
3345        - $ref: '#/components/parameters/roomNameParamReq'
3346        - $ref: '#/components/parameters/floorNameParamQReq'
3347        - $ref: '#/components/parameters/buildingNameParamQReq'
3348        - $ref: '#/components/parameters/campusNameParamQReq'
3349        - $ref: '#/components/parameters/departmentCodeParamReq'
3350        - $ref: '#/components/parameters/CapabilitiesParam'
3351        - $ref: '#/components/parameters/SpecialRequirementParam'
3352        - $ref: '#/components/parameters/notesParamQ'
3353        - $ref: '#/components/parameters/user1Param'
3354        - $ref: '#/components/parameters/user2Param'
3355        - $ref: '#/components/parameters/user3Param'
3356      requestBody:
3357        description: Room Capacities
3358        required: false
3359        content:
3360          application/json:
3361            schema:
3362              $ref: '#/components/schemas/RoomCapacities'
3363      responses:
3364        '200':
3365          $ref: '#/components/responses/OperationSucceeded'
3366        '400':
3367          $ref: '#/components/responses/BadRequest'
3368        '401':
3369          $ref: '#/components/responses/Unauthorized'
3370        '500':
3371          $ref: '#/components/responses/InternalServerError'
3372    put:
3373      summary: Update a Room
3374      description: Update an existing Room
3375      tags: ["room"]
3376      operationId: putRoomC
3377      parameters:
3378        - $ref: '#/components/parameters/roomCodeParamReq'
3379        - $ref: '#/components/parameters/nameParam'
3380        - $ref: '#/components/parameters/floorNameParamQ'
3381        - $ref: '#/components/parameters/buildingNameParamQ'
3382        - $ref: '#/components/parameters/departmentCodeParamOld'
3383        - $ref: '#/components/parameters/campusNameParamQ'
3384        - $ref: '#/components/parameters/CapabilitiesParam'
3385        - $ref: '#/components/parameters/SpecialRequirementParam'
3386        - $ref: '#/components/parameters/notesParamQ'
3387        - $ref: '#/components/parameters/user1Param'
3388        - $ref: '#/components/parameters/user2Param'
3389        - $ref: '#/components/parameters/user3Param'
3390        - $ref: '#/components/parameters/toDeleteParam'
3391      requestBody:
3392        description: Room Capacities
3393        required: false
3394        content:
3395          application/json:
3396            schema:
3397              $ref: '#/components/schemas/RoomCapacities'
3398      responses:
3399        '200':
3400          description: Success - the Room was updated
3401        '400':
3402          $ref: '#/components/responses/BadRequest'
3403        '401':
3404          $ref: '#/components/responses/Unauthorized'
3405        '500':
3406          $ref: '#/components/responses/InternalServerError'
3407    delete:
3408      summary: Delete a Room
3409      description: Delete a Room
3410      tags: ["room"]
3411      operationId: deleteRoomC
3412      parameters:
3413        - $ref: '#/components/parameters/roomCodeParamReq'
3414      responses:
3415        '200':
3416          description: Success - the Room was deleted
3417        '400':
3418          $ref: '#/components/responses/BadRequest'
3419        '401':
3420          $ref: '#/components/responses/Unauthorized'
3421        '500':
3422          $ref: '#/components/responses/InternalServerError'
3423  '/repeatgroup/{c}':
3424    get:
3425      summary: Get one Repeat Group
3426      description: Get details for the Activities in the specified Repeat Group
3427      tags: ["repeat group"]
3428      operationId: getRepeatgroupC
3429      parameters:
3430        - $ref: '#/components/parameters/activityCodeParam'
3431      responses:
3432        '200':
3433          description: A JSON array of Activity objects
3434          content:
3435            application/json:
3436              schema:
3437                type: array
3438                items:
3439                  $ref: '#/components/schemas/ActivityResponse'
3440  '/exceptiongroup/{c}':
3441    get:
3442      summary: Get one Exception Group
3443      description: Get details for the Activities in the specified Exception Group
3444      tags: ["repeat group"]
3445      operationId: getExceptiongroupC
3446      parameters:
3447        - $ref: '#/components/parameters/activityCodeParam'
3448      responses:
3449        '200':
3450          description: A JSON array of Activity objects
3451          content:
3452            application/json:
3453              schema:
3454                type: array
3455                items:
3456                  $ref: '#/components/schemas/ActivityResponse'
3457  /activitytemplates:
3458    get:
3459      summary: Get all Activity Templates
3460      description: Get the list of all Activity Templates
3461      tags: ["activity templates"]
3462      operationId: getActivitytemplates
3463      responses:
3464        '200':
3465          description: A JSON array of Activity Template objects
3466          content:
3467            application/json:
3468              schema:
3469                type: array
3470                items:
3471                  $ref: '#/components/schemas/ActivityTemplate'
3472  '/activitytemplate/{c}':
3473    get:
3474      summary: Get one Activity Template
3475      description: Get the details for one Activity Templates
3476      tags: ["activity templates"]
3477      operationId: getActivitytemplateC
3478      parameters:
3479        - $ref: '#/components/parameters/activityTemplateCodeParam'
3480      responses:
3481        '200':
3482          description: A JSON array of Activity Template objects
3483          content:
3484            application/json:
3485              schema:
3486                $ref: '#/components/schemas/ActivityTemplate'
3487    delete:
3488      summary: Delete an Activity Teamplate
3489      description: Delete an Activity Teamplate
3490      tags: ["activity templates"]
3491      operationId: deleteActivitytemplateC
3492      parameters:
3493        - $ref: '#/components/parameters/activityTemplateCodeParam'
3494      responses:
3495        '200':
3496          description: Success - the Activity Template was deleted
3497        '400':
3498          $ref: '#/components/responses/BadRequest'
3499        '401':
3500          $ref: '#/components/responses/Unauthorized'
3501        '500':
3502          $ref: '#/components/responses/InternalServerError'
3503  /department:
3504    get:
3505      summary: Get all Departments [deprecated]
3506      description: Get the list of all Departments (deprecated, use /departments instead)
3507      tags: ["department"]
3508      operationId: getDepartment
3509      responses:
3510        '200':
3511          description: A JSON array of Departments
3512          content:
3513            application/json:
3514              schema:
3515                type: array
3516                items:
3517                  $ref: '#/components/schemas/Department'
3518  /contactrequirements:
3519    get:
3520      summary: Get all Contact Requirements
3521      description: Get the list of all Contact Requirements
3522      tags: ["contact requirement"]
3523      operationId: getContactrequirements
3524      responses:
3525        '200':
3526          description: A JSON array of Contact Requirements
3527          content:
3528            application/json:
3529              schema:
3530                type: array
3531                items:
3532                  $ref: '#/components/schemas/ContactRequirement'
3533  '/contactrequirement/{c}':
3534    get:
3535      summary: Get one Contact Requirement
3536      description: Get details for one Contact Requirement
3537      tags: ["contact requirement"]
3538      operationId: getContactrequirementC
3539      parameters:
3540        - $ref: '#/components/parameters/contactRequirementCodeParamReq'
3541        - $ref: '#/components/parameters/useAltCodeParam'
3542      responses:
3543        '200':
3544          description: A Contact Requirement object
3545          content:
3546            application/json:
3547              schema:
3548                $ref: '#/components/schemas/ContactRequirement'
3549        '400':
3550          $ref: '#/components/responses/BadRequest'
3551        '401':
3552          $ref: '#/components/responses/Unauthorized'
3553        '500':
3554          $ref: '#/components/responses/InternalServerError'
3555    post:
3556      summary: Create a Contact Requirement
3557      description: Create a new Contact Requirement
3558      tags: ["contact requirement"]
3559      operationId: postContactrequirementC
3560      parameters:
3561        - $ref: '#/components/parameters/contactRequirementCodeParamReq'
3562        - $ref: '#/components/parameters/contactRequirementNameParamReq'
3563        - $ref: '#/components/parameters/moduleCodeQueryParamReq'
3564        - $ref: '#/components/parameters/activityTypeQueryParamReq'
3565        - $ref: '#/components/parameters/hoursQueryParam'
3566        - $ref: '#/components/parameters/user1QueryParam'
3567        - $ref: '#/components/parameters/user2QueryParam'
3568        - $ref: '#/components/parameters/user3QueryParam'
3569        - $ref: '#/components/parameters/capsParam'
3570        - $ref: '#/components/parameters/staffParam'
3571        - $ref: '#/components/parameters/weekTemplateParam'
3572        - $ref: '#/components/parameters/contactRequirementAltCodeParam'
3573        - $ref: '#/components/parameters/useModuleAltCodeParam'
3574        - $ref: '#/components/parameters/planSizeQueryParam'
3575      responses:
3576        '200':
3577          $ref: '#/components/responses/OperationSucceeded'
3578        '400':
3579          $ref: '#/components/responses/BadRequest'
3580        '401':
3581          $ref: '#/components/responses/Unauthorized'
3582        '500':
3583          $ref: '#/components/responses/InternalServerError'
3584    put:
3585      summary: Update a Contact Requirement
3586      description: Update an existing Contact Requirement
3587      tags: ["contact requirement"]
3588      operationId: putContactrequirementC
3589      parameters:
3590        - $ref: '#/components/parameters/contactRequirementCodeParamReq'
3591        - $ref: '#/components/parameters/useAltCodeParam'
3592        - $ref: '#/components/parameters/contactRequirementNameParam'
3593        - $ref: '#/components/parameters/moduleCodeQueryParam3'
3594        - $ref: '#/components/parameters/activityTypeQueryParam'
3595        - $ref: '#/components/parameters/hoursQueryParam'
3596        - $ref: '#/components/parameters/user1QueryParam'
3597        - $ref: '#/components/parameters/user2QueryParam'
3598        - $ref: '#/components/parameters/user3QueryParam'
3599        - $ref: '#/components/parameters/capsParam'
3600        - $ref: '#/components/parameters/staffParam'
3601        - $ref: '#/components/parameters/weekTemplateParam'
3602        - $ref: '#/components/parameters/contactRequirementAltCodeParam'
3603        - $ref: '#/components/parameters/useModuleAltCodeParam'
3604        - $ref: '#/components/parameters/planSizeQueryParam'
3605        - $ref: '#/components/parameters/contactRequirementCodeQueryParam'
3606      responses:
3607        '200':
3608          description: Success - the Contact Requirement was updated
3609        '400':
3610          $ref: '#/components/responses/BadRequest'
3611        '401':
3612          $ref: '#/components/responses/Unauthorized'
3613        '500':
3614          $ref: '#/components/responses/InternalServerError'
3615    delete:
3616      summary: Delete a Contact Requirement
3617      description: Delete a Contact Requirement
3618      tags: ["contact requirement"]
3619      operationId: deleteContactrequirementC
3620      parameters:
3621        - $ref: '#/components/parameters/contactRequirementCodeParamReq'
3622        - $ref: '#/components/parameters/useAltCodeParam'
3623      responses:
3624        '200':
3625          description: Success - the Contact Requirement was deleted
3626        '400':
3627          $ref: '#/components/responses/BadRequest'
3628        '401':
3629          $ref: '#/components/responses/Unauthorized'
3630        '500':
3631          $ref: '#/components/responses/InternalServerError'
3632  /staffpools:
3633    get:
3634      summary: Get all Staff Pools
3635      description: Return JSON array of Staff Pools
3636      tags: ["staff pool"]
3637      operationId: getStaffpools
3638      responses:
3639        '200':
3640          description: A JSON array of Staff Pools
3641          content:
3642            application/json:
3643              schema:
3644                type: array
3645                items:
3646                  $ref: '#/components/schemas/StaffPool'
3647  '/staffpool/module/{c}':
3648    get:
3649      summary: Get Staff in one Module's Pool
3650      description: Get the Staff in the Module's Pool
3651      tags: ["staff pool"]
3652      operationId: getStaffpoolModuleC
3653      parameters:
3654        - $ref: '#/components/parameters/moduleCodeParam'
3655      responses:
3656        '200':
3657          description: The list of Staff in the Module's Pool
3658          content:
3659            application/json:
3660              schema:
3661                $ref: '#/components/schemas/StaffList'
3662        '400':
3663          $ref: '#/components/responses/BadRequest'
3664        '401':
3665          $ref: '#/components/responses/Unauthorized'
3666        '500':
3667          $ref: '#/components/responses/InternalServerError'
3668  '/staffpool/staff/{c}':
3669    get:
3670      summary: Get Modules for one Staff in Pool
3671      description: Get the Modules for which the Staff is in a Pool
3672      tags: ["staff pool"]
3673      operationId: getStaffpoolStaffC
3674      parameters:
3675        - $ref: '#/components/parameters/staffCodeParam'
3676      responses:
3677        '200':
3678          description: The list of Modules for which the Staff is in a Pool
3679          content:
3680            application/json:
3681              schema:
3682                $ref: '#/components/schemas/ModuleList'
3683        '400':
3684          $ref: '#/components/responses/BadRequest'
3685        '401':
3686          $ref: '#/components/responses/Unauthorized'
3687        '500':
3688          $ref: '#/components/responses/InternalServerError'
3689  '/staffpool/staff/{sc}/module/{mc}':
3690    post:
3691      summary: Put one Staff into a Module Staff Pool
3692      description: Put the identified Staff member into the identified Module's Staff Pool
3693      tags: ["staff pool"]
3694      operationId: postStaffpoolStaffSCModuleMC
3695      parameters:
3696        - $ref: '#/components/parameters/staffCodeParam2'
3697        - $ref: '#/components/parameters/moduleCodeParam2'
3698      responses:
3699        '200':
3700          $ref: '#/components/responses/OperationSucceeded'
3701        '400':
3702          $ref: '#/components/responses/BadRequest'
3703        '401':
3704          $ref: '#/components/responses/Unauthorized'
3705        '500':
3706          $ref: '#/components/responses/InternalServerError'
3707    delete:
3708      summary: Delete one Staff from a Module Staff Pool
3709      description: Take the identified Staff member out of the identified Module's Staff Pool
3710      tags: ["staff pool"]
3711      operationId: deleteStaffpoolStaffSCModuleMC
3712      parameters:
3713        - $ref: '#/components/parameters/staffCodeParam2'
3714        - $ref: '#/components/parameters/moduleCodeParam2'
3715      responses:
3716        '200':
3717          description: Success - the student was removed from the group
3718        '400':
3719          $ref: '#/components/responses/BadRequest'
3720        '401':
3721          $ref: '#/components/responses/Unauthorized'
3722        '500':
3723          $ref: '#/components/responses/InternalServerError'
3724  /timeframes:
3725    get:
3726      summary: Get all Timeframes
3727      description: Get the list of all Timeframes
3728      tags: ["timeframe"]
3729      operationId: getTimeframes
3730      responses:
3731        '200':
3732          description: A JSON array of Timeframes
3733          content:
3734            application/json:
3735              schema:
3736                type: array
3737                items:
3738                  $ref: '#/components/schemas/TimeFrame'
3739  '/timeframe/{c}':
3740    get:
3741      summary: Get one Timeframe
3742      description: Get details for one Timeframe
3743      tags: ["timeframe"]
3744      operationId: getTimeframeC
3745      parameters:
3746        - $ref: '#/components/parameters/timeframeCodeParamP'
3747      responses:
3748        '200':
3749          description: A Timeframe object
3750          content:
3751            application/json:
3752              schema:
3753                $ref: '#/components/schemas/TimeFrame'
3754        '400':
3755          $ref: '#/components/responses/BadRequest'
3756        '401':
3757          $ref: '#/components/responses/Unauthorized'
3758        '500':
3759          $ref: '#/components/responses/InternalServerError'
3760    post:
3761      summary: Create a Timeframe
3762      description: >-
3763        A first and last week must be provided with the 'f' and 'l' query
3764        parameters or alternatively start and end date with the 'start' and
3765        'end' query parameters
3766      tags: ["timeframe"]
3767      operationId: postTimeframeC
3768      parameters:
3769        - $ref: '#/components/parameters/timeframeCodeParamP'
3770        - $ref: '#/components/parameters/timeframeNameParamReq'
3771        - $ref: '#/components/parameters/timeframeFirstParam'
3772        - $ref: '#/components/parameters/timeframeLastParam'
3773        - $ref: '#/components/parameters/timeframeStartParam'
3774        - $ref: '#/components/parameters/timeframeEndParam'
3775      responses:
3776        '200':
3777          $ref: '#/components/responses/OperationSucceeded'
3778        '400':
3779          $ref: '#/components/responses/BadRequest'
3780        '401':
3781          $ref: '#/components/responses/Unauthorized'
3782        '500':
3783          $ref: '#/components/responses/InternalServerError'
3784    put:
3785      summary: Update a Timeframe
3786      description: >-
3787        A first and last week must be provided with the 'f' and 'l' query
3788        parameters or alternatively start and end date with the 'start' and
3789        'end' query parameters
3790      tags: ["timeframe"]
3791      operationId: putTimeframeC
3792      parameters:
3793        - $ref: '#/components/parameters/timeframeCodeParamP'
3794        - $ref: '#/components/parameters/timeframeNameParam'
3795        - $ref: '#/components/parameters/timeframeFirstParam'
3796        - $ref: '#/components/parameters/timeframeLastParam'
3797        - $ref: '#/components/parameters/timeframeStartParam'
3798        - $ref: '#/components/parameters/timeframeEndParam'
3799      responses:
3800        '200':
3801          description: Success - the Timeframe was updated
3802        '400':
3803          $ref: '#/components/responses/BadRequest'
3804        '401':
3805          $ref: '#/components/responses/Unauthorized'
3806        '500':
3807          $ref: '#/components/responses/InternalServerError'
3808    delete:
3809      summary: Delete a Timeframe
3810      description: Delete an existing Timeframe
3811      tags: ["timeframe"]
3812      operationId: deleteTimeframeC
3813      parameters:
3814        - $ref: '#/components/parameters/timeframeCodeParamP'
3815      responses:
3816        '200':
3817          description: Success - the Timeframe was deleted
3818        '400':
3819          $ref: '#/components/responses/BadRequest'
3820        '401':
3821          $ref: '#/components/responses/Unauthorized'
3822        '500':
3823          $ref: '#/components/responses/InternalServerError'
3824  /activitytypes:
3825    get:
3826      summary: Get all Activity Types
3827      description: Get the list of all Activity Types
3828      tags: ["activity type"]
3829      operationId: getActivitytypes
3830      responses:
3831        '200':
3832          description: A JSON array of Activity Types
3833          content:
3834            application/json:
3835              schema:
3836                type: array
3837                items:
3838                  $ref: '#/components/schemas/ActivityType'
3839  '/activitytype/{c}':
3840    get:
3841      summary: Get one Activity Type
3842      description: Get details for one Activity Type
3843      tags: ["activity type"]
3844      operationId: getActivitytypeC
3845      parameters:
3846        - $ref: '#/components/parameters/activityTypeCodeParam'
3847      responses:
3848        '200':
3849          description: An Activity Type object
3850          content:
3851            application/json:
3852              schema:
3853                $ref: '#/components/schemas/ActivityType'
3854        '400':
3855          $ref: '#/components/responses/BadRequest'
3856        '401':
3857          $ref: '#/components/responses/Unauthorized'
3858        '500':
3859          $ref: '#/components/responses/InternalServerError'
3860    post:
3861      summary: Create an Activity Type
3862      description: Create a new Activity Type
3863      tags: ["activity type"]
3864      operationId: postActivitytypeC
3865      parameters:
3866        - $ref: '#/components/parameters/activityTypeCodeParam'
3867        - $ref: '#/components/parameters/activityTypeNameParam'
3868        - $ref: '#/components/parameters/activityTypeColourParam'
3869      responses:
3870        '200':
3871          $ref: '#/components/responses/OperationSucceeded'
3872        '400':
3873          $ref: '#/components/responses/BadRequest'
3874        '401':
3875          $ref: '#/components/responses/Unauthorized'
3876        '500':
3877          $ref: '#/components/responses/InternalServerError'
3878    delete:
3879      summary: Delete an Activity Type
3880      description: Delete an Activity Type
3881      tags: ["activity type"]
3882      operationId: deleteActivitytypeC
3883      parameters:
3884        - $ref: '#/components/parameters/activityTypeCodeParam'
3885      responses:
3886        '200':
3887          description: Success - the Activity Type was deleted
3888        '400':
3889          $ref: '#/components/responses/BadRequest'
3890        '401':
3891          $ref: '#/components/responses/Unauthorized'
3892        '500':
3893          $ref: '#/components/responses/InternalServerError'
3894  /bookingtypes:
3895    get:
3896      summary: Get all Booking Types
3897      description: Get the list of all Booking Types
3898      tags: ["booking type"]
3899      operationId: getBookingtypes
3900      responses:
3901        '200':
3902          description: A JSON array of Booking Types
3903          content:
3904            application/json:
3905              schema:
3906                type: array
3907                items:
3908                  $ref: '#/components/schemas/BookingType'
3909  /assessmenttypes:
3910    get:
3911      summary: Get all Assessment Types
3912      description: Get the list of all assessment types
3913      tags: ["assessment types"]
3914      operationId: getAssessmenttypes
3915      responses:
3916        '200':
3917          description: A JSON array of assessment types
3918          content:
3919            application/json:
3920              schema:
3921                type: array
3922                items:
3923                  $ref: '#/components/schemas/AssessmentType'
3924  '/assessmenttype/{c}':
3925    get:
3926      summary: Get one Assessment Type
3927      description: Get details for one assessment type
3928      tags: ["assessment types"]
3929      operationId: getAssessmenttypeC
3930      parameters:
3931        - $ref: '#/components/parameters/assessmentTypeCodeParam'
3932      responses:
3933        '200':
3934          description: An assessment type object
3935          content:
3936            application/json:
3937              schema:
3938                $ref: '#/components/schemas/AssessmentType'
3939        '400':
3940          $ref: '#/components/responses/BadRequest'
3941        '401':
3942          $ref: '#/components/responses/Unauthorized'
3943        '500':
3944          $ref: '#/components/responses/InternalServerError'
3945    put:
3946      summary: Update an Assessment Type
3947      description: Update an existing assessment type
3948      tags: ["assessment types"]
3949      operationId: putAssessmenttypeC
3950      parameters:
3951        - $ref: '#/components/parameters/assessmentTypeCodeParam'
3952        - $ref: '#/components/parameters/assessmentTypeNewNameParam'
3953        - $ref: '#/components/parameters/assessmentTypeParentCodeParam'
3954      responses:
3955        '200':
3956          $ref: '#/components/responses/OperationSucceeded'
3957        '400':
3958          $ref: '#/components/responses/BadRequest'
3959        '401':
3960          $ref: '#/components/responses/Unauthorized'
3961        '500':
3962          $ref: '#/components/responses/InternalServerError'
3963    delete:
3964      summary: Delete an Assessment Type
3965      description: Delete an existing assessment type
3966      tags: ["assessment types"]
3967      operationId: deleteAssessmenttypeC
3968      parameters:
3969        - $ref: '#/components/parameters/assessmentTypeCodeParam'
3970      responses:
3971        '200':
3972          description: Success - the assessment type was deleted
3973        '400':
3974          $ref: '#/components/responses/BadRequest'
3975        '401':
3976          $ref: '#/components/responses/Unauthorized'
3977        '500':
3978          $ref: '#/components/responses/InternalServerError'
3979  '/assessmenttype':
3980    post:
3981      summary: Create an assessment type
3982      description: Create a new assessment type
3983      tags: ["assessment types"]
3984      operationId: postAssessmenttypeName
3985      parameters:
3986        - $ref: '#/components/parameters/assessmentTypeNameParam'
3987        - $ref: '#/components/parameters/assessmentTypeParentCodeParam'
3988      responses:
3989        '200':
3990          $ref: '#/components/responses/OperationSucceeded'
3991        '400':
3992          $ref: '#/components/responses/BadRequest'
3993        '401':
3994          $ref: '#/components/responses/Unauthorized'
3995        '500':
3996          $ref: '#/components/responses/InternalServerError'
3997  /roombookings:
3998    get:
3999      summary: Get all room bookings
4000      description: Get the list of all room bookings
4001      tags: ["room booking"]
4002      operationId: getRoombookings
4003      responses:
4004        '200':
4005          description: A JSON array of room bookings
4006          content:
4007            application/json:
4008              schema:
4009                type: array
4010                items:
4011                  $ref: '#/components/schemas/RoomBooking'
4012  '/roombooking/{c}':
4013    get:
4014      summary: Get one Room Booking
4015      description: Get details for one room booking
4016      tags: ["room booking"]
4017      operationId: getRoombookingC
4018      parameters:
4019        - $ref: '#/components/parameters/roomBookingCodeParamVar'
4020        - $ref: '#/components/parameters/queryBookingByParam'
4021      responses:
4022        '200':
4023          description: A room booking object
4024          content:
4025            application/json:
4026              schema:
4027                $ref: '#/components/schemas/RoomBooking'
4028        '400':
4029          $ref: '#/components/responses/BadRequest'
4030        '401':
4031          $ref: '#/components/responses/Unauthorized'
4032        '500':
4033          $ref: '#/components/responses/InternalServerError'
4034    post:
4035      summary: Create a Room Booking
4036      description: Create a new room booking
4037      tags: ["room booking"]
4038      operationId: postRoombookingC
4039      parameters:
4040        - $ref: '#/components/parameters/roomBookingCodeParamFixed'
4041        - $ref: '#/components/parameters/roomBookingDesc'
4042        - $ref: '#/components/parameters/roomBookingDay'
4043        - $ref: '#/components/parameters/roomBookingTime'
4044        - $ref: '#/components/parameters/roomBookingDu'
4045        - $ref: '#/components/parameters/roomBookingWeekPattern'
4046        - $ref: '#/components/parameters/roomBookingOwner'
4047        - $ref: '#/components/parameters/roomBookingContact'
4048        - $ref: '#/components/parameters/roomBookingState'
4049        - $ref: '#/components/parameters/roomBookingCap'
4050        - $ref: '#/components/parameters/roomBookingRooms'
4051        - $ref: '#/components/parameters/roomBookingType'
4052        - $ref: '#/components/parameters/roomBookingStaff'
4053        - $ref: '#/components/parameters/roomBookingStudent'
4054        - $ref: '#/components/parameters/offerNameParamOpt'
4055        - $ref: '#/components/parameters/moduleCodeQueryParam3'
4056        - $ref: '#/components/parameters/offerAltCodeParam'
4057        - $ref: '#/components/parameters/useOfferAltCodeParam'
4058        - $ref: '#/components/parameters/notesParamQ'
4059        - $ref: '#/components/parameters/user1Param'
4060        - $ref: '#/components/parameters/user2Param'
4061        - $ref: '#/components/parameters/user3Param'
4062        - $ref: '#/components/parameters/user4Param'
4063      responses:
4064        '200':
4065          $ref: '#/components/responses/OperationSucceeded'
4066        '400':
4067          $ref: '#/components/responses/BadRequest'
4068        '401':
4069          $ref: '#/components/responses/Unauthorized'
4070        '500':
4071          $ref: '#/components/responses/InternalServerError'
4072    put:
4073      summary: Update a Room Booking
4074      description: Update an existing room booking
4075      tags: ["room booking"]
4076      operationId: putRoombookingC
4077      parameters:
4078        - $ref: '#/components/parameters/roomBookingCodeParamVar'
4079        - $ref: '#/components/parameters/queryBookingByParam'
4080        - $ref: '#/components/parameters/roomBookingDesc2'
4081        - $ref: '#/components/parameters/roomBookingDay2'
4082        - $ref: '#/components/parameters/roomBookingTime2'
4083        - $ref: '#/components/parameters/roomBookingDu2'
4084        - $ref: '#/components/parameters/roomBookingWeekPattern2'
4085        - $ref: '#/components/parameters/roomBookingOwner2'
4086        - $ref: '#/components/parameters/roomBookingContact'
4087        - $ref: '#/components/parameters/roomBookingState'
4088        - $ref: '#/components/parameters/roomBookingCap'
4089        - $ref: '#/components/parameters/roomBookingRooms'
4090        - $ref: '#/components/parameters/roomBookingType'
4091        - $ref: '#/components/parameters/roomBookingStaff'
4092        - $ref: '#/components/parameters/roomBookingStudent'
4093        - $ref: '#/components/parameters/offerNameParamOpt'
4094        - $ref: '#/components/parameters/moduleCodeQueryParam3'
4095        - $ref: '#/components/parameters/offerAltCodeParam'
4096        - $ref: '#/components/parameters/useOfferAltCodeParam'
4097        - $ref: '#/components/parameters/notesParamQ'
4098        - $ref: '#/components/parameters/user1Param'
4099        - $ref: '#/components/parameters/user2Param'
4100        - $ref: '#/components/parameters/user3Param'
4101        - $ref: '#/components/parameters/user4Param'
4102      responses:
4103        '200':
4104          description: Success - the room booking was updated
4105        '400':
4106          $ref: '#/components/responses/BadRequest'
4107        '401':
4108          $ref: '#/components/responses/Unauthorized'
4109        '500':
4110          $ref: '#/components/responses/InternalServerError'
4111    delete:
4112      summary: Delete a Room Booking
4113      description: Delete an existing room booking
4114      tags: ["room booking"]
4115      operationId: deleteRoombookingC
4116      parameters:
4117        - $ref: '#/components/parameters/roomBookingCodeParamVar'
4118        - $ref: '#/components/parameters/queryBookingByParam'
4119      responses:
4120        '200':
4121          description: Success - the room booking was deleted
4122        '400':
4123          $ref: '#/components/responses/BadRequest'
4124        '401':
4125          $ref: '#/components/responses/Unauthorized'
4126        '500':
4127          $ref: '#/components/responses/InternalServerError'
4128  /report/room:
4129    get:
4130      summary: Get Report of all Rooms
4131      description: >-
4132        Returns a CSV friendly list (no nested objects) of room details and statistics.
4133        This list can be imported and viewed from Microsoft Excel.
4134      tags: ["report"]
4135      operationId: getReportRoom
4136      requestBody:
4137        description: List of buildings to filter results by.
4138        required: false
4139        content:
4140          application/json:
4141            schema:
4142              $ref: '#/components/schemas/BuildingsArray'
4143      responses:
4144        '200':
4145          description: A rooms report object
4146          content:
4147            application/json:
4148              schema:
4149                $ref: '#/components/schemas/ReportRoom'
4150        '400':
4151          $ref: '#/components/responses/BadRequest'
4152        '401':
4153          $ref: '#/components/responses/Unauthorized'
4154        '500':
4155          $ref: '#/components/responses/InternalServerError'
4156  /report/booking:
4157    get:
4158      summary: Get Report of all Bookings
4159      description: >-
4160        Returns a CSV friendly list (no nested objects) of room bookings.
4161        This list can be imported and viewed from Microsoft Excel.
4162      tags: ["report"]
4163      operationId: getReportBooking
4164      responses:
4165        '200':
4166          description: A rooms report object
4167          content:
4168            application/json:
4169              schema:
4170                $ref: '#/components/schemas/ReportRoomBooking'
4171        '400':
4172          $ref: '#/components/responses/BadRequest'
4173        '401':
4174          $ref: '#/components/responses/Unauthorized'
4175        '500':
4176          $ref: '#/components/responses/InternalServerError'
4177  /locations:
4178    get:
4179      summary: Get all Locations
4180      description: Get the list of all Locations
4181      tags: ["location"]
4182      operationId: getLocations
4183      responses:
4184        '200':
4185          description: A JSON array of Locations
4186          content:
4187            application/json:
4188              schema:
4189                type: array
4190                items:
4191                  $ref: '#/components/schemas/Location'
4192  '/location/{code}':
4193    get:
4194      summary: Get one Location
4195      description: Get details for one Location
4196      tags: ["location"]
4197      operationId: getLocationCode
4198      parameters:
4199        - $ref: '#/components/parameters/locationCodeParamP'
4200      responses:
4201        '200':
4202          description: A Location object
4203          content:
4204            application/json:
4205              schema:
4206                $ref: '#/components/schemas/Location'
4207        '400':
4208          $ref: '#/components/responses/BadRequest'
4209        '401':
4210          $ref: '#/components/responses/Unauthorized'
4211        '500':
4212          $ref: '#/components/responses/InternalServerError'
4213    post:
4214      summary: Create a Location
4215      description: Create a new Location
4216      tags: ["location"]
4217      operationId: postLocationCode
4218      parameters:
4219        - $ref: '#/components/parameters/locationCodeParamP'
4220        - $ref: '#/components/parameters/locationNameParam'
4221      responses:
4222        '200':
4223          $ref: '#/components/responses/OperationSucceeded'
4224        '400':
4225          $ref: '#/components/responses/BadRequest'
4226        '401':
4227          $ref: '#/components/responses/Unauthorized'
4228        '500':
4229          $ref: '#/components/responses/InternalServerError'
4230    put:
4231      summary: Update a Location
4232      description: Update an existing Location
4233      tags: ["location"]
4234      operationId: putLocationCode
4235      parameters:
4236        - $ref: '#/components/parameters/locationCodeParamP'
4237        - $ref: '#/components/parameters/locationCode'
4238        - $ref: '#/components/parameters/locationNameParamO'
4239      responses:
4240        '200':
4241          description: Success - the Location was updated
4242        '400':
4243          $ref: '#/components/responses/BadRequest'
4244        '401':
4245          $ref: '#/components/responses/Unauthorized'
4246        '500':
4247          $ref: '#/components/responses/InternalServerError'
4248    delete:
4249      summary: Delete a Location
4250      description: Delete an existing Location
4251      tags: ["location"]
4252      operationId: deleteLocationCode
4253      parameters:
4254        - $ref: '#/components/parameters/locationCodeParamP'
4255      responses:
4256        '200':
4257          description: Success - the Location was deleted
4258        '400':
4259          $ref: '#/components/responses/BadRequest'
4260        '401':
4261          $ref: '#/components/responses/Unauthorized'
4262        '500':
4263          $ref: '#/components/responses/InternalServerError'
4264  /exemptions:
4265    get:
4266      summary: Get Exemptions
4267      description: Get details for all Exemptions
4268      tags: ["exemption"]
4269      operationId: getExemptions
4270      responses:
4271        '200':
4272          description: A JSON array of Exemptions
4273          content:
4274            application/json:
4275              schema:
4276                type: array
4277                items:
4278                  $ref: '#/components/schemas/Exemption'
4279        '400':
4280          $ref: '#/components/responses/BadRequest'
4281        '401':
4282          $ref: '#/components/responses/Unauthorized'
4283        '500':
4284          $ref: '#/components/responses/InternalServerError'
4285    post:
4286      summary: Create a Exemption
4287      description: Create a new Exemption
4288      tags: ["exemption"]
4289      operationId: postExemption
4290      parameters:
4291        - $ref: '#/components/parameters/reasonParamQueryReq'
4292        - $ref: '#/components/parameters/activitiesParamQueryReq'
4293        - $ref: '#/components/parameters/studentsParamQueryReq'
4294      responses:
4295        '200':
4296          $ref: '#/components/responses/OperationSucceededReturnsCodes'
4297        '400':
4298          $ref: '#/components/responses/BadRequest'
4299        '401':
4300          $ref: '#/components/responses/Unauthorized'
4301        '500':
4302          $ref: '#/components/responses/InternalServerError'
4303  /exemptions/{code}:
4304    delete:
4305      summary: Delete an Exemption
4306      description: Delete an existing Exemption
4307      tags: ["exemption"]
4308      operationId: deleteExemptionsCode
4309      parameters:
4310        - $ref: '#/components/parameters/exemptionCodeParamPath'
4311      responses:
4312        '200':
4313          description: Success - the Exemption was deleted
4314        '400':
4315          $ref: '#/components/responses/BadRequest'
4316        '401':
4317          $ref: '#/components/responses/Unauthorized'
4318        '500':
4319          $ref: '#/components/responses/InternalServerError'
4320  /database:
4321    get:
4322      summary: Get the database
4323      description: Get details for the database
4324      tags: ["database"]
4325      operationId: getDatabase
4326      responses:
4327        '200':
4328          description: Details for the database
4329          content:
4330            application/json:
4331              schema:
4332                type: array
4333                items:
4334                  $ref: '#/components/schemas/Database'
4335        '400':
4336          $ref: '#/components/responses/BadRequest'
4337        '401':
4338          $ref: '#/components/responses/Unauthorized'
4339        '500':
4340          $ref: '#/components/responses/InternalServerError'
4341  '/assessmentperiod/{assessmentPeriodCode}':
4342    get:
4343      summary: Get one Assessment Period
4344      description: Get details for the specified Assessment Period
4345      tags: ["assessmentperiod"]
4346      operationId: getAssessmentperiodAssessmentPeriodCode
4347      parameters:
4348        - $ref: '#/components/parameters/assessmentPeriodCodePathParam'
4349      responses:
4350        '200':
4351          description: Details for the Assessment Period
4352          content:
4353            application/json:
4354              schema:
4355                type: array
4356                items:
4357                  $ref: '#/components/schemas/AssessmentPeriod'
4358        '400':
4359          $ref: '#/components/responses/BadRequest'
4360        '401':
4361          $ref: '#/components/responses/Unauthorized'
4362        '500':
4363          $ref: '#/components/responses/InternalServerError'
4364  /optiongroups:
4365    get:
4366      summary: Get all Option Groups
4367      description: Get details for option groups
4368      tags: ["optiongroups"]
4369      operationId: getOptiongroups
4370      parameters:
4371        - $ref: '#/components/parameters/optionGroupNameParam'
4372        - $ref: '#/components/parameters/timeframeCodeParam'
4373        - $ref: '#/components/parameters/optionGroupStudentStatusParam'
4374      responses:
4375        '200':
4376          description: Details for the Assessment Period
4377          content:
4378            application/json:
4379              schema:
4380                type: array
4381                items:
4382                  $ref: '#/components/schemas/optiongroup'
4383        '400':
4384          $ref: '#/components/responses/BadRequest'
4385        '401':
4386          $ref: '#/components/responses/Unauthorized'
4387        '500':
4388          $ref: '#/components/responses/InternalServerError'
4389security:
4390  - SemApiKeyAuth: []
4391components:
4392  securitySchemes:
4393    SemApiKeyAuth:
4394      type: apiKey
4395      in: header
4396      name: Authorization
4397      description: >-
4398        The api key is a 20 character alphanumeric key specific for a user in a database on a server.
4399        The key can be sent as a parameter or in the header.
4400        **Parameter:** https://hostname/v1/api/object?key=12345678...
4401        **Header:** Key=*Authorization* Value=*k 12435678...*
4402  parameters:
4403    activityReadyParam:
4404      name: ready
4405      in: query
4406      required: false
4407      description: Change the ready status of the activity
4408      schema:
4409        type: integer
4410        minimum: 0
4411        maximum: 1
4412        example: 1
4413    trackSlotLengthMinsParam:
4414      in: query
4415      name: trackSlotLengthMins
4416      description: The default duration of each slot in a track measured in minutes.
4417      schema:
4418        type: integer
4419        minimum: 0
4420        maximum: 9999
4421    trackSlotLengthMinsParamReq:
4422      in: query
4423      name: trackSlotLengthMins
4424      required: true
4425      description: The default duration of each slot in a track measured in minutes.
4426      schema:
4427        type: integer
4428        minimum: 0
4429        maximum: 9999
4430    roomSizePerTrackParam:
4431      in: query
4432      name: roomSizePerTrack
4433      description: The minimum size of each room in which a track is to be scheduled
4434      schema:
4435        type: integer
4436        minimum: 0
4437        maximum: 9999
4438    roomSizePerTrackParamReq:
4439      in: query
4440      name: roomSizePerTrack
4441      required: true
4442      description: The minimum size of each room in which a track is to be scheduled
4443      schema:
4444        type: integer
4445        minimum: 0
4446        maximum: 9999
4447    numberOfTracksParam:
4448      in: query
4449      name: numberOfTracks
4450      description: Typically for oral exams, one examiner would question one student at a time so the number of tracks would be 1.  With two examiners in separate rooms, two students could be questioned at a time so the number of tracks would be 2.
4451      schema:
4452        type: integer
4453        minimum: 0
4454        maximum: 9999
4455    numberOfTracksParamReq:
4456      in: query
4457      name: numberOfTracks
4458      required: true
4459      description: Typically for oral exams, one examiner would question one student at a time so the number of tracks would be 1.  With two examiners in separate rooms, two students could be questioned at a time so the number of tracks would be 2.
4460      schema:
4461        type: integer
4462        minimum: 0
4463        maximum: 9999
4464    user1-256Param:
4465      in: query
4466      name: user1
4467      description: User-definable field 1
4468      required: false
4469      schema:
4470        type: string
4471        minLength: 1
4472        maxLength: 256
4473    user2-256Param:
4474      in: query
4475      name: user2
4476      description: User-definable field 2
4477      required: false
4478      schema:
4479        type: string
4480        minLength: 1
4481        maxLength: 256
4482    user3-256Param:
4483      in: query
4484      name: user3
4485      description: User-definable field 3
4486      required: false
4487      schema:
4488        type: string
4489        minLength: 1
4490        maxLength: 256
4491    skipStudentClashesParam:
4492      in: query
4493      name: skipStudentClashes
4494      description: >-
4495        Skip student clashes checks when auto-scheduling the exam. Does
4496        not skip student clash checks when manually moving the exam
4497      schema:
4498        type: integer
4499        minimum: 0
4500        maximum: 1
4501    usePlanSizeParam:
4502      in: query
4503      name: usePlanSize
4504      description: 1 if the scheduler is to schedule based on the planned size of the exam, 0 if based on the actual number of students
4505      schema:
4506        type: integer
4507        minimum: 0
4508        maximum: 1
4509    splittableParam:
4510      in: query
4511      name: splittable
4512      description: 1 if there if the scheduler is allowed to split the exam over several rooms, 0 otherwise
4513      schema:
4514        type: integer
4515        minimum: 0
4516        maximum: 1
4517    slotGroupParam:
4518      in: query
4519      name: slotGroup
4520      description: a user-defined string that is shared between two (or more) exams to ensure they are scheduled at the same time
4521      schema:
4522        type: string
4523        minimum: 1
4524    sharingParam:
4525      in: query
4526      name: sharing
4527      description: 1 if there if the exam can share a session with other exams, otherwise 0
4528      schema:
4529        type: integer
4530        minimum: 0
4531        maximum: 1
4532    setupTimeMinsParam:
4533      in: query
4534      name: setupTimeMins
4535      description: 0 if there if the exam requires no setup, otherwise the number of minutes of setup time required
4536      schema:
4537        type: integer
4538        minimum: 0
4539        maximum: 9999
4540        nullable: true
4541    takedownTimeMinsParam:
4542      in: query
4543      name: takedownTimeMins
4544      description: 0 if there if the exam requires no takedown, otherwise the number of minutes of takedown time required
4545      schema:
4546        type: integer
4547        minimum: 0
4548        maximum: 9999
4549        nullable: true
4550    readyParam:
4551      in: query
4552      name: ready
4553      description: flag to show whether the exam is ready or not
4554      schema:
4555        type: integer
4556        minimum: 0
4557        maximum: 1
4558    preferredStartParam:
4559      in: query
4560      name: preferredStart
4561      description: The name of a Start Slots pattern
4562      schema:
4563        type: string
4564        minLength: 1
4565        maxLength: 100
4566        nullable: true
4567    planSizeParam:
4568      in: query
4569      name: planSize
4570      description: the planned (expected) size for the exam
4571      schema:
4572        type: integer
4573        minimum: 0
4574        maximum: 9999
4575    personalDeadlineEnabledParam:
4576      in: query
4577      name: personalDeadlineEnabled
4578      description: a flag to say whether each student in the exam can have their own personal deadline
4579      schema:
4580        type: integer
4581        minimum: 0
4582        maximum: 1
4583    noPublishStudentsParam:
4584      in: query
4585      name: noPublishStudents
4586      description: a flag to say whether this exam should be shown in the Students Portal
4587      schema:
4588        type: integer
4589        minimum: 0
4590        maximum: 1
4591    noPublishStaffParam:
4592      in: query
4593      name: noPublishStaff
4594      description: a flag to say whether this exam should be shown in the Staff Portal
4595      schema:
4596        type: integer
4597        minimum: 0
4598        maximum: 1
4599    minRoomSizeParam:
4600      in: query
4601      name: minRoomSize
4602      description: when the exam must be split across rooms, every room must be of at least this size
4603      schema:
4604        type: integer
4605        minimum: 0
4606        maximum: 9999
4607        nullable: true
4608    maxPerInvigilatorParam:
4609      in: query
4610      name: maxPerInvigilator
4611      description: a maximum number of students that a single invigilator can manage
4612      schema:
4613        type: integer
4614        minimum: 0
4615        maximum: 9999
4616        nullable: true
4617    fixedRoomsParam:
4618      in: query
4619      name: fixedRooms
4620      description: CSV list (or JSON array) of code(s) of Room(s) into which the activity or exam should be scheduled
4621      required: false
4622      schema:
4623        type: string
4624        minLength: 1
4625        nullable: true
4626    roomPoolParam:
4627      in: query
4628      name: roomPool
4629      description: CSV list (or JSON array) of name(s) of Room Pool(s) into which the exam should be scheduled
4630      required: false
4631      schema:
4632        type: string
4633        minLength: 1
4634        nullable: true
4635    fixedTimeParam:
4636      in: query
4637      name: fixedTime
4638      description: Number of minutes past midnight at which the activity or exam should be scheduled
4639      required: false
4640      schema:
4641        type: integer
4642        minimum: 0
4643        maximum: 1439
4644        nullable: true
4645    fixedDayParam:
4646      in: query
4647      name: fixedDay
4648      description: 0 means the first day of the week (usually, but not always Monday)
4649      schema:
4650        type: integer
4651        minimum: 0
4652        maximum: 6
4653        nullable: true
4654    exclusiveStaffParam:
4655      in: query
4656      name: exclusiveStaff
4657      description: a flag to say whether the academic staff responsible for the exam content can be responsible for one exam only at a time
4658      schema:
4659        type: integer
4660        minimum: 0
4661        maximum: 1
4662    exclusiveParam:
4663      in: query
4664      name: exclusive
4665      description: 1 means that the student taking this exam should not be taking any other exams at the same time
4666      schema:
4667        type: integer
4668        minimum: 0
4669        maximum: 1
4670    descriptionParam:
4671      in: query
4672      name: description
4673      description: a description of the exam
4674      schema:
4675        type: string
4676        minLength: 1
4677        maxLength: 255
4678        nullable: true
4679    complexityParam:
4680      in: query
4681      name: complexity
4682      description: a numeric indication of how hard the exam is to schedule where low numbers mean easy and higher numbers mean harder
4683      schema:
4684        type: integer
4685        minimum: 0
4686    plannedStartDateTimeParam:
4687      in: query
4688      name: plannedStartDateTime
4689      description: The date and time that the Serial Exam is planned to start at
4690      example: YYYY-MM-DD HH:MM
4691      schema:
4692        type: string
4693        nullable: true
4694        minLength: 1
4695        maxLength: 20
4696    concurrencyParam:
4697      in: query
4698      name: concurrency
4699      description: The number of tracks that can run parallel to each other
4700      schema:
4701        type: integer
4702        minimum: 1
4703        maximum: 999
4704        nullable: true
4705    plannedSlotsPerTrackParam:
4706      in: query
4707      name: plannedSlotsPerTrack
4708      description: The number of planned slots to have per track
4709      schema:
4710        type: integer
4711        minimum: 1
4712        nullable: true
4713    minutesBetweenBreaksParam:
4714      in: query
4715      name: minutesBetweenBreaks
4716      description: The amount of time that should separate breaks in minutes
4717      schema:
4718        type: integer
4719        minimum: 0
4720        nullable: false
4721    breakDurationMinutesParam:
4722      in: query
4723      name: breakDurationMinutes
4724      description: The amount of time that a break should last in minutes
4725      schema:
4726        type: integer
4727        minimum: 0
4728        nullable: true
4729    plannedStudentsPerTrackSlotParam:
4730      in: query
4731      name: plannedStudentsPerTrackSlot
4732      description: The number of students who can participate per track slot
4733      schema:
4734        type: integer
4735        minimum: 0
4736        nullable: false
4737        default: 1
4738    classicColocationsParam:
4739      in: query
4740      name: classicColocations
4741      description: CSV list (or JSON array) of code(s) of classic exam(s) with which this exam should be colocated
4742      required: false
4743      schema:
4744        type: string
4745        minLength: 1
4746    classicPredecessorsParam:
4747      in: query
4748      name: classicPredecessors
4749      description: CSV list (or JSON array) of code(s) of classic exam(s) after which this exam must be scheduled
4750      required: false
4751      schema:
4752        type: string
4753        minLength: 1
4754    serialPredecessorsParam:
4755      in: query
4756      name: serialPredecessors
4757      description: CSV list (or JSON array) of code(s) of serial exam(s) after which this exam must be schedule
4758      required: false
4759      schema:
4760        type: string
4761        minLength: 1
4762    takehomePredecessorsParam:
4763      in: query
4764      name: takehomePredecessors
4765      description: CSV list (or JSON array) of code(s) of takehome exam(s) after which this exam must be schedule
4766      required: false
4767      schema:
4768        type: string
4769        minLength: 1
4770    roomBookingCodeParamVar:
4771      in: path
4772      name: c
4773      description: Unique code to identify the room booking. Can either be internal id or code if queryBy parameter is sent.
4774      required: true
4775      schema:
4776        type: number
4777        minimum: 1
4778        nullable: false
4779        example: 19
4780    assessmentTypeNameParam:
4781      in: query
4782      name: name
4783      description: >-
4784        Name of the Assessment Type. No two assessment
4785        types can have the same name and same parent.
4786      required: true
4787      schema:
4788        type: string
4789        minLength: 1
4790        maxLength: 255
4791        nullable: false
4792        example: Take-home Exam
4793    assessmentTypeCodeParam:
4794      in: path
4795      name: c
4796      description: Unique code to identify the assessment type.
4797      required: true
4798      schema:
4799        type: number
4800        minimum: 1
4801        nullable: false
4802        example: 19
4803    roomBookingCodeParamFixed:
4804      in: path
4805      name: c
4806      description: Unique code to identify the room booking. Can only be externalId
4807      required: true
4808      schema:
4809        type: string
4810        minLength: 1
4811        nullable: false
4812        example: '19'
4813    sequenceParam:
4814      in: query
4815      name: sequence
4816      description: the exam with sequence number n will always be scheduled after exams with lower sequence numbers
4817      required: false
4818      schema:
4819        type: number
4820        nullable: true
4821        minimum: 0
4822        maximum: 9999
4823    roomBookingDesc:
4824      in: query
4825      name: des
4826      description: A description of the room booking
4827      required: true
4828      schema:
4829        type: string
4830        minLength: 0
4831        maxLength: 200
4832        nullable: false
4833        example: Guest lecture
4834    roomBookingDesc2:
4835      in: query
4836      name: des
4837      description: A description of the room booking
4838      required: false
4839      schema:
4840        type: string
4841        minLength: 0
4842        maxLength: 200
4843        nullable: false
4844        example: Guest lecture
4845    roomBookingState:
4846      in: query
4847      name: state
4848      description: >-
4849        "Approval status  flag of the room booking.
4850        Values: 0 = Approved, 1 = Pending"
4851      schema:
4852        type: number
4853        minimum: 0
4854        maximum: 1
4855        example: 0
4856    roomBookingCap:
4857      in: query
4858      name: cap
4859      description: Number of attendees
4860      schema:
4861        type: number
4862        minimum: 0
4863        nullable: true
4864    roomBookingRooms:
4865      in: query
4866      name: rooms
4867      description: CSV list of room codes for the activity's rooms
4868      schema:
4869        type: string
4870        minLength: 1
4871        nullable: true
4872        example: 'A-001,A-002'
4873    roomBookingDay:
4874      in: query
4875      name: day
4876      description: A list of numbers representing the days of the week for the room booking
4877      required: true
4878      schema:
4879        type: string
4880        minimum: 1
4881        maximum: 7
4882        nullable: false
4883        example: 1,2,3
4884    roomBookingTime:
4885      in: query
4886      name: time
4887      description: "The time of the booking. Format: hh:mm"
4888      required: true
4889      schema:
4890        type: string
4891        nullable: false
4892        example: "09:00"
4893    roomBookingDu:
4894      in: query
4895      name: du
4896      description: "The duration of the room booking. Format: hh:mm"
4897      required: true
4898      schema:
4899        type: string
4900        nullable: false
4901        example: "01:00"
4902    roomBookingDay2:
4903      in: query
4904      name: day
4905      description: A list of numbers representing the days of the week for the room booking
4906      required: false
4907      schema:
4908        type: string
4909        minimum: 1
4910        maximum: 7
4911        nullable: false
4912        example: 1,2,3
4913    roomBookingTime2:
4914      in: query
4915      name: time
4916      description: "The time of the booking. Format: hh:mm"
4917      required: false
4918      schema:
4919        type: string
4920        nullable: false
4921        example: "09:00"
4922    roomBookingDu2:
4923      in: query
4924      name: du
4925      description: "The duration of the room booking. Format: hh:mm"
4926      required: false
4927      schema:
4928        type: string
4929        nullable: false
4930        example: "01:00"
4931    roomBookingWeekPattern:
4932      in: query
4933      name: pat
4934      description: "CSV list of weeks that the room booking is scheduled. Format: YYYY-Www"
4935      required: true
4936      schema:
4937        type: string
4938        minLength: 1
4939        maxLength: 90
4940        nullable: true
4941        example: '2019-W01,2019-W02,2019-W04'
4942    roomBookingWeekPattern2:
4943      in: query
4944      name: pat
4945      description: "CSV list of weeks that the room booking is scheduled. Format: YYYY-Www"
4946      required: false
4947      schema:
4948        type: string
4949        minLength: 1
4950        maxLength: 90
4951        nullable: true
4952        example: '2019-W01,2019-W02,2019-W04'
4953    roomBookingOwner:
4954      in: query
4955      name: owner
4956      description: Staff or student code for the owner of the room booking
4957      required: true
4958      schema:
4959        type: string
4960        nullable: false
4961        maxLength: 255
4962        example: S91005
4963    roomBookingOwner2:
4964      in: query
4965      name: owner
4966      description: Staff or student code for the owner of the room booking
4967      required: false
4968      schema:
4969        type: string
4970        nullable: false
4971        maxLength: 255
4972        example: S91005
4973    roomBookingContact:
4974      in: query
4975      name: contact
4976      description: Contact details for the room booking owner
4977      required: false
4978      schema:
4979        type: string
4980        nullable: false
4981        maxLength: 255
4982        example: example@email.com
4983    roomBookingType:
4984      in: query
4985      name: type
4986      description: A unique code to identify the type of the room booking
4987      schema:
4988        type: string
4989        nullable: true
4990        minLength: 0
4991        maxLength: 5
4992        example: Lec
4993    roomBookingStaff:
4994      in: query
4995      name: staff
4996      description: CSV list of attending staff members' codes
4997      schema:
4998        type: string
4999        nullable: true
5000        minLength: 0
5001        maxLength: 45
5002        example: S91005,S91031
5003    roomBookingStudent:
5004      in: query
5005      name: stu
5006      description: CSV list of attending students' codes
5007      schema:
5008        type: string
5009        nullable: true
5010        minLength: 0
5011        maxLength: 255
5012        example: 1002438,1000110
5013    studentSpecialRequirements:
5014      in: query
5015      name: specReqs
5016      description: CSV list of Student Special Requirements
5017      schema:
5018        type: string
5019        nullable: true
5020        minLength: 0
5021        maxLength: 255
5022        example: 'Reader,Writer'
5023    studentCodesParamQuery:
5024      in: query
5025      name: stu
5026      description: >-
5027        CSV list of student codes for students in this offer.The values in this
5028        parameter will replace all existing student-offer mappings for this offer
5029      schema:
5030        type: string
5031        nullable: true
5032        minLength: 0
5033        maxLength: 255
5034        example: '1002438,1000110'
5035    queryStudentByParam:
5036      in: query
5037      name: queryBy
5038      description: >-
5039        When present, the user can define which field to query by.
5040        Accepted values: IDN, PrincipalName,
5041        Default value: IDN
5042      required: false
5043      schema:
5044        type: string
5045        example: PrincipalName
5046    queryBookingByParam:
5047      in: query
5048      name: queryBy
5049      description: >-
5050        When present, the user can define which field to query by.
5051        Accepted values: id, code,
5052        Default value: id
5053      required: false
5054      schema:
5055        type: string
5056        example: PrincipalName
5057    useAltCodeParam:
5058      in: query
5059      name: useAltc
5060      description: To be used when the alternative code is used to identify the underlying object
5061      required: false
5062      schema:
5063        type: number
5064        minimum: 0
5065        maximum: 1
5066    useModuleOfferAltCodeParam:
5067      in: query
5068      name: useOfferAltCode
5069      description: >-
5070        1 means that the Module Offers in the response are identified by their Alt Codes.  Otherwise
5071        the Module Offers and identified by their names.
5072      required: false
5073      schema:
5074        type: number
5075        minimum: 0
5076        maximum: 1
5077    canCreateSessionsParam:
5078      in: query
5079      name: canCreateSessions
5080      description: 1 means that the automatic Exam scheduler is allowed to create new Exam Sessions, otherwise the scheduler must use existing Exam Sessions
5081      required: false
5082      schema:
5083        type: number
5084        minimum: 0
5085        maximum: 1
5086    addOffersParamQuery:
5087      in: query
5088      name: addOffers
5089      description: >-
5090        This parameter does nothing if not sent or if sent with the value 0.  Send with the value 1
5091        to add the Ofers listed in parameter 'offers' to the Student.
5092      required: false
5093      schema:
5094        type: number
5095        minimum: 0
5096        maximum: 1
5097    removeOffersParamQuery:
5098      in: query
5099      name: removeOffers
5100      description: >-
5101        This parameter does nothing if not sent, sent with the value 0, or if parameter 'addOffers' is
5102        sent with the value 1.  Otherwise send this parameter with the value 1 to remove the Offers
5103        listed in parameter 'offers' from the Student.
5104      required: false
5105      schema:
5106        type: number
5107        minimum: 0
5108        maximum: 1
5109    useUser2Param:
5110      in: query
5111      name: useUser2
5112      description: To be used when the User2 field code is used to identify the underlying object
5113      required: false
5114      schema:
5115        type: number
5116        minimum: 0
5117        maximum: 1
5118    useExamCodeParam:
5119      in: query
5120      name: useExamCode
5121      description: To be used when the ExamCode field code is used to identify the underlying object
5122      required: false
5123      schema:
5124        type: number
5125        minimum: 0
5126        maximum: 1
5127    useOfferAltCodeParam:
5128      in: query
5129      name: useOfferAltc
5130      description: To be used when the alternative code is used to identify the Module Offer
5131      required: false
5132      schema:
5133        type: number
5134        minimum: 0
5135        maximum: 1
5136    filterByParam:
5137      in: query
5138      name: filterBy
5139      description: >-
5140        The name of one object property to filter by.
5141
5142
5143        Used in conjunction with the parameter "filterValue" to filter the query.
5144        Specifies which property the passed filter value is in.
5145        Both parameters must be passed with a valid value in order to filter the query.
5146        Currently only supports filtering by User defined fields.
5147      required: false
5148      schema:
5149        type: string
5150        minLength: 0
5151        maxLength: 255
5152        example: User1
5153    filterValueParam:
5154      in: query
5155      name: filterValue
5156      description: >-
5157        The value to filter by.
5158
5159
5160        Used in conjunction with the parameter "filterBy" to filter the query.
5161        Specifies which value to look for in the property specified by "filterBy".
5162        Both parameters must be passed with a valid value in order to filter the query.
5163        Currently only supports filtering by User defined fields.
5164
5165
5166        If the field is a user field set up with enumeration values, the value passed
5167        to this parameter will be looked up in the values of the field's enumerations.
5168        For example, if User1 is an enumerations field and student A has User1="val1,val2",
5169        passing the value "val1" to this parameter with return student A. Otherwise,
5170        the lookup is done by exact string matching. This means that to return
5171        student A of the previous example, the string "val1,val2" must be passed
5172        if the User1 fields is just plain text.
5173      required: false
5174      schema:
5175        type: string
5176        minLength: 0
5177        maxLength: 255
5178        example: User1Value
5179    user1FilterParam:
5180      in: query
5181      name: user1
5182      description: >-
5183        Filter the response by looking up the passed value in the user1
5184        property of the object
5185      required: false
5186      schema:
5187        type: string
5188        minLength: 0
5189        maxLength: 255
5190        example: userValue
5191    actUser1FilterParam:
5192      in: query
5193      name: actUser1
5194      description: >-
5195        Filter the activities in the response by looking up the passed value in
5196        the user1 property of the activities
5197      required: false
5198      schema:
5199        type: string
5200        minLength: 0
5201        maxLength: 255
5202        example: userValue
5203    user2FilterParam:
5204      in: query
5205      name: user2
5206      description: >-
5207        Filter the response by looking up the passed value in the user2
5208        property of the object
5209      required: false
5210      schema:
5211        type: string
5212        minLength: 0
5213        maxLength: 255
5214        example: userValue
5215    actUser2FilterParam:
5216      in: query
5217      name: actUser2
5218      description: >-
5219        Filter the activities in the response by looking up the passed value in
5220        the user2 property of the activities
5221      schema:
5222        type: string
5223        minLength: 0
5224        maxLength: 255
5225        example: userValue
5226    user3FilterParam:
5227      in: query
5228      name: user3
5229      description: >-
5230        Filter the response by looking up the passed value in the user3
5231        property of the object
5232      required: false
5233      schema:
5234        type: string
5235        minLength: 0
5236        maxLength: 255
5237        example: userValue
5238    actUser3FilterParam:
5239      in: query
5240      name: actUser3
5241      description: >-
5242        Filter the activities in the response by looking up the passed value in
5243        the user3 property of the activities
5244      required: false
5245      schema:
5246        type: string
5247        minLength: 0
5248        maxLength: 255
5249        example: userValue
5250    deleteLinkedActivities:
5251      in: query
5252      name: deleteLinkedActivities
5253      description: >-
5254        Set to 1 if you want TermTime to delete Activities linked to the
5255        StudentGroup you are deleting.  Ignored if the "unlink" parameter
5256        is passed with a value of "1".  USE WITH CARE.
5257      required: false
5258      schema:
5259        type: number
5260        minimum: 0
5261        maximum: 1
5262    unlinkLinkedObjects:
5263      in: query
5264      name: unlink
5265      description: 'To delete a Student Group that is linked to (one or more) Activities you must set unlink to 1, otherwise the delete will not be allowed'
5266      required: false
5267      schema:
5268        type: number
5269        minimum: 0
5270        maximum: 1
5271    useModuleAltCodeParam:
5272      in: query
5273      name: useModuleAltc
5274      description: To be used when the alternative code is used to identify the Module
5275      required: false
5276      schema:
5277        type: number
5278        minimum: 0
5279        maximum: 1
5280    locationCodeParam:
5281      in: query
5282      name: locationCode
5283      description: Optional code to identify a Location
5284      required: false
5285      schema:
5286        type: string
5287        minLength: 1
5288        maxLength: 255
5289    studentOfferMapType:
5290      in: query
5291      name: mtc
5292      description: The code for the Student-Module Offer map type.  If not specified, the code 'DEF' is assumed.
5293      required: false
5294      schema:
5295        type: string
5296        minLength: 1
5297        maxLength: 255
5298    useCoreOptionModulesParam:
5299      in: query
5300      name: useModules
5301      description: To be used and set to 1 when the moCoreParam and moOptionParam list Modules (instead of Offers)
5302      required: false
5303      schema:
5304        type: number
5305        minimum: 0
5306        maximum: 1
5307    toDeleteParam:
5308      in: query
5309      name: td
5310      description: To be used and set to 1 when the object is to be marked for deletion
5311      required: false
5312      schema:
5313        type: number
5314        minimum: 0
5315        maximum: 1
5316    createGroupParam:
5317      in: query
5318      name: createGroup
5319      description: Set to 0 to prevent creation of Student Group for Course.
5320      required: false
5321      schema:
5322        type: number
5323        minimum: 0
5324        maximum: 1
5325    courseAltCodeParam:
5326      in: query
5327      name: altc
5328      description: Unique alternative code to identify the course
5329      required: false
5330      schema:
5331        type: string
5332        minLength: 1
5333        maxLength: 64
5334    moduleAltCodeParam:
5335      in: query
5336      name: altc
5337      description: Unique alternative code to identify the module
5338      required: false
5339      schema:
5340        type: string
5341        minLength: 1
5342        maxLength: 64
5343    offerAltCodeParam:
5344      in: query
5345      name: altc
5346      description: Unique alternative code to identify the module offer
5347      required: false
5348      schema:
5349        type: string
5350        minLength: 1
5351        maxLength: 255
5352    staffAltCodeParam:
5353      in: query
5354      name: altc
5355      description: Unique alternative code to identify the staff member
5356      required: false
5357      schema:
5358        type: string
5359        minLength: 1
5360        maxLength: 255
5361    contactRequirementAltCodeParam:
5362      in: query
5363      name: altc
5364      description: Unique alternative code to identify the Contact Requirement
5365      required: false
5366      schema:
5367        type: string
5368        minLength: 1
5369        maxLength: 64
5370    codeParam:
5371      in: path
5372      name: c
5373      description: Unique code to identify the student
5374      required: true
5375      schema:
5376        type: string
5377        minLength: 1
5378        maxLength: 255
5379    assessmentPeriodCodeParamReq:
5380      in: query
5381      name: assessmentPeriodCode
5382      description: Unique code to identify the Assessment Period
5383      required: true
5384      schema:
5385        type: string
5386        minLength: 1
5387        maxLength: 25
5388    assessmentPeriodCodeParamOpt:
5389      in: query
5390      name: assessmentPeriodCode
5391      description: Unique code to identify the Assessment Period
5392      required: false
5393      schema:
5394        type: string
5395        minLength: 1
5396        maxLength: 25
5397    assessmentPeriodCodePathParam:
5398      in: path
5399      name: assessmentPeriodCode
5400      description: Unique code to identify the Assessment Period
5401      required: true
5402      schema:
5403        type: string
5404        minLength: 1
5405        maxLength: 25
5406    assessmentPeriodCodeOptParam:
5407      in: query
5408      name: assessmentPeriodCode
5409      description: Unique code to identify the Assessment Period
5410      required: false
5411      schema:
5412        type: string
5413        minLength: 1
5414        maxLength: 25
5415    optionGroupNameParam:
5416      in: query
5417      name: 'n'
5418      description: Name of option groups to filter by
5419      required: false
5420      schema:
5421        type: string
5422        minLength: 1
5423        maxLength: 25
5424    optionGroupStudentStatusParam:
5425      in: query
5426      name: status
5427      description: "Status string of student selections for option groups to filter by. Values: pending, approved, confirmed"
5428      required: false
5429      schema:
5430        type: string
5431        minLength: 1
5432        maxLength: 25
5433    newIdnParam:
5434      in: query
5435      name: cq
5436      description: New unique code to identify the student
5437      required: false
5438      schema:
5439        type: string
5440        minLength: 1
5441        maxLength: 255
5442    activityTypeCodeParam:
5443      in: path
5444      name: c
5445      description: Unique code to identify the activity type
5446      required: true
5447      example: LEC
5448      schema:
5449        type: string
5450        minLength: 1
5451        maxLength: 5
5452    activityTypeNameParam:
5453      in: query
5454      name: n
5455      description: Name for the activity type
5456      required: true
5457      example: Lecture
5458      schema:
5459        type: string
5460        minLength: 1
5461        maxLength: 45
5462    activityTypeColourParam:
5463      in: query
5464      name: colour
5465      description: Colour for the activity type as a hex string
5466      example: FAFAFA
5467      required: true
5468      schema:
5469        type: string
5470        minLength: 6
5471        maxLength: 6
5472    activityTemplateCodeParam:
5473      in: path
5474      name: c
5475      description: Unique code to identify the activity template
5476      required: true
5477      schema:
5478        type: string
5479        minLength: 1
5480        maxLength: 100
5481    activityNameQueryParam:
5482      in: query
5483      name: name
5484      description: Name
5485      required: true
5486      schema:
5487        type: string
5488        minLength: 1
5489        maxLength: 100
5490    activityNameQueryParamOpt:
5491      in: query
5492      name: name
5493      description: Name
5494      required: false
5495      schema:
5496        type: string
5497        minLength: 1
5498        maxLength: 100
5499    activityDurationQueryParam:
5500      in: query
5501      name: du
5502      description: Duration (as a number of slots)
5503      required: true
5504      schema:
5505        type: integer
5506        minimum: 1
5507    activityDurationQueryParamOpt:
5508      in: query
5509      name: du
5510      description: Duration (as a number of slots)
5511      required: false
5512      schema:
5513        type: integer
5514        minimum: 1
5515    activityWeeksPatternQueryParam:
5516      in: query
5517      name: weeks
5518      description: Weeks pattern e.g. '1-10,12'
5519      required: true
5520      schema:
5521        type: string
5522        minLength: 1
5523        maxLength: 90
5524    activityWeeksPatternQueryParamOpt:
5525      in: query
5526      name: weeks
5527      description: Weeks pattern e.g. '1-10,12'
5528      required: false
5529      schema:
5530        type: string
5531        minLength: 1
5532        maxLength: 90
5533    activityOfferQueryParam:
5534      in: query
5535      name: offer
5536      description: AltCode for Offer
5537      required: true
5538      schema:
5539        type: string
5540        minLength: 1
5541        maxLength: 255
5542    activityOfferQueryOptParam:
5543      in: query
5544      name: offer
5545      description: AltCode for Offer
5546      required: false
5547      schema:
5548        type: string
5549        minLength: 1
5550        maxLength: 255
5551    activityOfferQueryParamOpt:
5552      in: query
5553      name: offer
5554      description: AltCode for Offer
5555      required: false
5556      schema:
5557        type: string
5558        minLength: 1
5559        maxLength: 255
5560    activityVirtualQueryParam:
5561      in: query
5562      name: v
5563      description: Flag to say whether the Activity is virtual (needs no rooms)
5564      required: true
5565      schema:
5566        type: integer
5567        minimum: 0
5568        maximum: 1
5569    activityVirtualQueryParamOpt:
5570      in: query
5571      name: v
5572      description: Flag to say whether the Activity is virtual (needs no rooms)
5573      required: false
5574      schema:
5575        type: integer
5576        minimum: 0
5577        maximum: 1
5578    activityMeetingRequiredQueryParamOpt:
5579      in: query
5580      name: mr
5581      description: Flag to say whether the Activity requires an online meeting
5582      required: false
5583      schema:
5584        type: integer
5585        minimum: 0
5586        maximum: 1
5587    activityPlanSizeQueryParam:
5588      in: query
5589      name: pl
5590      description: Number of students expected to take the Activity
5591      required: true
5592      schema:
5593        type: integer
5594        minimum: 0
5595        maximum: 99999
5596    activityPlanSizeQueryParamOpt:
5597      in: query
5598      name: pl
5599      description: Number of students expected to take the Activity
5600      required: false
5601      schema:
5602        type: integer
5603        minimum: 0
5604        maximum: 99999
5605    activityFriendlyNameQueryParam:
5606      in: query
5607      name: fname
5608      description: Another name for the Activity
5609      required: false
5610      schema:
5611        type: string
5612        minLength: 1
5613        maxLength: 255
5614    activityUser1QueryParam:
5615      in: query
5616      name: user1
5617      description: User-definable field 1
5618      required: false
5619      schema:
5620        type: string
5621        minLength: 1
5622        maxLength: 255
5623    activityUser2QueryParam:
5624      in: query
5625      name: user2
5626      description: User-definable field 2
5627      required: false
5628      schema:
5629        type: string
5630        minLength: 1
5631        maxLength: 255
5632    activityUser3QueryParam:
5633      in: query
5634      name: user3
5635      description: User-definable field 3
5636      required: false
5637      schema:
5638        type: string
5639        minLength: 1
5640        maxLength: 255
5641    activityUser4QueryParam:
5642      in: query
5643      name: user4
5644      description: User-definable field 4
5645      required: false
5646      schema:
5647        type: string
5648        minLength: 1
5649        maxLength: 255
5650    activityUser5QueryParam:
5651      in: query
5652      name: user5
5653      description: User-definable field 5
5654      required: false
5655      schema:
5656        type: string
5657        minLength: 1
5658        maxLength: 255
5659    activityUser6QueryParam:
5660      in: query
5661      name: user6
5662      description: User-definable field 6
5663      required: false
5664      schema:
5665        type: string
5666        minLength: 1
5667        maxLength: 255
5668    activityUser7QueryParam:
5669      in: query
5670      name: user7
5671      description: User-definable field 7
5672      required: false
5673      schema:
5674        type: string
5675        minLength: 1
5676        maxLength: 255
5677    activityNoPublishStudentQueryParam:
5678      in: query
5679      name: npStu
5680      description: Flag to say whether student should see Activity or Exam in timetable (0) or not see Activity or Exam (1)
5681      required: false
5682      schema:
5683        type: integer
5684        minimum: 0
5685        maximum: 1
5686    activityNoPublishStaffQueryParam:
5687      in: query
5688      name: npStaff
5689      description: Flag to say whether staff should see Activity or Exam in timetable (0) or not see Activity or Exam (1)
5690      required: false
5691      schema:
5692        type: integer
5693        minimum: 0
5694        maximum: 1
5695    activitySchedRoomQueryParam:
5696      in: query
5697      name: schedRoom
5698      description: >-
5699        CSV list or JSON array of room codes to schedule activity into those rooms.
5700        The query parameters schedRoom, schedDay, schedHour and schedule
5701        must all be used together for scheduling to succeed
5702      required: false
5703      schema:
5704        type: string
5705        minLength: 0
5706        maxLength: 45
5707    activitySchedDayQueryParam:
5708      in: query
5709      name: schedDay
5710      description: >-
5711        Short day code of day to schedule activity on.
5712        The query parameters schedRoom, schedDay, schedHour and schedule
5713        must all be used together for scheduling to succeed
5714      required: false
5715      schema:
5716        type: string
5717        minLength: 0
5718        maxLength: 10
5719    activitySchedHourQueryParam:
5720      in: query
5721      name: schedHour
5722      description: >-
5723        Time (HH:MM) to schedule the activity at.
5724        The query parameters schedRoom, schedDay, schedHour and schedule
5725        must all be used together for scheduling to succeed
5726      required: false
5727      schema:
5728        type: string
5729        minLength: 0
5730        maxLength: 5
5731    activityScheduleQueryParam:
5732      in: query
5733      name: schedule
5734      description: >-
5735        Name of the schedule you want to schedule the activity into.
5736        The query parameters schedRoom, schedDay, schedHour and schedule
5737        must all be used together for scheduling to succeed
5738      required: false
5739      schema:
5740        type: string
5741        minLength: 0
5742        maxLength: 45
5743    activityOptInParam:
5744      in: query
5745      name: optIn
5746      description: This flags a given Activity as being non-mandatory for its attendees.
5747      required: false
5748      schema:
5749        type: number
5750        minLength: 0
5751        maxLength: 1
5752    studentCodeParam:
5753      in: path
5754      name: s
5755      description: Unique code to identify the Student
5756      required: true
5757      schema:
5758        type: string
5759        minLength: 1
5760        maxLength: 255
5761    isAlsoStudentParam:
5762      in: query
5763      name: ias
5764      description: Unique code to identify Student if Staff is also a Student
5765      required: false
5766      schema:
5767        type: string
5768        minLength: 1
5769        maxLength: 60
5770    rolesParam:
5771      in: query
5772      name: roles
5773      required: false
5774      description: A comma separated list of roles codes to add the new staff into
5775      schema:
5776        type: string
5777        minLength: 1
5778    staffGroupsParam:
5779      in: query
5780      name: staffGroups
5781      required: false
5782      description: A comma separated list of staff groups codes to add the new staff into
5783      schema:
5784        type: string
5785        minLength: 1
5786    mergeIntoStudentParam:
5787      in: query
5788      name: c2
5789      description: Unique code of other Student into which resources of Student being deleted will be merged
5790      required: false
5791      schema:
5792        type: string
5793        minLength: 1
5794        maxLength: 255
5795    softDeleteStudentParam:
5796      in: query
5797      name: softDelete
5798      description: "1 means if the Student is mapped to any Exams, Bookings, Groups, Module Offers or Courses then set the 'to delete' flag on Student (and don't actually delete the Student from the database)"
5799      required: false
5800      schema:
5801        type: number
5802        minimum: 0
5803        maximum: 1
5804    softDeleteStaffParam:
5805      in: query
5806      name: softDelete
5807      description: "1 means if the Staff is mapped to any Courses, Modules, Module Offers, Activities, Exams or Bookings then set the 'to delete' flag on Staff (and don't actually delete the Staff from the database)"
5808      required: false
5809      schema:
5810        type: number
5811        minimum: 0
5812        maximum: 1
5813    contactRequirementCodeParamReq:
5814      in: path
5815      name: c
5816      description: Unique code to identify the Contact Requirement
5817      required: true
5818      schema:
5819        type: string
5820        minLength: 1
5821        maxLength: 100
5822    activityCodeParam:
5823      in: path
5824      name: c
5825      description: Unique code to identify the Activity
5826      required: true
5827      schema:
5828        type: string
5829        minLength: 1
5830        maxLength: 255
5831    activityCodeParam2:
5832      in: path
5833      name: ac
5834      description: Unique code to identify the Activity
5835      required: true
5836      schema:
5837        type: string
5838        minLength: 1
5839        maxLength: 255
5840    examCodeParam:
5841      in: path
5842      name: c
5843      description: Unique code to identify the Exam
5844      required: true
5845      schema:
5846        type: string
5847        minLength: 1
5848        maxLength: 50
5849    assessmentTypeParam:
5850      in: query
5851      name: assessmentType
5852      description: Unique name to identify the Assessment Type
5853      required: false
5854      schema:
5855        type: string
5856        minLength: 1
5857        maxLength: 255
5858    createSessionsParam:
5859      in: query
5860      name: createSessions
5861      description: 0 means scheduler is not create Exam Sessions; 1 means scheduler can create Exam Sessions
5862      required: true
5863      schema:
5864        type: number
5865        minimum: 0
5866        maximum: 1
5867    createSessionsOptParam:
5868      in: query
5869      name: createSessions
5870      description: 0 means scheduler is not create Exam Sessions; 1 means scheduler can create Exam Sessions
5871      required: false
5872      schema:
5873        type: number
5874        minimum: 0
5875        maximum: 1
5876    createCohortsOptParam:
5877      in: query
5878      name: createCohorts
5879      description: 0 means scheduler is not create Cohorts; 1 means scheduler can create Cohorts
5880      required: false
5881      schema:
5882        type: number
5883        minimum: 0
5884        maximum: 1
5885    durationMinutesParam:
5886      in: query
5887      name: durationMinutes
5888      description: The length of the Exam in minutes
5889      required: true
5890      schema:
5891        type: number
5892        minimum: 1
5893    durationMinutesOptParam:
5894      in: query
5895      name: durationMinutes
5896      description: The length of the Exam in minutes
5897      required: false
5898      schema:
5899        type: number
5900        minimum: 1
5901    trackSlotMinsParam:
5902      in: query
5903      name: trackSlotMins
5904      description: 0 means the Exam is parallel, >0 is the number of minutes for each track slot
5905      required: true
5906      schema:
5907        type: number
5908        minimum: 0
5909    trackSlotMinsOptParam:
5910      in: query
5911      name: trackSlotMins
5912      description: 0 means the Exam is parallel, >0 is the number of minutes for each track slot
5913      required: false
5914      schema:
5915        type: number
5916        minimum: 0
5917    offerCodeParam:
5918      in: query
5919      name: offer
5920      description: If param 'useAltc' is sent and has the value '1' then param 'offer' is the Alt Code of the offer.  Otherwise 'offer' is the name of the offer.
5921      required: true
5922      schema:
5923        type: string
5924        minLength: 1
5925        maxLength: 255
5926    offerCodeOptParam:
5927      in: query
5928      name: offer
5929      description: Unique code or alternative code to identify the module offer
5930      required: false
5931      schema:
5932        type: string
5933        minLength: 1
5934        maxLength: 255
5935    offerCodeOpt2Param:
5936      in: query
5937      name: offer
5938      description: If param 'useAltc' is sent and has the value '1' then param 'offer' is the name of the offer.  Otherwise 'offer' is the Alt Code of the offer.
5939      required: false
5940      schema:
5941        type: string
5942        minLength: 1
5943        maxLength: 255
5944    moduleCodeParam3:
5945      in: query
5946      name: module
5947      description: 'Unique code to identify the module. Required if parameter "useAltc" is false'
5948      required: false
5949      schema:
5950        type: string
5951        minLength: 1
5952        maxLength: 255
5953    moduleCodeParam4:
5954      in: query
5955      name: module
5956      description: 'Unique code to identify the module. Required if parameter "offer" is used and "useAltc" is false'
5957      required: false
5958      schema:
5959        type: string
5960        minLength: 1
5961        maxLength: 255
5962    examNameParamReq:
5963      in: query
5964      name: name
5965      description: Name for the Exam
5966      required: true
5967      schema:
5968        type: string
5969        minLength: 1
5970        maxLength: 100
5971    examName255ParamReq:
5972      in: query
5973      name: name
5974      description: Name for the Exam
5975      required: true
5976      schema:
5977        type: string
5978        minLength: 1
5979        maxLength: 255
5980    examName255ParamOpt:
5981      in: query
5982      name: name
5983      description: Name for the Exam
5984      required: false
5985      schema:
5986        type: string
5987        minLength: 1
5988        maxLength: 255
5989    examNameParamOptReq:
5990      in: query
5991      name: name
5992      description: Name for the Exam
5993      required: false
5994      schema:
5995        type: string
5996        minLength: 1
5997        maxLength: 100
5998    examFriendlyNameQueryParam:
5999      in: query
6000      name: friendlyName
6001      description: Another name for the Exam
6002      required: false
6003      schema:
6004        type: string
6005        minLength: 1
6006        maxLength: 255
6007    examPredecessorParam:
6008      in: query
6009      name: predecessor
6010      description: Unique code to identify the Exam that must precede this Exam
6011      required: true
6012      schema:
6013        type: string
6014        minLength: 1
6015        maxLength: 50
6016    examPredecessorOptParam:
6017      in: query
6018      name: predecessor
6019      description: Unique code to identify the Exam that must precede this Exam
6020      required: false
6021      schema:
6022        type: string
6023        minLength: 1
6024        maxLength: 50
6025    examUser1QueryParam:
6026      in: query
6027      name: user1
6028      description: User-definable field 1
6029      required: false
6030      schema:
6031        type: string
6032        minLength: 1
6033        maxLength: 255
6034    examUser2QueryParam:
6035      in: query
6036      name: user2
6037      description: User-definable field 2
6038      required: false
6039      schema:
6040        type: string
6041        minLength: 1
6042        maxLength: 255
6043    examUser3QueryParam:
6044      in: query
6045      name: user3
6046      description: User-definable field 3
6047      required: false
6048      schema:
6049        type: string
6050        minLength: 1
6051        maxLength: 255
6052    roleCodeParam:
6053      in: query
6054      name: role
6055      description: Unique code to identify the Role
6056      required: false
6057      schema:
6058        type: string
6059        minLength: 1
6060        maxLength: 45
6061    repeatGroupCodeParam:
6062      in: path
6063      name: c
6064      description: Unique code to identify the Repeat Group
6065      required: true
6066      schema:
6067        type: string
6068        minLength: 1
6069        maxLength: 255
6070    measurementCodeParam:
6071      in: query
6072      name: c
6073      description: Unique code to identify the type of measurement
6074      required: true
6075      schema:
6076        type: string
6077        minLength: 1
6078        maxLength: 100
6079    measurementDescParam:
6080      in: query
6081      name: desc
6082      description: A human-readable description of the measurement
6083      required: false
6084      schema:
6085        type: string
6086        minLength: 1
6087        maxLength: 100
6088    dateTimeParam:
6089      in: query
6090      name: dt
6091      description: The date and time at which the measurement was made in an ISO 8601 format
6092      required: true
6093      schema:
6094        type: string
6095        minLength: 16
6096        maxLength: 16
6097    millisecondsParam:
6098      in: query
6099      name: ms
6100      description: The value of the measurement in milliseconds
6101      required: true
6102      schema:
6103        type: number
6104    capabilityCodeParam:
6105      in: path
6106      name: c
6107      description: Unique code to identify the capability
6108      required: true
6109      schema:
6110        type: string
6111        minLength: 1
6112        maxLength: 100
6113    capabilityTypeParam:
6114      in: query
6115      name: type
6116      description: 0 if the Capability applies to Activities; 1 if it applies to Exams
6117      required: true
6118      schema:
6119        type: integer
6120        minimum: 0
6121        maximum: 1
6122    courseCodeParamPath:
6123      in: path
6124      name: cc
6125      description: Unique code to identify courses
6126      required: true
6127      schema:
6128        type: string
6129        minLength: 1
6130        maxLength: 45
6131    reasonParamQueryReq:
6132      in: query
6133      name: reason
6134      description: Reason for the exemption
6135      required: true
6136      schema:
6137        type: string
6138        minLength: 1
6139        maxLength: 255
6140    studentsParamQueryReq:
6141      in: query
6142      name: students
6143      description: CSV list of the Students being exempted
6144      required: true
6145      schema:
6146        type: string
6147        example: '038492038, 083429078'
6148        minLength: 1
6149    activitiesParamQueryReq:
6150      in: query
6151      name: activities
6152      description: CSV list of the Activities from which the Students are being exempted
6153      required: true
6154      schema:
6155        type: string
6156        example: '678, 104385'
6157        minLength: 1
6158    courseCodeParamQuery:
6159      in: query
6160      name: cc
6161      description: Unique code to identify the Course
6162      required: false
6163      schema:
6164        type: string
6165        minLength: 1
6166        maxLength: 255
6167    courseCodesParamQuery:
6168      in: query
6169      name: cc
6170      description: CSV list (or JSON array) of Course codes
6171      required: false
6172      schema:
6173        type: string
6174        minLength: 1
6175    offersParamQuery:
6176      in: query
6177      name: offers
6178      description: >-
6179        JSON array of pairs (Offer Alt Code, Map Type).  Unless 'addOffers' or 'removeOffers' is
6180        sent with the value 1, then the Offers listed in parameter 'offers' will be mapped to the
6181        Student and other Offers previously mapped to the Student will be removed.
6182      required: false
6183      schema:
6184        type: string
6185        minLength: 1
6186        example: '[["123.456", "CORE"], ["123.457", "OPT"]]'
6187    coreCourseCodesParamQuery:
6188      in: query
6189      name: ccCore
6190      description: CSV list (or JSON array) of Course codes for which Offer is core
6191      required: false
6192      schema:
6193        type: string
6194        minLength: 1
6195    optionalCourseCodesParamQuery:
6196      in: query
6197      name: ccOptional
6198      description: CSV list (or JSON array) of Course codes for which Offer is optional
6199      required: false
6200      schema:
6201        type: string
6202        minLength: 1
6203    examCodesParamQuery:
6204      in: query
6205      name: exams
6206      description: CSV list (or JSON array) of Exam codes
6207      required: false
6208      schema:
6209        type: string
6210        minLength: 1
6211    examModeParamQuery:
6212      in: query
6213      name: examMapSetAddOrDelete
6214      description: If parameter 'exams' is not sent, then this parameter 'examMapSetAddOrDelete' is ignored.  Otherwise, when 'examMapSetAddOrDelete' is 0 the Student Group is mapped to the listed Exams and any other pre-existing mappings are deleted; when 'examMapSetAddOrDelete' is 1 the Student Group is mapped to the listed Exams but other pre-existing mappings are kept; when 'examMapSetAddOrDelete' is 2 any mappings between the Student Group and the listed Exams are deleted but any other pre-existing mappings are not touched.  Finally, if 'exams' is sent but 'examMapSetAddOrDelete' is not sent, it is assumed that 'examMapSetAddOrDelete' was sent as 0
6215      required: false
6216      schema:
6217        type: integer
6218        minimum: 0
6219        maximum: 2
6220    courseCodesParamReq:
6221      in: query
6222      name: cc
6223      description: CSV list (or JSON array) of Course codes
6224      required: true
6225      schema:
6226        type: string
6227        minLength: 1
6228    showFullCourseParam:
6229      in: query
6230      name: shall
6231      description: Show Full Course flag
6232      schema:
6233        type: integer
6234        minimum: 0
6235        maximum: 1
6236    courseCodeQueryParam:
6237      in: query
6238      name: cq
6239      description: Unique code to identify the course
6240      required: false
6241      schema:
6242        type: string
6243        minLength: 1
6244        maxLength: 45
6245    moduleCodeParam:
6246      in: path
6247      name: c
6248      description: Unique code to identify the module
6249      required: true
6250      schema:
6251        type: string
6252        minLength: 1
6253        maxLength: 50
6254    moduleCodeParam2:
6255      in: path
6256      name: mc
6257      description: Unique code to identify the module
6258      required: true
6259      schema:
6260        type: string
6261        minLength: 1
6262        maxLength: 255
6263    moduleCodeQueryParam:
6264      in: query
6265      name: cq
6266      description: Unique code to identify the module
6267      required: true
6268      schema:
6269        type: string
6270        minLength: 1
6271        maxLength: 50
6272    moduleCodeQueryParam2:
6273      in: query
6274      name: c
6275      description: Unique code to identify the module
6276      required: false
6277      schema:
6278        type: string
6279        minLength: 1
6280        maxLength: 50
6281    moduleCodeQueryParam3:
6282      in: query
6283      name: cq
6284      description: Unique code to identify the module
6285      required: false
6286      schema:
6287        type: string
6288        minLength: 1
6289        maxLength: 50
6290    moduleCodeQueryParamReq:
6291      in: query
6292      name: cq
6293      description: Unique code to identify the module
6294      required: true
6295      schema:
6296        type: string
6297        minLength: 1
6298        maxLength: 50
6299    moduleCodeParamReq:
6300      in: query
6301      name: c
6302      description: Unique code to identify the Module
6303      required: true
6304      schema:
6305        type: string
6306        minLength: 1
6307        maxLength: 50
6308    staffCodeParam:
6309      in: path
6310      name: c
6311      description: Code to identify a Staff member uniquely
6312      required: true
6313      schema:
6314        type: string
6315        minLength: 1
6316        maxLength: 45
6317    staffCodeParam2:
6318      in: path
6319      name: sc
6320      description: Code to identify a Staff member uniquely
6321      required: true
6322      schema:
6323        type: string
6324        minLength: 1
6325        maxLength: 45
6326    newStaffCodeParam:
6327      in: query
6328      name: sc
6329      description: Code to update identify of Staff member
6330      schema:
6331        type: string
6332        minLength: 1
6333        maxLength: 45
6334    email1Param:
6335      in: query
6336      name: e1
6337      description: 'Email address, primary'
6338      schema:
6339        type: string
6340        minLength: 1
6341        maxLength: 600
6342    email2Param:
6343      in: query
6344      name: e2
6345      description: 'Email address, backup'
6346      schema:
6347        type: string
6348        minLength: 1
6349        maxLength: 600
6350    nameParam:
6351      in: query
6352      name: 'n'
6353      description: Full name
6354      schema:
6355        type: string
6356        minLength: 1
6357        maxLength: 100
6358    nameParamReq:
6359      in: query
6360      name: 'n'
6361      description: Full name
6362      required: true
6363      schema:
6364        type: string
6365        minLength: 1
6366        maxLength: 100
6367    groupCodeParam:
6368      in: path
6369      name: g
6370      description: Unique code to identify the group
6371      required: true
6372      schema:
6373        type: string
6374        minLength: 1
6375        maxLength: 45
6376    groupCodeParam2:
6377      in: path
6378      name: gc
6379      description: Unique code to identify the group
6380      required: true
6381      schema:
6382        type: string
6383        minLength: 1
6384        maxLength: 45
6385    groupNameParamReq:
6386      in: query
6387      name: gn
6388      description: Name for the Student Group
6389      required: true
6390      schema:
6391        type: string
6392        minLength: 1
6393        maxLength: 255
6394    groupNameParam:
6395      in: query
6396      name: gn
6397      description: Name for the Student Group
6398      required: false
6399      schema:
6400        type: string
6401        minLength: 1
6402        maxLength: 255
6403    sizeParam:
6404      in: query
6405      name: sz
6406      description: Size
6407      required: false
6408      schema:
6409        type: number
6410        minimum: 0
6411    offerNameParam:
6412      in: path
6413      name: o
6414      description: Name to identify the offer
6415      required: true
6416      schema:
6417        type: string
6418        minLength: 1
6419        maxLength: 255
6420    offerNameParam2:
6421      in: path
6422      name: cq
6423      description: Name to identify the offer
6424      required: true
6425      schema:
6426        type: string
6427        minLength: 1
6428        maxLength: 255
6429    offerNameParamOpt:
6430      in: query
6431      name: o
6432      description: Name to identify the offer
6433      schema:
6434        type: string
6435        minLength: 1
6436        maxLength: 255
6437    timeframeCodeParamReq:
6438      in: query
6439      name: tf
6440      description: Unique code to identify the Timeframe
6441      required: true
6442      schema:
6443        type: string
6444        minLength: 1
6445        maxLength: 110
6446    timeframeCodeParam:
6447      in: query
6448      name: tf
6449      description: Unique code to identify the Timeframe
6450      required: false
6451      schema:
6452        type: string
6453        minLength: 1
6454        maxLength: 110
6455    roomCodeParamReq:
6456      in: path
6457      name: c
6458      description: Unique code to identify the room
6459      required: true
6460      schema:
6461        type: string
6462        minLength: 1
6463        maxLength: 45
6464    roomNameParamReq:
6465      in: query
6466      name: 'n'
6467      description: Room name
6468      required: true
6469      schema:
6470        type: string
6471        minLength: 1
6472        maxLength: 45
6473    notesParamQ:
6474      in: query
6475      name: notes
6476      description: Free-text notes
6477      required: false
6478      schema:
6479        type: string
6480        minLength: 1
6481    campusNameParam:
6482      in: path
6483      name: c
6484      description: Identifying name for a campus
6485      required: true
6486      schema:
6487        type: string
6488        minLength: 1
6489        maxLength: 45
6490    campusNameMayBeOptionalParam:
6491      in: path
6492      name: c
6493      description: Identifying name for a campus. Can be omitted when the "queryBy" parameter is passed
6494      required: true
6495      schema:
6496        type: string
6497        minLength: 1
6498        maxLength: 45
6499    buildingNameMayBeOptionalParam:
6500      in: path
6501      name: b
6502      description: Identifying name for a building. Can be omitted when the "queryBy" parameter is passed
6503      required: true
6504      schema:
6505        type: string
6506        minLength: 1
6507        maxLength: 45
6508    campusCodeParamReq:
6509      in: query
6510      name: code
6511      description: Identifying code for a campus
6512      required: true
6513      schema:
6514        type: string
6515        minLength: 1
6516        maxLength: 45
6517    campusCodeParam:
6518      in: query
6519      name: campus
6520      description: Identifying code for a campus
6521      required: false
6522      schema:
6523        type: string
6524        minLength: 1
6525        maxLength: 45
6526    layoutTypeParam:
6527      in: query
6528      name: layoutType
6529      description: Identifying code for a Layout Type
6530      required: false
6531      schema:
6532        type: string
6533        minLength: 1
6534        maxLength: 30
6535    buildingCodeParamReq:
6536      in: query
6537      name: code
6538      description: Identifying code for a building
6539      required: true
6540      schema:
6541        type: string
6542        minLength: 1
6543        maxLength: 45
6544    buildingCodeParam:
6545      in: query
6546      name: building
6547      description: Identifying code for a building
6548      required: false
6549      schema:
6550        type: string
6551        minLength: 1
6552        maxLength: 45
6553    floorCodeParam:
6554      in: query
6555      name: code
6556      description: Identifying code for a floor
6557      required: true
6558      schema:
6559        type: string
6560        minLength: 1
6561        maxLength: 45
6562    campusNameOrCodeParam:
6563      in: path
6564      name: c
6565      description: Identifying name or code for a campus
6566      required: true
6567      schema:
6568        type: string
6569        minLength: 1
6570        maxLength: 45
6571    campusNewNameOrCodeParam:
6572      in: query
6573      name: camp
6574      description: Identifying name or code for a new campus to move a building into
6575      required: false
6576      schema:
6577        type: string
6578        minLength: 1
6579        maxLength: 45
6580    buildingNewNameOrCodeParam:
6581      in: query
6582      name: build
6583      description: Identifying name or code for a new building to move a building into
6584      required: false
6585      schema:
6586        type: string
6587        minLength: 1
6588        maxLength: 45
6589    campusNameParamQ:
6590      in: query
6591      name: cam
6592      description: Identifying name for a campus
6593      required: false
6594      schema:
6595        type: string
6596        minLength: 1
6597        maxLength: 45
6598    campusNameParamQReq:
6599      in: query
6600      name: cam
6601      description: Identifying name for a campus
6602      required: true
6603      schema:
6604        type: string
6605        minLength: 1
6606        maxLength: 45
6607    locationQueryByNameOrCodeParam:
6608      in: query
6609      name: queryBy
6610      description: Parameter to query objects by. Can either be Name or Code. Defaults to Name
6611      required: false
6612      schema:
6613        type: string
6614    buildingNameParam:
6615      in: path
6616      name: b
6617      description: Identifying name for a building
6618      required: true
6619      schema:
6620        type: string
6621        minLength: 1
6622        maxLength: 45
6623    newNameParam:
6624      in: query
6625      name: n
6626      description: New name
6627      required: false
6628      schema:
6629        type: string
6630        minLength: 1
6631        maxLength: 100
6632    contactRequirementCodeQueryParam:
6633      in: query
6634      name: newCode
6635      description: New code for the Contact Requirement
6636      required: false
6637      schema:
6638        type: string
6639        minLength: 1
6640        maxLength: 100
6641    newCodeParam:
6642      in: query
6643      name: code
6644      description: New code
6645      required: false
6646      schema:
6647        type: string
6648        minLength: 1
6649        maxLength: 45
6650    buildingNameOrCodeParam:
6651      in: path
6652      name: b
6653      description: Identifying name or code for a building
6654      required: true
6655      schema:
6656        type: string
6657        minLength: 1
6658        maxLength: 45
6659    buildingNameParamQ:
6660      in: query
6661      name: b
6662      description: Identifying name for a building
6663      required: false
6664      schema:
6665        type: string
6666        minLength: 1
6667        maxLength: 45
6668    buildingNameParamQReq:
6669      in: query
6670      name: b
6671      description: Identifying name for a building
6672      required: true
6673      schema:
6674        type: string
6675        minLength: 1
6676        maxLength: 45
6677    floorNameParam:
6678      in: path
6679      name: f
6680      description: Identifying name for a floor
6681      required: true
6682      schema:
6683        type: string
6684        minLength: 1
6685        maxLength: 45
6686    floorNameOrCodeParam:
6687      in: path
6688      name: f
6689      description: Identifying name or Code for a floor
6690      required: true
6691      schema:
6692        type: string
6693        minLength: 1
6694        maxLength: 45
6695    floorNameParamQ:
6696      in: query
6697      name: f
6698      description: Identifying name for a floor
6699      required: false
6700      schema:
6701        type: string
6702        minLength: 1
6703        maxLength: 45
6704    floorNameParamQReq:
6705      in: query
6706      name: f
6707      description: Identifying name for a floor
6708      required: true
6709      schema:
6710        type: string
6711        minLength: 1
6712        maxLength: 45
6713    campusNewNameParam:
6714      in: query
6715      name: 'n'
6716      description: New identifying name for a campus
6717      required: false
6718      schema:
6719        type: string
6720        minLength: 1
6721        maxLength: 45
6722    campusNewCodeParam:
6723      in: query
6724      name: code
6725      description: New identifying code for a campus
6726      required: false
6727      schema:
6728        type: string
6729        minLength: 1
6730        maxLength: 45
6731    moduleNameParamReq:
6732      in: query
6733      name: 'n'
6734      description: Full name
6735      required: true
6736      schema:
6737        type: string
6738        minLength: 1
6739        maxLength: 255
6740    moduleNameParam:
6741      in: query
6742      name: 'n'
6743      description: Full name
6744      required: false
6745      schema:
6746        type: string
6747        minLength: 1
6748        maxLength: 255
6749    offerQueryTimeframeCodes:
6750      in: query
6751      name: 'tf'
6752      description: A CSV list of timeframe codes to filter the response by
6753      required: false
6754      schema:
6755        type: string
6756        minLength: 1
6757        maxLength: 110
6758        example: Sem1,Sem2
6759    offerNameParamReq:
6760      in: path
6761      name: 'n'
6762      description: Offer name
6763      required: true
6764      schema:
6765        type: string
6766        minLength: 1
6767        maxLength: 255
6768    offerNeedsNoTeaching:
6769      in: query
6770      name: notr
6771      description: 1 if the offer doesn't require teaching, 0 otherwise
6772      required: false
6773      schema:
6774        type: number
6775        minimum: 0
6776        maximum: 1
6777    offerNameOrAltCodeParamReq:
6778      in: path
6779      name: 'n'
6780      description: Offer name (or Alt Code if useAltc is true)
6781      required: true
6782      schema:
6783        type: string
6784        minLength: 1
6785        maxLength: 255
6786    creditsParam:
6787      in: query
6788      name: cr
6789      description: The credits for the module
6790      schema:
6791        type: number
6792        minimum: 0
6793        maximum: 9999.999
6794        nullable: true
6795    principalNameParam:
6796      in: query
6797      name: pn
6798      description: Principal name for SSO
6799      schema:
6800        type: string
6801        minLength: 1
6802        maxLength: 60
6803    mobParam:
6804      in: query
6805      name: mob
6806      description: Mobile phone number
6807      schema:
6808        type: string
6809        minLength: 1
6810        maxLength: 30
6811    addressParam:
6812      in: query
6813      name: addr
6814      description: Full address
6815      schema:
6816        type: string
6817    capsParam:
6818      in: query
6819      name: caps
6820      description: CSV list (or JSON array) of names of Capabilities
6821      schema:
6822        type: string
6823    CapabilitiesParam:
6824      in: query
6825      name: capabilities
6826      description: CSV list (or JSON array) of names of Capabilities.  If you send a Capability that is not already in TermTime then TermTime will create a new Capability.
6827      schema:
6828        type: string
6829    Capabilities2Param:
6830      in: query
6831      name: capabilities
6832      required: false
6833      description: CSV list (or JSON array) of names of Capabilities
6834      schema:
6835        type: string
6836        minLength: 1
6837    SpecialRequirementParam:
6838      in: query
6839      name: sr
6840      required: false
6841      description: CSV list (or JSON array) of names of special requirements
6842      schema:
6843        type: string
6844        minLength: 1
6845    staffParam:
6846      in: query
6847      name: staff
6848      description: CSV list (or JSON array) of codes of Staff
6849      schema:
6850        type: string
6851    weekTemplateParam:
6852      in: query
6853      name: wt
6854      description: Name of the Week Template
6855      schema:
6856        type: string
6857        minLength: 1
6858        maxLength: 50
6859    nominalHoursParam:
6860      in: query
6861      name: nh
6862      description: Nominal hours for the year
6863      schema:
6864        type: number
6865        default: 100
6866    nominalHoursAdjustParam:
6867      in: query
6868      name: nha
6869      description: Adjustment to nominal hours
6870      schema:
6871        type: number
6872        default: 0
6873        minimum: 0
6874        maximum: 9999
6875    departmentCodeParamP:
6876      in: path
6877      name: c
6878      description: Department Code
6879      required: true
6880      schema:
6881        type: string
6882        minLength: 1
6883        maxLength: 255
6884    locationCodeParamP:
6885      in: path
6886      name: code
6887      description: Location Code
6888      required: true
6889      schema:
6890        type: string
6891        minLength: 1
6892        maxLength: 255
6893    locationNameParam:
6894      in: query
6895      name: name
6896      description: Location Name
6897      required: true
6898      schema:
6899        type: string
6900        minLength: 1
6901        maxLength: 255
6902    assessmentTypeNewNameParam:
6903      in: query
6904      name: newName
6905      description: A unique name to rename the Assessment Type to
6906      required: false
6907      schema:
6908        type: string
6909        minLength: 1
6910        maxLength: 255
6911    assessmentTypeParentCodeParam:
6912      in: query
6913      name: parent
6914      description: The unique code to identify the parent of the assessment type
6915      required: false
6916      schema:
6917        type: number
6918        minimum: 1
6919        example: 9
6920    locationNameParamO:
6921      in: query
6922      name: name
6923      description: Location Name
6924      required: false
6925      schema:
6926        type: string
6927        minLength: 1
6928        maxLength: 255
6929    exemptionCodeParamPath:
6930      in: path
6931      name: code
6932      description: Exemption Code
6933      required: true
6934      schema:
6935        type: string
6936        minLength: 1
6937        maxLength: 255
6938    locationCode:
6939      in: query
6940      name: newCode
6941      description: Location Code
6942      required: true
6943      schema:
6944        type: string
6945        minLength: 1
6946        maxLength: 255
6947    departmentParentCodeParam:
6948      in: query
6949      name: p
6950      description: Code for parent Department or OU
6951      required: false
6952      schema:
6953        type: string
6954        minLength: 1
6955        maxLength: 255
6956    timeframeCodeParamP:
6957      in: path
6958      name: c
6959      description: Timeframe Code
6960      required: true
6961      schema:
6962        type: string
6963        minLength: 1
6964        maxLength: 110
6965    departmentCodeParam:
6966      in: query
6967      name: dc
6968      description: Department Code
6969      schema:
6970        type: string
6971        minLength: 1
6972        maxLength: 255
6973    departmentCodeParamOld:
6974      in: query
6975      name: dn
6976      description: Department Code
6977      schema:
6978        type: string
6979        minLength: 1
6980        maxLength: 255
6981    departmentNameParamReq:
6982      in: query
6983      name: 'n'
6984      description: Department Name
6985      required: true
6986      schema:
6987        type: string
6988        minLength: 1
6989        maxLength: 255
6990    timeframeNameParamReq:
6991      in: query
6992      name: 'n'
6993      description: Timeframe Name
6994      required: true
6995      schema:
6996        type: string
6997        minLength: 1
6998        maxLength: 120
6999    timeframeNameParam:
7000      in: query
7001      name: 'n'
7002      description: Timeframe Name
7003      required: false
7004      schema:
7005        type: string
7006        minLength: 1
7007        maxLength: 120
7008    timeframeFirstParamReq:
7009      in: query
7010      name: f
7011      description: Timeframe first week - either e.g. 1 for first week of academic year
7012      required: true
7013      schema:
7014        type: number
7015    timeframeFirstParam:
7016      in: query
7017      name: f
7018      description: Timeframe first week - either e.g. 1 for first week of academic year
7019      required: false
7020      schema:
7021        type: number
7022    timeframeLastParamReq:
7023      in: query
7024      name: l
7025      description: Timeframe last week - either e.g. 1 for first week of academic year
7026      required: true
7027      schema:
7028        type: number
7029    timeframeLastParam:
7030      in: query
7031      name: l
7032      description: Timeframe last week - either e.g. 1 for first week of academic year
7033      required: false
7034      schema:
7035        type: number
7036    timeframeStartParam:
7037      in: query
7038      name: start
7039      description: Start date of the timeframe in YYYY-MM-DD format
7040      required: false
7041      schema:
7042        type: string
7043    timeframeEndParam:
7044      in: query
7045      name: end
7046      description: End date of the timeframe in YYYY-MM-DD format
7047      required: false
7048      schema:
7049        type: string
7050    departmentNameParam:
7051      in: query
7052      name: 'n'
7053      description: Department Name
7054      required: false
7055      schema:
7056        type: string
7057        minLength: 1
7058        maxLength: 255
7059    departmentDescriptionParam:
7060      in: query
7061      name: desc
7062      description: Department Description
7063      required: false
7064      schema:
7065        type: string
7066        minLength: 1
7067        maxLength: 65535
7068    courseDescriptionParam:
7069      in: query
7070      name: desc
7071      description: Course Description
7072      required: false
7073      schema:
7074        type: string
7075        minLength: 1
7076        maxLength: 255
7077    postCourseTagsParam:
7078      in: query
7079      name: tags
7080      description: Comma separated list of public tags to add to the newly created course.
7081      required: false
7082      schema:
7083        type: string
7084        minLength: 1
7085        maxLength: 255
7086    moduleDescriptionParam:
7087      in: query
7088      name: desc
7089      description: Module Description
7090      required: false
7091      schema:
7092        type: string
7093        minLength: 1
7094        maxLength: 255
7095    moduleStaffRightsParam:
7096      in: query
7097      name: sr
7098      description: Comma separated list of staff codes to add rights for in the module
7099      required: false
7100      schema:
7101        type: string
7102        minLength: 1
7103        maxLength: 255
7104    daytemplateNameParam:
7105      in: query
7106      name: dt
7107      description: Day Template Name
7108      required: true
7109      schema:
7110        type: string
7111        minLength: 1
7112        maxLength: 45
7113    daytemplateName2Param:
7114      in: query
7115      name: dayTemplate
7116      description: Day Template Name
7117      required: false
7118      schema:
7119        type: string
7120        minLength: 1
7121        maxLength: 45
7122    departmentCodeParamReq:
7123      in: query
7124      name: dc
7125      description: Department Code
7126      required: true
7127      schema:
7128        type: string
7129        minLength: 1
7130        maxLength: 255
7131    levelParam:
7132      in: query
7133      name: level
7134      description: course level e.g. BA1 or MA
7135      schema:
7136        type: string
7137        nullable: true
7138        minLength: 0
7139        maxLength: 45
7140    ownerParam:
7141      in: query
7142      name: s
7143      description: The code of the staff owner
7144      schema:
7145        type: string
7146        minLength: 0
7147        maxLength: 45
7148    user1Param:
7149      in: query
7150      name: user1
7151      description: User-definable field 1
7152      schema:
7153        type: string
7154        minLength: 0
7155        maxLength: 60
7156    user2Param:
7157      in: query
7158      name: user2
7159      description: User-definable field 2
7160      schema:
7161        type: string
7162        minLength: 0
7163        maxLength: 60
7164    user3Param:
7165      in: query
7166      name: user3
7167      description: User-definable field 3
7168      schema:
7169        type: string
7170        minLength: 0
7171        maxLength: 60
7172    user4Param:
7173      in: query
7174      name: user4
7175      description: User-definable field 4
7176      schema:
7177        type: string
7178        minLength: 0
7179        maxLength: 60
7180    user5Param:
7181      in: query
7182      name: user5
7183      description: User-definable field 5
7184      schema:
7185        type: string
7186        minLength: 0
7187        maxLength: 60
7188    user6Param:
7189      in: query
7190      name: user6
7191      description: User-definable field 6
7192      schema:
7193        type: string
7194        minLength: 0
7195        maxLength: 60
7196    user1ParamLong:
7197      in: query
7198      name: user1
7199      description: User-definable field 1
7200      schema:
7201        type: string
7202        minLength: 0
7203        maxLength: 256
7204    user2ParamLong:
7205      in: query
7206      name: user2
7207      description: User-definable field 2
7208      schema:
7209        type: string
7210        minLength: 0
7211        maxLength: 256
7212    moCoreParam:
7213      in: query
7214      name: moCore
7215      description: CSV list (or JSON array) of core module offers (or core modules if useModules is set to 1)
7216      schema:
7217        type: string
7218    moOptionParam:
7219      in: query
7220      name: moOption
7221      description: CSV list (or JSON array) of optional module offers (or optional modules if useModules is set to 1)
7222      schema:
7223        type: string
7224    mincParam:
7225      in: query
7226      name: minc
7227      description: The minimum credits for a course
7228      schema:
7229        type: integer
7230    maxcParam:
7231      in: query
7232      name: maxc
7233      description: The maximum credits for a course
7234      schema:
7235        type: integer
7236    rbDaysAdvanceParam:
7237      in: query
7238      name: rbda
7239      description: >-
7240        Deprecated. Set in room booking profiles.
7241        Number of days advance a booking can be made
7242      schema:
7243        type: integer
7244        minimum: 0
7245        maximum: 999
7246        default: 14
7247    rbHoursPerWeekParam:
7248      in: query
7249      name: rbpw
7250      description: >-
7251        Deprecated. Set in room booking profiles.
7252        Max number of hours per week that could be booked
7253      schema:
7254        type: integer
7255        minimum: 0
7256        maximum: 999
7257        default: 100
7258    rbHoursPerDayParam:
7259      in: query
7260      name: rbpd
7261      description: >-
7262        Deprecated. Set in room booking profiles.
7263        Max number of hours per day that could be booked
7264      schema:
7265        type: integer
7266        minimum: 0
7267        maximum: 999
7268        default: 10
7269    rbMaxBookingParam:
7270      in: query
7271      name: rbmb
7272      description: >-
7273        Deprecated. Set in room booking profiles. Max single booking
7274      schema:
7275        type: integer
7276        minimum: 0
7277        maximum: 999
7278        default: 4
7279    rbMinGapParam:
7280      in: query
7281      name: rbmg
7282      description: >-
7283        Deprecated. Set in room booking profiles.
7284        Minimum gap between bookings
7285      schema:
7286        type: integer
7287        minimum: 0
7288        maximum: 999
7289        default: 2
7290    rbRoomPoolParam:
7291      in: query
7292      name: rbrp
7293      required: false
7294      description: >-
7295        Deprecated. Set in room booking profiles.
7296        Room pool for bookings
7297      schema:
7298        type: string
7299        minLength: 1
7300        maxLength: 65
7301    tdParam:
7302      in: query
7303      name: td
7304      description: To Delete flag
7305      schema:
7306        type: integer
7307        minimum: 0
7308        maximum: 1
7309    runningParamReq:
7310      in: query
7311      name: r
7312      description: Running flag
7313      required: true
7314      schema:
7315        type: integer
7316        minimum: 0
7317        maximum: 1
7318    runningParam:
7319      in: query
7320      name: r
7321      description: Running flag
7322      schema:
7323        type: integer
7324        minimum: 0
7325        maximum: 1
7326    createActivitiesFromTemplateParamReq:
7327      in: query
7328      name: caft
7329      description: 1 if all Activities created from this Offer must use a Contact Requirement (0 otherwise)
7330      required: true
7331      schema:
7332        type: integer
7333        minimum: 0
7334        maximum: 1
7335    createActivitiesFromTemplateParam:
7336      in: query
7337      name: caft
7338      description: 1 if all Activities created from this Offer must use a Contact Requirement (0 otherwise)
7339      schema:
7340        type: integer
7341        minimum: 0
7342        maximum: 1
7343    plansizeParam:
7344      in: query
7345      name: ps
7346      description: Planned Size
7347      schema:
7348        type: integer
7349        minimum: 0
7350        maximum: 999
7351    startDateParam:
7352      in: query
7353      name: start
7354      description: Start date in YYYY-MM-DD format
7355      schema:
7356        type: string
7357        minLength: 10
7358        maxLength: 10
7359    startDate2Param:
7360      in: query
7361      name: startDate
7362      description: Start date in YYYY-MM-DD format (UTC timezone assumed)
7363      schema:
7364        type: string
7365        minLength: 10
7366        maxLength: 10
7367    submissionDateParam:
7368      in: query
7369      name: submissionDate
7370      description: Submission date and time in UTC formatted like 2020-08-31T09:30Z
7371      schema:
7372        type: string
7373        minLength: 17
7374        maxLength: 17
7375    submissionStartDateParam:
7376      in: query
7377      name: submissionStartDate
7378      description: Start date and time in UTC formatted like 2020-08-31T09:30Z
7379      schema:
7380        type: string
7381        minLength: 17
7382        maxLength: 17
7383    endDateParam:
7384      in: query
7385      name: end
7386      description: End date in YYYY-MM-DD format
7387      schema:
7388        type: string
7389        minLength: 10
7390        maxLength: 10
7391    endDate2Param:
7392      in: query
7393      name: endDate
7394      description: End date in YYYY-MM-DD format (UTC timezone assumed)
7395      schema:
7396        type: string
7397        minLength: 10
7398        maxLength: 10
7399    daysParam:
7400      in: query
7401      name: days
7402      description: Number of days (from 1 up to 366)
7403      required: true
7404      schema:
7405        type: integer
7406        minLength: 1
7407        maxLength: 366
7408    hoursQueryParam:
7409      in: query
7410      name: h
7411      description: Number of hours (in units of Slots)
7412      required: false
7413      schema:
7414        type: integer
7415        minLength: 1
7416        maxLength: 9999
7417    planSizeQueryParam:
7418      in: query
7419      name: ps
7420      description: Plan size
7421      required: false
7422      schema:
7423        type: integer
7424        minLength: 1
7425        maxLength: 9999
7426    user1QueryParam:
7427      in: query
7428      name: u1
7429      description: User-definable field 1
7430      required: false
7431      schema:
7432        type: string
7433        minLength: 1
7434        maxLength: 255
7435    user2QueryParam:
7436      in: query
7437      name: u2
7438      description: User-definable field 2
7439      required: false
7440      schema:
7441        type: string
7442        minLength: 1
7443        maxLength: 255
7444    user3QueryParam:
7445      in: query
7446      name: u3
7447      description: User-definable field 3
7448      required: false
7449      schema:
7450        type: string
7451        minLength: 1
7452        maxLength: 255
7453    returnNotesParam:
7454      in: query
7455      name: notes
7456      description: '1 to return notes, defaults to 0'
7457      schema:
7458        type: integer
7459        minimum: 0
7460        maximum: 1
7461    webhookCodeParam:
7462      in: path
7463      name: c
7464      description: The code chosen by the customer to identify the webhook.
7465      required: true
7466      schema:
7467        type: string
7468        minLength: 1
7469        maxLength: 60
7470    webhookTypeParamReq:
7471      in: query
7472      name: t
7473      description: "The type of webhook, for example 'activity.new' is a webhook for Activity creation"
7474      required: true
7475      schema:
7476        type: string
7477        minLength: 1
7478        maxLength: 255
7479    webhookTypeParam:
7480      in: query
7481      name: t
7482      description: 'The type of object that, when changed, will cause the webhook to be invoked.'
7483      schema:
7484        type: string
7485        minLength: 1
7486        maxLength: 60
7487    webhookHeaderParam:
7488      in: query
7489      name: h
7490      description: An HTTP header to be sent by Semestry to the customer when the webhook is invoked.
7491      schema:
7492        type: string
7493        minLength: 5
7494        maxLength: 500
7495    webhookVerbParam:
7496      in: query
7497      name: v
7498      description: 'The verb (GET, POST, ...) to be used by Semestry when calling the webhook'
7499      schema:
7500        type: string
7501        minLength: 1
7502        maxLength: 20
7503    webhookUrlParamReq:
7504      in: query
7505      name: u
7506      description: The URL to be called by Semestry when the webhook is invoked.
7507      required: true
7508      schema:
7509        type: string
7510        minLength: 5
7511        maxLength: 500
7512    webhookUrlParam:
7513      in: query
7514      name: u
7515      description: The URL to be called by Semestry when the webhook is invoked.
7516      schema:
7517        type: string
7518        minLength: 5
7519        maxLength: 500
7520    webhookEmailParam:
7521      in: query
7522      name: e
7523      description: The email to which Semestry sends notifications if/when the webhook call fails.
7524      schema:
7525        type: string
7526        minLength: 5
7527        maxLength: 500
7528    contactRequirementNameParamReq:
7529      in: query
7530      name: 'n'
7531      description: Name
7532      required: true
7533      schema:
7534        type: string
7535        minLength: 1
7536        maxLength: 100
7537    contactRequirementNameParam:
7538      in: query
7539      name: 'n'
7540      description: Name
7541      required: false
7542      schema:
7543        type: string
7544        minLength: 1
7545        maxLength: 100
7546    activityTypeQueryParamReq:
7547      in: query
7548      name: sc
7549      description: Unique code to identify the Activity Type
7550      required: true
7551      schema:
7552        type: string
7553        minLength: 1
7554        maxLength: 5
7555    activityTypeQueryParam:
7556      in: query
7557      name: sc
7558      description: Unique code to identify the Activity Type
7559      required: false
7560      schema:
7561        type: string
7562        minLength: 1
7563        maxLength: 5
7564    activityReady:
7565      in: query
7566      name: ready
7567      description: >-
7568        When included, 'Y' will return all ready activities and 'N' will return
7569        all activities that are not ready
7570      required: false
7571      schema:
7572        type: string
7573        minLength: 1
7574        maxLength: 1
7575    activityMeetingRequired:
7576      in: query
7577      name: meetingRequired
7578      description: >-
7579        When included, 'Y' will return all activities that require an online
7580        meeting, and 'N' will return all activities that do not
7581      required: false
7582      schema:
7583        type: string
7584        minLength: 1
7585        maxLength: 1
7586    examCodeParamReq:
7587      in: path
7588      name: c
7589      description: Exam code
7590      required: true
7591      schema:
7592        type: string
7593        minLength: 1
7594        maxLength: 255
7595  schemas:
7596    ActivityMeetingUrlBody:
7597      type: object
7598      properties:
7599        murl:
7600          type: string
7601          description: >-
7602            An online meeting URL string for the activity. Does not need to be
7603            URL encoded
7604          minLength: 1
7605          maxLength: 65535
7606          example: 'https://www.example-meeting-url.co.uk?meeting=params'
7607    GroupOfferUrlBody:
7608      type: object
7609      properties:
7610        goUrl:
7611          type: string
7612          description: >-
7613            An online meeting URL string for the student group-offer mapping.
7614            Does not need to be URL encoded
7615          minLength: 1
7616          maxLength: 65535
7617          example: 'https://www.example-meeting-url.co.uk?meeting=params'
7618    OfferUrlBody:
7619      type: object
7620      properties:
7621        url:
7622          type: string
7623          description: >-
7624            An online meeting URL string for the module offer.
7625            Does not need to be URL encoded
7626          minLength: 1
7627          maxLength: 65535
7628          example: 'https://www.example-meeting-url.co.uk?meeting=params'
7629    OfferFilterBodyArray:
7630      type: array
7631      items:
7632        type: object
7633        properties:
7634          n:
7635            type: string
7636            description: Offer code
7637            minLength: 1
7638            maxLength: 255
7639            example: 105EKN
7640          m:
7641            type: string
7642            description: Module code
7643            minLength: 1
7644            maxLength: 255
7645            example: 105EKN
7646          altc:
7647            type: string
7648            description: Offer alt code
7649            minLength: 1
7650            maxLength: 255
7651            example: 105EKN-A
7652    StudentResponseObject:
7653      type: object
7654      properties:
7655        status:
7656          type: string
7657        student:
7658          $ref: '#/components/schemas/StudentPersonDetailsObject'
7659        timePeriod:
7660          $ref: '#/components/schemas/TimePeriodRequestedObject'
7661        schedule:
7662          type: array
7663          items:
7664            $ref: '#/components/schemas/StudentTimetableObject'
7665    StaffResponseObject:
7666      type: object
7667      properties:
7668        status:
7669          type: string
7670        staff:
7671          $ref: '#/components/schemas/StaffPersonDetailsObject'
7672        timePeriod:
7673          $ref: '#/components/schemas/TimePeriodRequestedObject'
7674        schedule:
7675          type: array
7676          items:
7677            $ref: '#/components/schemas/StaffTimetableObject'
7678    ModuleResponseObject:
7679      type: object
7680      properties:
7681        status:
7682          type: string
7683        module:
7684          $ref: '#/components/schemas/ModuleDetailsObject'
7685        schedule:
7686          type: array
7687          items:
7688            $ref: '#/components/schemas/TimetableObject'
7689    OfferResponseObject:
7690      type: object
7691      properties:
7692        status:
7693          type: string
7694        offer:
7695          $ref: '#/components/schemas/OfferDetailsObject'
7696        schedule:
7697          type: array
7698          items:
7699            $ref: '#/components/schemas/TimetableObject'
7700    CourseResponseObject:
7701      type: object
7702      properties:
7703        status:
7704          type: string
7705        course:
7706          $ref: '#/components/schemas/CourseDetailsObject'
7707        schedule:
7708          type: array
7709          items:
7710            $ref: '#/components/schemas/TimetableObject'
7711    RoomResponseObject:
7712      type: object
7713      properties:
7714        room:
7715          $ref: '#/components/schemas/RoomDetailsObject'
7716        status:
7717          type: string
7718        timePeriod:
7719          $ref: '#/components/schemas/TimePeriodRequestedObject'
7720        schedule:
7721          type: array
7722          items:
7723            $ref: '#/components/schemas/TimetableObject'
7724    StudentGroupResponseObject:
7725      type: object
7726      properties:
7727        status:
7728          type: string
7729        room:
7730          $ref: '#/components/schemas/StudentGroupDetailsObject'
7731        schedule:
7732          type: array
7733          items:
7734            $ref: '#/components/schemas/TimetableObject'
7735    BuildingResponseObject:
7736      type: object
7737      properties:
7738        building:
7739          $ref: '#/components/schemas/BuildingDetailsObject'
7740        status:
7741          type: string
7742        timePeriod:
7743          $ref: '#/components/schemas/TimePeriodRequestedObject'
7744        schedule:
7745          type: array
7746          items:
7747            $ref: '#/components/schemas/TimetableObject'
7748    TimetableObject:
7749      type: object
7750      properties:
7751        date:
7752          type: string
7753        dateDescription:
7754          type: string
7755        week:
7756          type: string
7757        items:
7758          type: array
7759          items:
7760            $ref: '#/components/schemas/ActivitiesObject'
7761        examItems:
7762          type: array
7763          items:
7764            $ref: '#/components/schemas/ExamsObject'
7765        bookingItems:
7766          type: array
7767          items:
7768            $ref: '#/components/schemas/BookingsObject'
7769    StaffTimetableObject:
7770      type: object
7771      properties:
7772        date:
7773          type: string
7774        dateDescription:
7775          type: string
7776        week:
7777          type: string
7778        items:
7779          type: array
7780          items:
7781            $ref: '#/components/schemas/ActivitiesObject'
7782        examItems:
7783          type: array
7784          items:
7785            $ref: '#/components/schemas/ExamsObject'
7786        bookingItems:
7787          type: array
7788          items:
7789            $ref: '#/components/schemas/BookingsObject'
7790        sessionItems:
7791          type: array
7792          items:
7793            $ref: '#/components/schemas/SessionsObject'
7794    StudentTimetableObject:
7795      type: object
7796      properties:
7797        date:
7798          type: string
7799        dateDescription:
7800          type: string
7801        week:
7802          type: string
7803        items:
7804          type: array
7805          items:
7806            $ref: '#/components/schemas/StudentActivitiesObject'
7807        examItems:
7808          type: array
7809          items:
7810            $ref: '#/components/schemas/ExamsObject'
7811        bookingItems:
7812          type: array
7813          items:
7814            $ref: '#/components/schemas/BookingsObject'
7815    StudentPersonDetailsObject:
7816      type: object
7817      properties:
7818        name:
7819          type: string
7820        id:
7821          type: string
7822        user1:
7823          type: string
7824          minLength: 0
7825          maxLength: 60
7826          description: User-definable field 1
7827        user2:
7828          type: string
7829          minLength: 0
7830          maxLength: 60
7831          description: User-definable field 2
7832        user3:
7833          type: string
7834          minLength: 0
7835          maxLength: 60
7836          description: User-definable field 3
7837        user4:
7838          type: string
7839          minLength: 0
7840          maxLength: 60
7841          description: User-definable field 4
7842        user5:
7843          type: string
7844          minLength: 0
7845          maxLength: 60
7846          description: User-definable field 5
7847        user6:
7848          type: string
7849          minLength: 0
7850          maxLength: 60
7851          description: User-definable field 6
7852    StaffPersonDetailsObject:
7853      type: object
7854      properties:
7855        name:
7856          type: string
7857        id:
7858          type: string
7859        user1:
7860          type: string
7861          minLength: 0
7862          maxLength: 60
7863          description: User-definable field 1
7864        user2:
7865          type: string
7866          minLength: 0
7867          maxLength: 60
7868          description: User-definable field 2
7869        user3:
7870          type: string
7871          minLength: 0
7872          maxLength: 60
7873          description: User-definable field 3
7874        user4:
7875          type: string
7876          minLength: 0
7877          maxLength: 60
7878          description: User-definable field 4
7879        user5:
7880          type: string
7881          minLength: 0
7882          maxLength: 60
7883          description: User-definable field 5
7884        user6:
7885          type: string
7886          minLength: 0
7887          maxLength: 60
7888          description: User-definable field 6
7889    ModuleDetailsObject:
7890      type: object
7891      properties:
7892        name:
7893          type: string
7894        id:
7895          type: string
7896    OfferDetailsObject:
7897      type: object
7898      properties:
7899        name:
7900          type: string
7901        id:
7902          type: string
7903    CourseDetailsObject:
7904      type: object
7905      properties:
7906        name:
7907          type: string
7908        id:
7909          type: string
7910    RoomDetailsObject:
7911      type: object
7912      properties:
7913        name:
7914          type: string
7915        id:
7916          type: string
7917    StudentGroupDetailsObject:
7918      type: object
7919      properties:
7920        name:
7921          type: string
7922        id:
7923          type: string
7924    BuildingDetailsObject:
7925      type: object
7926      properties:
7927        name:
7928          type: string
7929        id:
7930          type: string
7931    TimePeriodRequestedObject:
7932      type: object
7933      properties:
7934        start:
7935          type: string
7936          description: 'Date (YYYY-MM-DD)'
7937        end:
7938          type: string
7939          description: 'Date (YYYY-MM-DD)'
7940    ActivitiesObject:
7941      type: object
7942      properties:
7943        uniqueId:
7944          type: string
7945        activityId:
7946          type: string
7947        activityName:
7948          type: string
7949        activityDescription:
7950          type: string
7951        departmentHostKey:
7952          type: string
7953        departmentName:
7954          type: string
7955        startTime:
7956          type: string
7957        endTime:
7958          type: string
7959        activityDurationMins:
7960          type: string
7961        allDayActivity:
7962          type: string
7963        locations:
7964          type: array
7965          items:
7966            $ref: '#/components/schemas/LocationObject'
7967        moduleId:
7968          type: string
7969        moduleDescription:
7970          type: string
7971        moduleUrl:
7972          type: string
7973        bOptional:
7974          type: boolean
7975        streamId:
7976          type: string
7977        activityProperties:
7978          $ref: '#/components/schemas/ActivityProperties'
7979        module:
7980          $ref: '#/components/schemas/ModuleObject'
7981        offer:
7982          $ref: '#/components/schemas/OfferObject'
7983        tags:
7984          type: array
7985          items:
7986            $ref: '#/components/schemas/TagObject'
7987        academics:
7988          type: array
7989          items:
7990            $ref: '#/components/schemas/AcademicObject'
7991    StudentActivitiesObject:
7992      type: object
7993      properties:
7994        uniqueId:
7995          type: string
7996        activityId:
7997          type: string
7998        activityName:
7999          type: string
8000        activityDescription:
8001          type: string
8002        departmentHostKey:
8003          type: string
8004        departmentName:
8005          type: string
8006        startTime:
8007          type: string
8008        endTime:
8009          type: string
8010        activityDurationMins:
8011          type: string
8012        allDayActivity:
8013          type: string
8014        locations:
8015          type: array
8016          items:
8017            $ref: '#/components/schemas/LocationObject'
8018        moduleId:
8019          type: string
8020        moduleDescription:
8021          type: string
8022        moduleUrl:
8023          type: string
8024        bOptional:
8025          type: boolean
8026        streamId:
8027          type: string
8028        activityProperties:
8029          $ref: '#/components/schemas/ActivityProperties'
8030        module:
8031          $ref: '#/components/schemas/ModuleObject'
8032        offer:
8033          $ref: '#/components/schemas/OfferObject'
8034        tags:
8035          type: array
8036          items:
8037            $ref: '#/components/schemas/TagObject'
8038        academics:
8039          type: array
8040          items:
8041            $ref: '#/components/schemas/AcademicObject'
8042        studentGroups:
8043          type: array
8044          description: The Student Group(s) that map the Student to the Activity
8045          items:
8046            $ref: '#/components/schemas/GroupObject'
8047    ExamsObject:
8048      type: object
8049      properties:
8050        academics:
8051          type: array
8052          items:
8053            $ref: '#/components/schemas/AcademicObject'
8054        allDayActivity:
8055          type: string
8056        assessmentPeriodCode:
8057          type: string
8058        departmentHostKey:
8059          type: string
8060        departmentName:
8061          type: string
8062        endTime:
8063          type: string
8064          description: For Classic and Takehome Exams this is the end time of the Exam Sessions. For Serial Exams this is the end time of a Student's Track Slot.
8065        examCode:
8066          type: string
8067        examDescription:
8068          type: string
8069        examDurationMins:
8070          type: number
8071        examId:
8072          type: string
8073        examName:
8074          type: string
8075        examProperties:
8076          $ref: '#/components/schemas/ExamProperties'
8077        locations:
8078          type: array
8079          items:
8080            $ref: '#/components/schemas/LocationObject'
8081        module:
8082          $ref: '#/components/schemas/ModuleObject'
8083        moduleDescription:
8084          type: string
8085        moduleId:
8086          type: string
8087        moduleUrl:
8088          type: string
8089        offer:
8090          $ref: '#/components/schemas/OfferObject'
8091        startTime:
8092          type: string
8093          description: For Classic and Takehome Exams this is the start time of the Exam Sessions. For Serial Exams this is the start time of a Student's Track Slot.
8094        streamId:
8095          type: string
8096        uniqueId:
8097          type: string
8098    BookingsObject:
8099      type: object
8100      properties:
8101        uniqueId:
8102          type: string
8103        bookingId:
8104          type: string
8105        bookingDescription:
8106          type: string
8107        departmentHostKey:
8108          type: string
8109        departmentName:
8110          type: string
8111        startTime:
8112          type: string
8113        endTime:
8114          type: string
8115        bookingDurationMins:
8116          type: string
8117        allDayActivity:
8118          type: string
8119        locations:
8120          type: array
8121          items:
8122            $ref: '#/components/schemas/LocationObject'
8123        moduleId:
8124          type: string
8125        moduleDescription:
8126          type: string
8127        moduleUrl:
8128          type: string
8129        streamId:
8130          type: string
8131        bookingProperties:
8132          $ref: '#/components/schemas/BookingProperties'
8133        module:
8134          $ref: '#/components/schemas/ModuleObject'
8135        offer:
8136          $ref: '#/components/schemas/OfferObject'
8137        tags:
8138          type: array
8139          items:
8140            $ref: '#/components/schemas/TagObject'
8141        academics:
8142          type: array
8143          items:
8144            $ref: '#/components/schemas/AcademicObject'
8145        staffAttendees:
8146          type: array
8147          items:
8148            $ref: '#/components/schemas/StaffCode'
8149    SessionsObject:
8150      type: object
8151      properties:
8152        sessionId:
8153          type: string
8154        sessionName:
8155          type: string
8156        startDate:
8157          type: string
8158        startTime:
8159          type: string
8160        endDate:
8161          type: string
8162        endTime:
8163          type: string
8164        sessionLocation:
8165          type: object
8166          properties:
8167            code:
8168              type: string
8169            building:
8170              type: string
8171            campus:
8172              type: string
8173        staffRole:
8174          type: object
8175          properties:
8176            code:
8177              type: string
8178            name:
8179              type: string
8180        meetingStartTime:
8181          type: string
8182        meetingEndTime:
8183          type: string
8184        meetingNotes:
8185          type: string
8186    ActivityProperties:
8187      type: object
8188      properties:
8189        allDay:
8190          type: string
8191        optional:
8192          type: string
8193        departmentHostKey:
8194          type: string
8195        exceptionGroup:
8196          type: string
8197        friendlyName:
8198          type: string
8199        nopublishstaff:
8200          type: string
8201        nopublishstudent:
8202          type: string
8203        notes:
8204          type: string
8205        planSize:
8206          type: number
8207          description: The plan size
8208          example: 1
8209          nullable: false
8210        ready:
8211          type: string
8212        repeatgroup:
8213          type: string
8214          description: Name of the repeat group to which this event's Activity belongs
8215          nullable: true
8216        repeatOf:
8217          type: string
8218          description: >-
8219            The unique code to identify the activity to which this event's
8220            activity is a repeat of
8221          nullable: true
8222        repeat:
8223          type: string
8224          description: >-
8225            [[ Deprecated -- please use "repeatOf" instead ]]
8226            The unique code to identify the activity to which this event's
8227            activity is a repeat of
8228          nullable: true
8229        size:
8230          type: number
8231          description: The plan or actual size
8232          example: 1
8233          nullable: false
8234        stuCount:
8235          type: number
8236          description: The actual number of students in the activity
8237          example: 20
8238          minimum: 0
8239          nullable: false
8240        typeCode:
8241          type: string
8242        user1:
8243          type: string
8244        user2:
8245          type: string
8246        user3:
8247          type: string
8248        user4:
8249          type: string
8250        user5:
8251          type: string
8252        user6:
8253          type: string
8254        user7:
8255          type: string
8256        virtual:
8257          type: string
8258        meetingRequired:
8259          type: boolean
8260        meetingUrl:
8261          type: string
8262    ExamProperties:
8263      type: object
8264      properties:
8265        allDay:
8266          type: string
8267        altc:
8268          type: string
8269          description: A unique identifier for the Module to which the Exam belongs.
8270          example: abc123
8271          minLength: 1
8272          maxLength: 64
8273          nullable: true
8274        departmentHostKey:
8275          type: string
8276        exceptionGroup:
8277          type: string
8278        friendlyName:
8279          type: string
8280        nopublishstaff:
8281          type: string
8282        nopublishstudent:
8283          type: string
8284        notes:
8285          type: string
8286        planSize:
8287          type: number
8288          description: The plan size
8289          example: 1
8290          nullable: false
8291        ready:
8292          type: string
8293        size:
8294          type: number
8295          description: The plan or actual size
8296          example: 1
8297          nullable: false
8298        typeCode:
8299          type: string
8300          description: Unique code to identify the Activity Type
8301        user1:
8302          type: string
8303        user2:
8304          type: string
8305        user3:
8306          type: string
8307        virtual:
8308          type: string
8309        sharing:
8310          type: string
8311        splittable:
8312          type: string
8313        minRoomSize:
8314          type: number
8315          description: Minimum number of attendees in a room
8316          example: 1
8317          nullable: false
8318        exclusiveStaff:
8319          type: string
8320        trackSlotMinutes:
8321          type: number
8322          description: A value of 0 indicates a parallel exam (all students sit the exam at the same time). Non 0 values indicate the duration, in minutes, for a serial exam session (students allocated to tracks and sit the exam on track after the other)
8323          example: 1
8324          nullable: false
8325    BookingProperties:
8326      type: object
8327      properties:
8328        allDay:
8329          type: string
8330        departmentHostKey:
8331          type: string
8332        notes:
8333          type: string
8334        typeCode:
8335          type: string
8336        user1:
8337          type: string
8338        user2:
8339          type: string
8340        user3:
8341          type: string
8342        user4:
8343          type: string
8344        userFields:
8345          type: array
8346          items:
8347            $ref: '#/components/schemas/UserField'
8348    ModuleObject:
8349      type: object
8350      properties:
8351        altc:
8352          type: string
8353          minLength: 0
8354          maxLength: 64
8355          description: Alt Code
8356        user1:
8357          type: string
8358          minLength: 0
8359          maxLength: 256
8360        user2:
8361          type: string
8362          minLength: 0
8363          maxLength: 256
8364    OfferObject:
8365      type: object
8366      properties:
8367        altc:
8368          type: string
8369          minLength: 0
8370          maxLength: 255
8371          description: Alt Code
8372        user1:
8373          type: string
8374        user2:
8375          type: string
8376    TagObject:
8377      type: object
8378      properties:
8379        n:
8380          type: string
8381    GroupObject:
8382      type: object
8383      properties:
8384        name:
8385          type: string
8386          minLength: 0
8387          maxLength: 255
8388          description: Name of the Student Group
8389        code:
8390          type: string
8391          minLength: 0
8392          maxLength: 45
8393          description: Unique code to identify the Student Group
8394        superGroup:
8395          type: string
8396          minLength: 0
8397          maxLength: 100
8398          description: Name of the Super Group to which the Student Group belongs
8399          nullable: true
8400    AcademicObject:
8401      type: object
8402      properties:
8403        fullName:
8404          type: string
8405          description: Name of the Staff member
8406          example: Prof. Harrison
8407          nullable: false
8408        email:
8409          type: string
8410          description: Email address for the Staff member
8411          example: s35@uni.com
8412          nullable: true
8413        phoneNumber:
8414          type: string
8415          description: Phone number for the Staff member
8416          example: "+447717504475"
8417          nullable: true
8418        role:
8419          type: string
8420          description: The role performed by the Staff member for the Activity or Booking
8421          example: Examiner
8422          nullable: false
8423    AcademicObjectShort:
8424      type: object
8425      properties:
8426        code:
8427          type: string
8428          description: Code of the Staff member
8429          example: S91002
8430          minLength: 1
8431          maxLength: 45
8432          nullable: false
8433        role:
8434          type: string
8435          description: The code of the Role performed by the Staff member for the Activity or Booking
8436          example: Examiner
8437          nullable: false
8438          minLength: 1
8439          maxLength: 45
8440    LocationObject:
8441      type: object
8442      properties:
8443        locationName:
8444          type: string
8445        locationDesc:
8446          type: string
8447        room:
8448          type: string
8449        buildingCode:
8450          type: string
8451          description: Code for the Building
8452          minLength: 1
8453          maxLength: 45
8454        catalogueUrl:
8455          type: string
8456        details:
8457          type: string
8458    RoomsSchedule:
8459      type: object
8460      properties:
8461        roomcode:
8462          type: string
8463          minLength: 1
8464          maxLength: 45
8465          description: Code for room
8466          example: LT A-001
8467        roomname:
8468          type: string
8469          minLength: 1
8470          maxLength: 45
8471          description: Name of room
8472          example: KB.2.029
8473        buildingname:
8474          type: string
8475          minLength: 1
8476          maxLength: 45
8477          description: Name of building
8478          example: Charles Darwin Building
8479        activities:
8480          type: array
8481          description: List of activities and bookings
8482          items:
8483            $ref: '#/components/schemas/RoomSchedule'
8484    RoomSchedule:
8485      type: object
8486      properties:
8487        id:
8488          type: string
8489          description: >-
8490            Activity-NNN or Booking-NNN where NNN is unique for all activities
8491            or bookings as appropriate
8492        name:
8493          type: string
8494          description: Activity name or booking description as appropriate
8495        start:
8496          type: string
8497          description: >-
8498            Datetime (YYYY-MM-DD HH:MM:00) at which the activity or bookings
8499            starts
8500        end:
8501          type: string
8502          description: >-
8503            Datetime (YYYY-MM-DD HH:MM:00) at which the activity or bookings
8504            ends
8505        type:
8506          type: string
8507          description: Activity type or booking type
8508        instance:
8509          type: integer
8510          description: >-
8511            Activities or bookings that repeat for several weeks are given
8512            instance numbers 1, 2, 3, ...
8513        note:
8514          type: string
8515          description: An optional free-text note field for the activity or booking
8516    CapabilityCode:
8517      type: string
8518      description: Unique name to identify the capability
8519      minLength: 1
8520      maxLength: 100
8521      example: Data Projector
8522    Capability:
8523      type: object
8524      properties:
8525        'n':
8526          type: string
8527          description: Unique name to identify the capability
8528          minLength: 1
8529          maxLength: 100
8530          example: Data Projector
8531        'type':
8532          type: integer
8533          description: 0 if the Capabilitiy applies to Activities; 1 if the Capability applies to Exams
8534          minimum: 0
8535          maximum: 1
8536          example: 0
8537    Campus:
8538      type: object
8539      properties:
8540        'n':
8541          type: string
8542          description: Name
8543          minLength: 1
8544          maxLength: 45
8545          example: City
8546        code:
8547          type: string
8548          description: Code
8549          minLength: 1
8550          maxLength: 45
8551          example: C1
8552    Building:
8553      type: object
8554      properties:
8555        'n':
8556          type: string
8557          description: Name
8558          minLength: 1
8559          maxLength: 45
8560          example: Building A
8561        code:
8562          type: string
8563          description: Code
8564          minLength: 1
8565          maxLength: 45
8566          example: C1B1
8567        cn:
8568          type: string
8569          description: Campus name
8570          minLength: 1
8571          maxLength: 45
8572          example: City
8573        fn:
8574          type: array
8575          description: The list of names of Floors in the Building
8576          items:
8577            type: string
8578            nullable: false
8579            minLength: 1
8580            example: Ground
8581    Floor:
8582      type: object
8583      properties:
8584        'n':
8585          type: string
8586          description: Name
8587          minLength: 1
8588          maxLength: 45
8589          example: Ground
8590        code:
8591          type: string
8592          description: Code
8593          minLength: 1
8594          maxLength: 45
8595          example: C1B1F1
8596        bn:
8597          type: string
8598          description: Name
8599          minLength: 1
8600          maxLength: 45
8601          example: Building A
8602        cn:
8603          type: string
8604          description: Campus name
8605          minLength: 1
8606          maxLength: 45
8607          example: City
8608    Room:
8609      type: object
8610      properties:
8611        c:
8612          type: string
8613          description: Code
8614          minLength: 1
8615          maxLength: 45
8616          example: LT-100
8617        n:
8618          type: string
8619          description: Name
8620          minLength: 1
8621          maxLength: 255
8622          example: Lecture Theatre 100
8623        d:
8624          type: object
8625          properties:
8626            c:
8627              type: string
8628              description: Unique code to identify the Department or OU
8629              minLength: 1
8630              maxLength: 255
8631              example: Mechanical Engineering
8632              nullable: true
8633            n:
8634              type: string
8635              description: Unique name to identify the Department
8636              minLength: 1
8637              maxLength: 255
8638              example: Business Dept.
8639              nullable: false
8640        f:
8641          type: object
8642          properties:
8643            n:
8644              type: string
8645              description: Name
8646              minLength: 1
8647              maxLength: 45
8648              example: Ground
8649            fc:
8650              type: string
8651              description: Floor code
8652              minLength: 1
8653              maxLength: 45
8654              example: C1B1F1
8655            b:
8656              type: string
8657              description: Name
8658              minLength: 1
8659              maxLength: 45
8660              example: Building A
8661            bc:
8662              type: string
8663              description: Code for the Building
8664              minLength: 1
8665              maxLength: 45
8666            c:
8667              type: string
8668              description: Name
8669              minLength: 1
8670              maxLength: 45
8671              example: City
8672            cc:
8673              type: string
8674              description: Code for the Campus
8675              minLength: 1
8676              maxLength: 45
8677        rc:
8678          type: array
8679          description: Room booking capacities for different activity types
8680          items:
8681            type: object
8682            properties:
8683              type:
8684                type: string
8685                description: Activity type name
8686                example: Lecture
8687              code:
8688                type: string
8689                description: Activity type code
8690                example: Lec
8691              cap:
8692                type: integer
8693                description: Room capacity for activity type
8694                example: 20
8695        pool:
8696          type: string
8697          description: CSV list of room pools the room belongs to
8698          minLength: 1
8699          nullable: true
8700          example: C Block,SSB Rooms
8701        user1:
8702          description: DEPRECATED and to be replaced by 'userFields'
8703          type: string
8704          minLength: 0
8705          maxLength: 60
8706        user2:
8707          description: DEPRECATED and to be replaced by 'userFields'
8708          type: string
8709          minLength: 0
8710          maxLength: 60
8711        user3:
8712          description: DEPRECATED and to be replaced by 'userFields'
8713          type: string
8714          minLength: 0
8715          maxLength: 60
8716        userFields:
8717          description: Array of zero or more user-defined fields
8718          type: array
8719          items:
8720            $ref: '#/components/schemas/UserField'
8721        blockedRooms:
8722          description: Array of room codes that are blocked when this room is busy
8723          type: array
8724          items:
8725            $ref: '#/components/schemas/RoomCode'
8726        capabilities:
8727          type: string
8728          description: A CSV list of room capabilities
8729          nullable: true
8730          minLength: 0
8731          example: L/Tiered,E/Data Projector,E/Hearing Loop,D/Wheelchair
8732        capabilities.json:
8733          type: array
8734          description: JSON array of capabilities
8735          items:
8736              $ref: '#/components/schemas/CapabilityCode'
8737        sr:
8738          type: string
8739          description: A CSV list of room's special requirements
8740          nullable: true
8741          minLength: 0
8742          example: Writer, Reader
8743        toDelete:
8744          type: integer
8745          minimum: 0
8746          maximum: 1
8747          description: '1 if Room is marked for deletion, otherwise 0'
8748          example: 0
8749    UserField:
8750      type: object
8751      properties:
8752        index:
8753          description: User field number
8754          example: 3
8755          type: number
8756          nullable: false
8757          minimum: 1
8758        value:
8759          description: Value stored in the user field
8760          example: 'To be actioned'
8761          type: string
8762          nullable: true
8763        type:
8764          description: A description of the type of the value
8765          example: '"string" or "int" or "enum"'
8766          type: string
8767          nullable: false
8768        min:
8769          description: optional, minimum value (applied to user fields of type 'int')
8770          type: number
8771          nullable: false
8772        max:
8773          description: optional, maximum value (applied to user fields of type 'int')
8774          type: number
8775          nullable: false
8776    RoomCode:
8777      type: string
8778      description: Unique code to identify the Room
8779      minLength: 1
8780      maxLength: 45
8781      example: LT-100
8782    ActivityCode:
8783      type: string
8784      description: A unique identifier for the Activity
8785      example: '655'
8786      minLength: 1
8787      nullable: false
8788    StudentOfferMapping:
8789      type: object
8790      properties:
8791        c:
8792          type: string
8793          description: Unique code to identify the type of the Student-Offer mapping
8794          minLength: 1
8795          maxLength: 255
8796          example: DEF
8797        n:
8798          type: string
8799          description: A descriptive name for the type of the Student-Offer mapping
8800          minLength: 1
8801          maxLength: 255
8802          example: Participating
8803    StudentGroupActivityMapping:
8804      type: object
8805      properties:
8806        gc:
8807          type: string
8808          description: Unique code to identify the Student Group
8809          minLength: 1
8810          maxLength: 45
8811          example: studentgroup123
8812        c:
8813          type: string
8814          description: Unique code to identify the Activity
8815          minLength: 1
8816          maxLength: 255
8817          example: '690'
8818        user1:
8819          type: string
8820          nullable: true
8821          description: User-definable field 1
8822          minLength: 1
8823          maxLength: 256
8824          example: '690'
8825    StudentGroupOfferMapping:
8826      type: object
8827      properties:
8828        gc:
8829          type: string
8830          description: Unique code to identify the Student Group
8831          minLength: 1
8832          maxLength: 45
8833          example: studentgroup123
8834        n:
8835          type: string
8836          description: The offer name
8837          minLength: 1
8838          maxLength: 255
8839          example: 105EKN
8840        m:
8841          type: string
8842          minLength: 1
8843          maxLength: 255
8844          description: The module code
8845          example: 105EKN
8846        altc:
8847          type: string
8848          minLength: 0
8849          maxLength: 255
8850          description: Alt Code
8851          example: 123-456.200
8852        goUrl:
8853          type: string
8854          minLength: 1
8855          maxLength: 65535
8856          nullable: true
8857          description: URL for the student group-offer mapping
8858          example: 'https://www.example-meeting-url.co.uk?meeting=params'
8859    StudentGroup:
8860      type: object
8861      properties:
8862        gc:
8863          type: string
8864          description: Unique code to identify the Student Group
8865          minLength: 1
8866          maxLength: 45
8867          example: studentgroup123
8868        gn:
8869          type: string
8870          description: Name for the Student Group
8871          minLength: 1
8872          maxLength: 255
8873          example: Student Group 123
8874        cc:
8875          type: string
8876          description: Unique code to identify the Course
8877          minLength: 1
8878          maxLength: 255
8879          example: BUS002/2
8880          nullable: true
8881        sz:
8882          type: number
8883          description: The size of the Student Group
8884          example: 1
8885          nullable: false
8886        dc:
8887          type: string
8888          description: The code of the department that owns the course
8889          example: ENG
8890        offers:
8891          type: array
8892          items:
8893            $ref: '#/components/schemas/OfferReferenceWithGroupOfferUrl'
8894        tags:
8895          type: array
8896          items:
8897            $ref: '#/components/schemas/TagObject'
8898        activities:
8899          description: List of Acivities mapped to the Student Group
8900          type: array
8901          items:
8902            type: string
8903            description: A unique identifier for the Activity
8904            example: '1234'
8905            minLength: 1
8906            nullable: false
8907        superGroup:
8908          type: string
8909          description: The name of the group's super group
8910          minLength: 1
8911          maxLength: 100
8912          example: Super Group 1
8913          nullable: true
8914    StudentGroupWithStudents:
8915      type: object
8916      properties:
8917        gc:
8918          type: string
8919          description: Unique code to identify the Student Group
8920          minLength: 1
8921          maxLength: 45
8922          example: studentgroup123
8923        gn:
8924          type: string
8925          description: Name for the Student Group
8926          minLength: 1
8927          maxLength: 255
8928          example: Student Group 123
8929        cc:
8930          type: string
8931          description: Unique code to identify the Course
8932          minLength: 1
8933          maxLength: 255
8934          example: BUS002/2
8935          nullable: true
8936        sz:
8937          type: number
8938          description: The size of the Student Group
8939          example: 1
8940          nullable: false
8941        dc:
8942          type: string
8943          description: The code of the department that owns the course
8944          example: ENG
8945        offers:
8946          type: array
8947          items:
8948            $ref: '#/components/schemas/OfferReferenceWithGroupOfferUrl'
8949        tags:
8950          type: array
8951          items:
8952            $ref: '#/components/schemas/TagObject'
8953        activities:
8954          description: List of Activities mapped to the Student Group
8955          type: array
8956          items:
8957            type: string
8958            description: A unique identifier for the Activity
8959            example: '1234'
8960            minLength: 1
8961            nullable: false
8962        students:
8963          description: List of Students in the Student Group
8964          type: array
8965          items:
8966            $ref: '#/components/schemas/StudentCode'
8967        superGroup:
8968          type: string
8969          description: The name of the group's super group
8970          minLength: 1
8971          maxLength: 100
8972          example: Super Group 1
8973          nullable: true
8974    StudentGroupMap:
8975      type: object
8976      properties:
8977        s:
8978          type: string
8979          description: Unique code to identify the Student
8980          minLength: 1
8981          maxLength: 60
8982          example: student123
8983        g:
8984          type: string
8985          description: Unique code to identify the Student Group
8986          minLength: 1
8987          maxLength: 45
8988          example: studentgroup123
8989    StudentGroupCode:
8990      type: string
8991      description: Unique code to identify the Student Group
8992      minLength: 1
8993      maxLength: 45
8994      example: studentgroup123
8995    StudentGroupName:
8996      type: string
8997      description: Name for the Student Group
8998      minLength: 1
8999      maxLength: 255
9000      example: Student Group 123
9001    Location:
9002      type: object
9003      properties:
9004        c:
9005          type: string
9006          description: Unique code to identify the Location
9007          minLength: 1
9008          maxLength: 255
9009          example: ABC123
9010          nullable: false
9011        n:
9012          type: string
9013          description: Name to describe the Location
9014          minLength: 1
9015          maxLength: 255
9016          example: ABC123
9017          nullable: false
9018    Exemption:
9019      type: object
9020      properties:
9021        code:
9022          type: string
9023          description: Unique code to identify the Exemption
9024          minLength: 1
9025          maxLength: 255
9026          example: '1001'
9027          nullable: false
9028        reason:
9029          type: string
9030          description: Reason for the exemption
9031          minLength: 1
9032          maxLength: 255
9033          example: Relevant work experience
9034          nullable: false
9035        students:
9036          type: array
9037          items:
9038            $ref: '#/components/schemas/StudentCode2'
9039        activities:
9040          type: array
9041          items:
9042            $ref: '#/components/schemas/ActivityCode'
9043    Database:
9044      type: object
9045      properties:
9046        Name:
9047          type: string
9048          description: Database name
9049          minLength: 1
9050          maxLength: 45
9051          example: LondonLeeDemo
9052          nullable: false
9053        BackupsEnabled:
9054          type: boolean
9055          description: True if the database is configured for backups
9056          example: true
9057          nullable: false
9058        BackupIntervalInMinutes:
9059          type: integer
9060          minimum: 1
9061          nullable: false
9062          example: 60
9063        LastBackupTimeUtc:
9064          type: string
9065          description: The date and time at which the last backup was done in ISO 8601 format
9066          example: "2000-01-01T00:00:00+00:00"
9067          nullable: false
9068        Statistics:
9069          type: object
9070          description: Various statistics grouped by Department
9071    Department:
9072      type: object
9073      properties:
9074        c:
9075          type: string
9076          description: Unique code to identify the Department or OU
9077          minLength: 1
9078          maxLength: 255
9079          example: Mechanical Engineering
9080          nullable: true
9081        n:
9082          type: string
9083          description: Unique name to identify the Department
9084          minLength: 1
9085          maxLength: 255
9086          example: Business Dept.
9087          nullable: false
9088        d:
9089          type: string
9090          description: Description for the Department
9091          minLength: 1
9092          maxLength: 65535
9093          example: The Department of Business
9094          nullable: true
9095        p:
9096          type: string
9097          description: Unique code to identify the parent Deparment or OU
9098          minLength: 1
9099          maxLength: 255
9100          example: Engineering
9101          nullable: true
9102        tags:
9103          type: array
9104          items:
9105            $ref: '#/components/schemas/TagObject'
9106    TimeFrame:
9107      type: object
9108      properties:
9109        c:
9110          type: string
9111          description: Unique code to identify the Timeframe
9112          minLength: 1
9113          maxLength: 110
9114          example: SEM1
9115          nullable: false
9116        'n':
9117          type: string
9118          description: Name to identify the Timeframe
9119          minLength: 1
9120          maxLength: 120
9121          example: Business Dept.
9122          nullable: false
9123        f:
9124          type: number
9125          description: First week of the Timeframe
9126          example: 1
9127          nullable: true
9128        l:
9129          type: number
9130          description: Last week of the Timeframe
9131          example: 52
9132          nullable: true
9133        fDate:
9134          type: string
9135          description: 'First date of the Timeframe i.e. first day of first week (format: yyyy-mm-dd)'
9136          example: '2018-08-27'
9137          nullable: true
9138        lDate:
9139          type: string
9140          description: 'Last date of the Timeframe i.e. last day of last week (format: yyyy-mm-dd)'
9141          example: '2018-12-03'
9142          nullable: true
9143    ActivityType:
9144      type: object
9145      properties:
9146        c:
9147          type: string
9148          description: Unique code to identify the Activity Type
9149          minLength: 1
9150          maxLength: 5
9151          example: LEC
9152          nullable: false
9153        'n':
9154          type: string
9155          description: Name to identify the Activity Type
9156          minLength: 1
9157          maxLength: 45
9158          example: Lecture
9159          nullable: false
9160        colour:
9161          type: string
9162          description: A 6-character hex code for the Colour
9163          example: FAF4A0
9164          nullable: false
9165    BookingType:
9166      type: object
9167      properties:
9168        c:
9169          type: string
9170          description: Unique code to identify the Booking Type
9171          minLength: 1
9172          maxLength: 5
9173          example: LEC
9174          nullable: false
9175        'n':
9176          type: string
9177          description: Name to identify the Booking Type
9178          minLength: 1
9179          maxLength: 45
9180          example: Lecture
9181          nullable: false
9182        colour:
9183          type: string
9184          description: A 6-character hex code for the Colour
9185          example: FAF4A0
9186          nullable: false
9187        tags:
9188          type: array
9189          items:
9190            $ref: '#/components/schemas/TagObject'
9191    Measurement:
9192      type: object
9193      properties:
9194        c:
9195          type: string
9196          description: Unique code to identify the type of measurement
9197          minLength: 1
9198          maxLength: 100
9199          example: ReadPersonFromTermTime
9200        desc:
9201          type: string
9202          description: A human-readable description of the measurement
9203          minLength: 1
9204          maxLength: 1000
9205          example: The time take to read one Person record via the TermTime API
9206        dt:
9207          type: string
9208          description: >-
9209            The date and time at which the measurement was made in an ISO 8601
9210            format
9211          minLength: 16
9212          maxLength: 16
9213          example: 20181231T125006Z
9214        ms:
9215          type: number
9216          description: The value of the measurement in milliseconds
9217          example: 0.001
9218    StaffList:
9219      type: object
9220      properties:
9221        sc:
9222          type: string
9223          description: CSV list of the Staff in the Pool
9224          example: S91001, S91002, S92812
9225          minLength: 1
9226          nullable: true
9227        sc.json:
9228          type: array
9229          items:
9230            $ref: '#/components/schemas/StaffCode'
9231    ModuleList:
9232      type: object
9233      properties:
9234        mc:
9235          type: string
9236          description: CSV list of the Modules for which the Staff is in a Pool
9237          example: '108EKN,107ACC'
9238          minLength: 1
9239          nullable: true
9240        mc.json:
9241          type: array
9242          items:
9243            $ref: '#/components/schemas/ModuleCode'
9244    ActivityTemplate:
9245      type: object
9246      properties:
9247        code:
9248          type: string
9249          description: A unique identifier for the Activity Template
9250          example: '1234'
9251          minLength: 1
9252          maxLength: 100
9253          nullable: false
9254        altCode:
9255          type: string
9256          description: A unique identifier for the Activity Template
9257          example: abc123
9258          minLength: 1
9259          maxLength: 64
9260          nullable: true
9261        n:
9262          type: string
9263          description: Name
9264          minLength: 1
9265          maxLength: 100
9266          example: Lecture
9267        moduleCode:
9268          type: string
9269          description: A unique identifier for the Module to which the Activity Template belongs
9270          example: 105EKN
9271          minLength: 1
9272          maxLength: 255
9273          nullable: false
9274        activityType:
9275          type: string
9276          description: Unique code to identify the Activity Type
9277          minLength: 1
9278          maxLength: 5
9279          example: LEC
9280          nullable: false
9281        hours:
9282          type: integer
9283          description: Nominal hours for the year
9284        planSize:
9285          type: integer
9286          description: Planned size
9287        user1:
9288          type: string
9289          minLength: 0
9290          maxLength: 255
9291          description: User-definable field 1
9292        user2:
9293          type: string
9294          minLength: 0
9295          maxLength: 255
9296          description: User-definable field 2
9297        user3:
9298          type: string
9299          minLength: 0
9300          maxLength: 255
9301          description: User-definable field 1
9302    ActivityResponse:
9303      type: object
9304      properties:
9305        optional:
9306          type: number
9307          description: A boolean flag to notiy whether or not this activity may be skipped.
9308          example: 0
9309          nullable: false
9310          minimum: 0
9311          maximum: 1
9312        code:
9313          type: string
9314          description: A unique identifier for the Activity
9315          example: '1234'
9316          minLength: 1
9317          nullable: false
9318        capabilities:
9319          type: string
9320          description: CSV list of Capabilities
9321          example: Projector,Whiteboard
9322          minLength: 1
9323          nullable: true
9324        coloc:
9325          type: string
9326          description: The unique name of the colocation this activity belongs to
9327          example: 102BUS Lecture, 103MEN Lecture
9328          minLength: 1
9329          maxLength: 120
9330          nullable: true
9331        colocatedActivities:
9332          type: array
9333          description: >-
9334            A JSON array of codes of other activities in the same colocation
9335          nullable: true
9336          example: ["655", "10877"]
9337          items:
9338            $ref: '#/components/schemas/ActivityCode'
9339        dayTemplate:
9340          type: string
9341          description: The name of the day template for the Activity
9342          example: Mon-Fri 9-5
9343          minLength: 1
9344          maxLength: 45
9345          nullable: true
9346        departmentCode:
9347          type: string
9348          description: A unique identifier for the Department of the Module of the Activity
9349          example: BUS
9350          minLength: 1
9351          maxLength: 255
9352          nullable: false
9353        description:
9354          description: Free-text description of the Activity
9355          example: The lecture component of the Marketing course for first-year students
9356          minLength: 1
9357          maxLength: 255
9358          nullable: true
9359        duration:
9360          type: number
9361          description: The duration of the Activity as a number of Slot
9362          example: 4
9363          nullable: false
9364        events:
9365          type: array
9366          items:
9367            type: object
9368            properties:
9369              uniqueId:
9370                type: string
9371                description: Unique name to identify the Activity's event
9372                example: A1234-1
9373              date:
9374                type: string
9375                description: The date on which the Activity's event occurs
9376                example: 2018-09-24
9377              'startTime':
9378                type: string
9379                description: The time at which the Activity's event starts
9380                example: 15:00
9381              endTime:
9382                type: string
9383                description: The time at which the Activity's event ends
9384                example: 16:00
9385              activityDurationMins:
9386                type: number
9387                description: The duration of the Activity in minutes
9388                example: 60
9389              week:
9390                type: number
9391                description: The number of the week in the academic calendar counted from 1
9392        exceptions:
9393          type: array
9394          items:
9395            $ref: '#/components/schemas/PairOfActivityIds'
9396        fixedDay:
9397          type: number
9398          description: A number for the day of the week
9399          example: 1
9400          nullable: true
9401        fixedRooms:
9402          type: string
9403          description: CSV list of Room Codes for the Activity's Fixed Rooms
9404          example: 'A-001,A-002'
9405          minLength: 1
9406          nullable: true
9407        fixedTime:
9408          type: number
9409          description: "The number of Slots between midnight and the Activity's Fixed (start) Time"
9410          example: 18
9411          nullable: true
9412        friendlyName:
9413          type: string
9414          description: Free-text alternative name for the Activity
9415          example: Marketing Lecture
9416          minLength: 1
9417          maxLength: 255
9418          nullable: true
9419        moduleCode:
9420          type: string
9421          description: A unique identifier for the Module to which the Activity belongs
9422          example: 105EKN
9423          minLength: 1
9424          maxLength: 255
9425          nullable: false
9426        moduleAltCode:
9427          type: string
9428          description: A unique identifier for the Module to which the Activity belongs
9429          example: abc123
9430          minLength: 1
9431          maxLength: 64
9432          nullable: true
9433        name:
9434          type: string
9435          description: Free-text name for the Activity
9436          example: 153MKT Lecture
9437          minLength: 1
9438          maxLength: 100
9439          nullable: false
9440        origin:
9441          type: string
9442          description: If the Activity is an exception, then 'origin' is the code of the parent Activity
9443          example: A4321
9444          nullable: true
9445        note:
9446          type: string
9447          description: Free-text note for the Activity
9448          example: Your text here
9449          minLength: 1
9450          nullable: true
9451        offerAltCode:
9452          type: string
9453          description: A unique identifier for the ModuleOffer to which the Activity belongs
9454          example: abc123
9455          minLength: 1
9456          maxLength: 255
9457          nullable: true
9458        offerName:
9459          type: string
9460          description: The name of the Module Offer to which the Activity belongs
9461          example: 105EKN
9462          minLength: 1
9463          maxLength: 255
9464          nullable: false
9465        offer:
9466          type: object
9467          description: The offer object this activity belongs to
9468          properties:
9469            n:
9470              type: string
9471              description: Offer code
9472              minLength: 1
9473              maxLength: 255
9474              example: 105EKN
9475            m:
9476              type: string
9477              description: Module code
9478              minLength: 1
9479              maxLength: 255
9480              example: 105EKN
9481            altc:
9482              type: string
9483              description: Offer alt code
9484              minLength: 1
9485              maxLength: 255
9486              example: 105EKN-A
9487            groups:
9488              type: array
9489              description: A an array of objects of all the groups of the offer
9490              items:
9491                type: object
9492                properties:
9493                  gc:
9494                    type: string
9495                    description: Unique code to identify the Student Group
9496                    minLength: 1
9497                    maxLength: 45
9498                    example: studentgroup123
9499                  gn:
9500                    type: string
9501                    description: Name for the Student Group
9502                    minLength: 1
9503                    maxLength: 255
9504                    example: Student Group 123
9505                  goUrl:
9506                    type: string
9507                    description: The URL for this group-offer mapping
9508                    example: 'https://www.example-url.co.uk?params'
9509            tags:
9510              type: array
9511              items:
9512                $ref: '#/components/schemas/TagObject'
9513        planSize:
9514          type: number
9515          description: The planned size (i.e. number of Students) for the Activity
9516          example: 100
9517          nullable: true
9518        ready:
9519          type: number
9520          description: >-
9521            1 means the activity is ready,
9522            0 means the activity is not ready
9523          example: 1
9524          minLength: 1
9525          maxLength: 1
9526          nullable: false
9527        repeats:
9528          type: array
9529          items:
9530            $ref: '#/components/schemas/PairOfActivityIds'
9531        repeatOf:
9532          type: string
9533          description: "If the Activity is a repeat, then 'repeatOf' is the code of the parent Activity"
9534          example: A4321
9535          nullable: true
9536        repeatOrigin:
9537          type: string
9538          description: "If the Activity is a repeat, then 'repeatOf' is the code of the ultimate  ancestor Activity"
9539          example: A0001
9540          nullable: true
9541        scheduled:
9542          type: number
9543          description: Boolean flag if the Activity is scheduled for at least one week, then 1. Otherwise 0
9544          example: 1
9545          nullable: false
9546        scheduledRooms:
9547          type: array
9548          description: A JSON array of Room Codes
9549          example: ["A-101", "A-201"]
9550          items:
9551            $ref: '#/components/schemas/RoomCode'
9552        size:
9553          type: number
9554          description: The planned or actual size (i.e. number of Students) enrolled in the Activity
9555          example: 100
9556          nullable: true
9557        staff:
9558          type: string
9559          description: CSV list of the Staff associated with the Activity
9560          example: Prof. Smith
9561          minLength: 1
9562          nullable: true
9563        staff.json:
9564          type: array
9565          items:
9566            $ref: '#/components/schemas/StaffCode'
9567        staffObjects:
9568          type: array
9569          description: >-
9570            A JSON array of staff objects of the activity.
9571            Each object returns the staff name and code
9572          items:
9573            type: object
9574            properties:
9575              c:
9576                type: string
9577                description: Unique code to identify the staff member
9578                minLength: 1
9579                maxLength: 45
9580                example: STAFF0123
9581              n:
9582                type: string
9583                description: Name of the staff memver
9584                minLength: 1
9585                maxLength: 100
9586                example: Prof. Smith
9587        staffPublished:
9588          type: number
9589          minimum: 0
9590          maximum: 1
9591          description: 'Boolean flag if the activity has been published to staff, then 1. If not published to staff, 0.'
9592          example: 1
9593        studentPublished:
9594          type: number
9595          minimum: 0
9596          maximum: 1
9597          description: 'Boolean flag if the activity has been published to students, then 1. If not published to staff, 0.'
9598          example: 1
9599        studentGroups:
9600          type: string
9601          description: CSV list of the Student Groups enrolled in the Activity
9602          example: 'Student Group A, Student Group B'
9603          minLength: 1
9604          nullable: true
9605        studentObjects:
9606          type: array
9607          description: >-
9608            A JSON array of student objects of the activity.
9609            Each object returns the student name and code
9610          items:
9611            type: object
9612            properties:
9613              c:
9614                type: string
9615                description: Unique code to identify the student
9616                minLength: 1
9617                maxLength: 255
9618                example: STU0123
9619              n:
9620                type: string
9621                description: Student name
9622                minLength: 1
9623                maxLength: 255
9624                example: Jane Smith
9625        type:
9626          type: string
9627          description: The name of the Activity type
9628          example: Lecture
9629          minLength: 1
9630          maxLength: 45
9631          nullable: false
9632        user1:
9633          type: string
9634          description: 'A user-defined, free-text string.'
9635          example: Your text here
9636          minLength: 1
9637          maxLength: 255
9638          nullable: true
9639        user2:
9640          type: string
9641          description: 'A user-defined, free-text string.'
9642          example: Your text here
9643          minLength: 1
9644          maxLength: 255
9645          nullable: true
9646        user3:
9647          type: string
9648          description: 'A user-defined, free-text string.'
9649          example: Your text here
9650          minLength: 1
9651          maxLength: 255
9652          nullable: true
9653        user4:
9654          type: string
9655          description: 'A user-defined, free-text string.'
9656          example: Your text here
9657          minLength: 1
9658          maxLength: 255
9659          nullable: true
9660        user5:
9661          type: string
9662          description: 'A user-defined, free-text string.'
9663          example: Your text here
9664          minLength: 1
9665          maxLength: 255
9666          nullable: true
9667        user6:
9668          type: string
9669          description: 'A user-defined, free-text string.'
9670          example: Your text here
9671          minLength: 1
9672          maxLength: 255
9673          nullable: true
9674        user7:
9675          type: string
9676          description: 'A user-defined, free-text string.'
9677          example: Your text here
9678          minLength: 1
9679          maxLength: 255
9680          nullable: true
9681        virtual:
9682          type: number
9683          description: >-
9684            0 means the Activity is to be scheduled into a Room, 1 means the
9685            Activity is to be scheduled into a time (but not a Room)
9686        meetingRequired:
9687          type: number
9688          description: >-
9689            0 means the Activity does not require an online meeting,
9690            1 means the Activity requires an online meeting
9691          example: 1
9692          nullable: false
9693        meetingUrl:
9694          type: string
9695          description: "The URL for the activity's online meeting"
9696          example: 'https://www.example-meeting-url.co.uk?meeting=params'
9697          minLength: 1
9698          maxLength: 65535
9699          nullable: true
9700        timeframe:
9701          type: string
9702          description: The code of the Timeframe relative to which the weeks in the weekPattern must be evaluated
9703          example: Semester 1
9704          minLength: 1
9705          maxLength: 110
9706          nullable: false
9707        weekPattern:
9708          type: string
9709          description: The weeks (relative to the Timeframe) into which the Activity is to be scheduled
9710          example: '5-10,12-20'
9711          minLength: 1
9712          maxLength: 90
9713          nullable: false
9714        isoweeks:
9715          type: string
9716          description: The weeks into which the Activity is to be scheduled formatted as ISO 8601
9717          example: 2018-W52,2019-W,2019-W2
9718          minLength: 6
9719          nullable: false
9720        capabilities.json:
9721          type: array
9722          items:
9723            $ref: '#/components/schemas/CapabilityCode'
9724        fixedRooms.json:
9725          type: array
9726          items:
9727            $ref: '#/components/schemas/RoomCode'
9728        studentGroups.json:
9729          type: array
9730          items:
9731            $ref: '#/components/schemas/StudentGroupCode'
9732        academics:
9733          type: array
9734          items:
9735            $ref: '#/components/schemas/AcademicObjectShort'
9736        tags:
9737          type: string
9738          description: "CSV list of tag names"
9739          example: 'Tag1,Tag2'
9740          minLength: 1
9741          nullable: true
9742        tags.json:
9743          type: array
9744          description: A JSON array of tag names
9745          items:
9746            type: string
9747            description: "A tag name"
9748            example: 'Tag1'
9749            minLength: 1
9750            maxLength: 255
9751    StudentCode2:
9752      type: string
9753      description: Unique code to identify the student
9754      minLength: 1
9755      maxLength: 60
9756      example: student123
9757    StudentCode:
9758      type: string
9759      description: Unique code to identify the student
9760      minLength: 1
9761      maxLength: 60
9762      example: student123
9763    AssessmentPeriod:
9764      type: object
9765      properties:
9766        code:
9767          type: string
9768          description: Unique code to identify the Assessment Period
9769          minLength: 1
9770          maxLength: 25
9771          example: '20193'
9772        name:
9773          type: string
9774          description: Name to describe the Assessment Period
9775          minLength: 1
9776          maxLength: 100
9777          example: 2019 Mid-term Exams
9778    optiongroup:
9779      type: object
9780      properties:
9781        course:
9782          type: string
9783          description: Course code
9784          minLength: 1
9785          maxLength: 255
9786          example: BUS002/2
9787        timeframe:
9788          type: string
9789          description: Timeframe code
9790          minLength: 1
9791          maxLength: 110
9792          example: Sem1
9793        n:
9794          type: string
9795          description: Option group name
9796          minLength: 1
9797          example: Credit
9798        end:
9799          type: string
9800          description: Date and timeime (UTC) when the option group selection window closes
9801          minLength: 1
9802          example: "2019-11-01T15:00:00.000Z"
9803        start:
9804          type: string
9805          description: Date and time (UTC) when the option group selection window opens
9806          minLength: 1
9807          example: "2019-10-01T14:00:00.000Z"
9808        welcome:
9809          type: string
9810          description: Option group welcome message
9811          minLength: 1
9812          example: Please select the required module
9813        options:
9814          type: array
9815          description: List of options
9816          items:
9817            type: object
9818            properties:
9819              offer:
9820                type: string
9821                description: Module offer code for option
9822                minLength: 1
9823                example: 152MKT 152MKT
9824              selections:
9825                description: Selections of the option
9826                type: array
9827                items:
9828                  type: object
9829                  properties:
9830                    force:
9831                      type: number
9832                      description: Flag indicating this selection is forced
9833                      minimum: 0
9834                      maximum: 1
9835                      example: 1
9836                    backup:
9837                      type: number
9838                      description: Flag indicating this selection requires a backup
9839                      minimum: 0
9840                      maximum: 1
9841                      example: 1
9842                    capacity:
9843                      type: number
9844                      description: Capacity of selection of option group
9845                      minimum: 0
9846                      example: 100
9847                    selected:
9848                      type: number
9849                      description: Flag indicating the module offer is available for seleciton
9850                      minimum: 0
9851                      maximum: 1
9852                      example: 1
9853                    selection:
9854                      type: string
9855                      description: Flag indicating name of selection
9856                      minimum: 0
9857                      maximum: 1
9858                      example: 1it
9859                    justification:
9860                      type: number
9861                      description: Flag indicating this selection requires a justification
9862                      minimum: 0
9863                      maximum: 1
9864                      example: 1
9865        selections:
9866          type: array
9867          description: List of selections
9868          items:
9869            type: object
9870            properties:
9871              min:
9872                type: number
9873                description: Minimum offers required for selection
9874                minimum: 0
9875                example: 1
9876              max:
9877                type: number
9878                description: Maximum offers required for selection
9879                minimum: 0
9880                example: 2
9881              name:
9882                type: string
9883                description: Name of selection
9884                minLength: 1
9885                example: Credit
9886        enrolementStart:
9887          type: string
9888          description: UTC date and time when the enrolement starts
9889          example: "2019-11-11T14:00:00.000Z"
9890        studentSelections:
9891          type: array
9892          description: Selections of student
9893          items:
9894            type: object
9895            properties:
9896              student:
9897                type: string
9898                description: Unique code to identify the student
9899                minLength: 1
9900                maxLength: 60
9901                example: student123
9902              status:
9903                type: string
9904                description: Student selection status. Can be pending, approved or confirmed
9905                minLength: 1
9906                example: pending
9907              submitted:
9908                type: number
9909                description: Flag indicating whether student submitted choices
9910                minimum: 0
9911                maximum: 1
9912                example: 1
9913              selections:
9914                type: object
9915                properties:
9916                  selectionName:
9917                    type: object
9918                    properties:
9919                      offerCode:
9920                        type: object
9921                        properties:
9922                          selected:
9923                            type: number
9924                            description: Flag to indicate offer is selected for option group selection
9925                            minimum: 0
9926                            maximum: 1
9927                            example: 1
9928                          useBackup:
9929                            type: number
9930                            description: Flag to indicate that backup offer is used
9931                            minimum: 0
9932                            maximum: 1
9933                            example: 1
9934                          adminStatus:
9935                            type: string
9936                            description: "Status of offer, set by admin. Possible values: Draft, Pending, Approved, Declined, Confirmed"
9937                            minLength: 1
9938                            example: Confirmed
9939                          studentChoice:
9940                            type: number
9941                            description: Flag to indicate that offer was chosen by student
9942                            minimum: 0
9943                            maximum: 1
9944                            example: 1
9945                          backupSelection:
9946                            type: string
9947                            description: Module offer code chosen as a backup by student
9948                            minLength: 1
9949                            example: 252BUS 252BUS
9950                          usedAsBackupFor:
9951                            type: string
9952                            description: Module offer code this offer is a backup of
9953                            minLength: 1
9954                            example: 152MKT 152MKT
9955                          justificationText:
9956                            type: string
9957                            description: Justification text written by student
9958                            minLength: 1
9959                            maxLength: 300
9960                            example: Justification text
9961                          dateUpdated:
9962                            type: string
9963                            description: UTC date and time when admin last updated the status
9964                            minLength: 1
9965                            example: "2019-11-11T14:08:30.642Z"
9966                          dateConfirmed:
9967                            type: string
9968                            description: UTC date and time when admin confirmed the selection
9969                            minLength: 1
9970                            example: "2019-11-11T14:08:30.642Z"
9971                          dateBackupSelected:
9972                            type: string
9973                            description: UTC date and time when student selected a backup
9974                            minLength: 1
9975                            example: "2019-11-11T14:08:30.642Z"
9976                          dateSelected:
9977                            type: string
9978                            description: UTC date and time when the student chose the module offer
9979                            minLength: 1
9980                            example: "2019-11-11T14:08:30.642Z"
9981    Student:
9982      type: object
9983      properties:
9984        c:
9985          type: string
9986          description: Unique code to identify the student
9987          minLength: 1
9988          maxLength: 60
9989          example: student123
9990        n:
9991          type: string
9992          description: Full name
9993          minLength: 1
9994          maxLength: 60
9995          example: Joe Student
9996        e1:
9997          type: string
9998          description: Email 1
9999          minLength: 1
10000          maxLength: 600
10001          nullable: true
10002          example: joe@myuniversity
10003        e2:
10004          type: string
10005          description: Email 2
10006          minLength: 1
10007          maxLength: 600
10008          nullable: true
10009          example: joe2@myuniversity
10010        addr:
10011          type: string
10012          description: Address
10013          minLength: 0
10014          maxLength: 100
10015          nullable: true
10016          example: '1 Road, Town'
10017        rbda:
10018          description: Number of days advance a booking can be made
10019          type: integer
10020          minimum: 0
10021          maximum: 999
10022          nullable: true
10023          example: 4
10024        rbpw:
10025          description: Max number of hours per week that could be booked
10026          type: integer
10027          minimum: 0
10028          maximum: 999
10029          nullable: true
10030          example: 30
10031        rbpd:
10032          description: Max number of hours per day that could be booked
10033          type: integer
10034          minimum: 0
10035          maximum: 999
10036          nullable: true
10037          example: 5
10038        rbmb:
10039          description: Max single booking
10040          type: integer
10041          minimum: 0
10042          maximum: 999
10043          nullable: true
10044          example: 2
10045        rbmg:
10046          description: Minimum gap between bookings
10047          type: integer
10048          minimum: 0
10049          maximum: 999
10050          nullable: true
10051          example: 1
10052        mob:
10053          description: Mobile phone number
10054          type: string
10055          nullable: true
10056          minLength: 1
10057          maxLength: 30
10058          example: 07777 123 456
10059        pn:
10060          description: Principal name for SSO
10061          type: string
10062          nullable: true
10063          minLength: 1
10064          maxLength: 60
10065          example: joe@myuniversity
10066        specReq:
10067          type: string
10068          description: A CSV list of students's special requirements
10069          nullable: true
10070          minLength: 0
10071          example: Reader,Writer
10072        cc:
10073          type: string
10074          nullable: false
10075          description: CSV list of Courses in which the Student is enrolled
10076          items:
10077            type: string
10078            minLength: 0
10079        ct:
10080          type: string
10081          nullable: false
10082          description: CSV list of Course Titles in which the Student is enrolled
10083          items:
10084            type: string
10085            minLength: 0
10086        td:
10087          type: integer
10088          minimum: 0
10089          maximum: 1
10090          description: '1 if student marked for deletion, otherwise 0'
10091          example: 0
10092        gc:
10093          type: string
10094          nullable: true
10095          description: CSV list of group codes
10096          example: 'g1, g2'
10097        gc.json:
10098          type: array
10099          items:
10100            $ref: '#/components/schemas/StudentGroupCode'
10101        gn:
10102          type: string
10103          nullable: true
10104          description: CSV list of group names
10105          example: 'Chem1 Group1, Chem1 Group 2'
10106        gn.json:
10107          type: array
10108          items:
10109            $ref: '#/components/schemas/StudentGroupName'
10110        caps:
10111          type: string
10112          nullable: true
10113          description: CSV list of Capability names
10114          example: 'Wheelchair, Hearing Loop'
10115        caps.json:
10116          type: array
10117          items:
10118            $ref: '#/components/schemas/Capability'
10119        staff:
10120          type: string
10121          nullable: true
10122          description: Unique code to identify Staff iff Student is also a Staff
10123          example: '000100834'
10124        offers:
10125          type: array
10126          items:
10127            $ref: '#/components/schemas/OfferReference'
10128        actualModuleOffers:
10129          type: array
10130          items:
10131            $ref: '#/components/schemas/OfferReference'
10132        dn:
10133          type: array
10134          items:
10135            type: string
10136            description: DEPRECATED
10137            example: BUS
10138            minLength: 1
10139            maxLength: 255
10140            nullable: false
10141        d:
10142          description: The Departments of the Courses in which the Student is enrolled
10143          type: object
10144          properties:
10145            c:
10146              type: string
10147              description: Unique code to identify the Department or OU
10148              example: BUS
10149              minLength: 1
10150              maxLength: 255
10151              nullable: false
10152            dn:
10153              type: string
10154              description: Unique name to identify the Department
10155              minLength: 1
10156              maxLength: 255
10157              nullable: false
10158        user1:
10159          type: string
10160          minLength: 0
10161          maxLength: 60
10162          description: User-definable field 1
10163        user2:
10164          type: string
10165          minLength: 0
10166          maxLength: 60
10167          description: User-definable field 2
10168        user3:
10169          type: string
10170          minLength: 0
10171          maxLength: 60
10172          description: User-definable field 3
10173        user4:
10174          type: string
10175          minLength: 0
10176          maxLength: 60
10177          description: User-definable field 4
10178        user5:
10179          type: string
10180          minLength: 0
10181          maxLength: 60
10182          description: User-definable field 5
10183        user6:
10184          type: string
10185          minLength: 0
10186          maxLength: 60
10187          description: User-definable field 6
10188    StaffPool:
10189      type: object
10190      properties:
10191        mc:
10192          type: string
10193          description: Unique code to identify the Module
10194          minLength: 1
10195          maxLength: 255
10196        sc:
10197          type: string
10198          description: Unique code to identify the Staff
10199          minLength: 1
10200          maxLength: 45
10201    PairOfActivityIds:
10202      type: array
10203      items:
10204        type: string
10205        minLength: 2
10206        maxLength: 2
10207        description: The first element is the code of a parent Activity and the second element is the code of its child Activity
10208    StaffCode:
10209      description: Unique code to identify the Staff
10210      type: string
10211      minLength: 1
10212      maxLength: 45
10213      example: S91001
10214    Staff:
10215      type: object
10216      properties:
10217        c:
10218          description: Unique code to identify the Staff
10219          type: string
10220          minLength: 1
10221          maxLength: 45
10222        'n':
10223          description: Full name
10224          type: string
10225          minLength: 1
10226          maxLength: 100
10227        e1:
10228          description: 'Email address, primary'
10229          type: string
10230          nullable: true
10231          minLength: 1
10232          maxLength: 600
10233        e2:
10234          description: 'Email address, backup'
10235          type: string
10236          nullable: true
10237          minLength: 1
10238          maxLength: 600
10239        mob:
10240          description: Mobile phone number
10241          type: string
10242          nullable: true
10243          minLength: 1
10244          maxLength: 30
10245        dc:
10246          description: Department Code
10247          type: string
10248          minLength: 1
10249          maxLength: 255
10250        dn:
10251          description: Department Name
10252          type: string
10253          minLength: 1
10254          maxLength: 255
10255        nh:
10256          description: Nominal hours for the year
10257          type: number
10258          minimum: 0
10259          maximum: 9999
10260        nha:
10261          description: Nominal hours adjustment
10262          type: number
10263          minimum: -999
10264          maximum: 999
10265        pn:
10266          description: Principal name for SSO
10267          type: string
10268          nullable: true
10269          minLength: 1
10270          maxLength: 60
10271        td:
10272          description: To Delete flag
10273          type: integer
10274          minimum: 0
10275          maximum: 1
10276        rbda:
10277          description: Number of days advance a booking can be made
10278          type: integer
10279          minimum: 0
10280          maximum: 999
10281        rbpw:
10282          description: Max number of hours per week that could be booked
10283          type: integer
10284          minimum: 0
10285          maximum: 999
10286        rbpd:
10287          description: Max number of hours per day that could be booked
10288          type: integer
10289          minimum: 0
10290          maximum: 999
10291        rbmb:
10292          description: Max single booking
10293          type: integer
10294          minimum: 0
10295          maximum: 999
10296        rbmg:
10297          description: Minimum gap between bookings
10298          type: integer
10299          minimum: 0
10300          maximum: 999
10301        rbrp:
10302          description: Room booking room pool
10303          type: string
10304          nullable: true
10305          minLength: 1
10306          maxLength: 65
10307        isalso:
10308          description: Unique code to identify Student iff Staff is also a Student
10309          type: string
10310          nullable: true
10311          minLength: 1
10312          maxLength: 60
10313        roles:
10314          description: List of all the Roles a Staff Member has
10315          type: string
10316          nullable: true
10317          minLength: 1
10318          maxLength: 600
10319        staffGroups:
10320          description: List of all the Staff Groups a Staff Member is a member of
10321          type: string
10322          nullable: true
10323          minLength: 1
10324          maxLength: 600
10325        offers:
10326          description: List of all module offers owned by the staff member
10327          type: array
10328          items:
10329            $ref: '#/components/schemas/OfferReference'
10330        modulesScheduled:
10331          description: List of scheduled module offers owned by the staff member
10332          type: array
10333          items:
10334            $ref: '#/components/schemas/OfferReference'
10335        altc:
10336          type: string
10337          nullable: true
10338          minLength: 0
10339          maxLength: 255
10340          description: Alternative unique code to identify the staff member
10341        user1:
10342          type: string
10343          minLength: 0
10344          maxLength: 60
10345          description: User-definable field 1
10346        user2:
10347          type: string
10348          minLength: 0
10349          maxLength: 60
10350          description: User-definable field 2
10351        user3:
10352          type: string
10353          minLength: 0
10354          maxLength: 60
10355          description: User-definable field 3
10356        user4:
10357          type: string
10358          minLength: 0
10359          maxLength: 60
10360          description: User-definable field 4
10361        user5:
10362          type: string
10363          minLength: 0
10364          maxLength: 60
10365          description: User-definable field 5
10366      example:
10367        c: Staff123
10368        'n': Jessica Smith
10369        e1: Jess@aplace.com
10370        e2: Jess@aplace.com
10371        mob: 07777 123456
10372        dn: Chemistry
10373        dc: CHE
10374        nh: 1000
10375        nha: -100
10376        pn: mylogin
10377        td: 0
10378        rbda: 100
10379        rbpw: 10
10380        rbpd: 4
10381        rbmx: 3
10382        rbmg: 1
10383        rbrp: myallowedrooms
10384        roles: Academic, Examiner
10385        staffGroups: Invigilator
10386        offers: [{n: 105EKN-Semester1, m: 105EKN, altc: 105EKN}]
10387        modulesScheduled: [{n: 105EKN-Semester1, m: 105EKN, altc: 105EKN}]
10388    Course:
10389      type: object
10390      properties:
10391        cc:
10392          type: string
10393          minLength: 1
10394          maxLength: 45
10395          description: Course Code
10396        'n':
10397          type: string
10398          minLength: 1
10399          maxLength: 180
10400          description: Course Name
10401        dn:
10402          type: string
10403          minLength: 1
10404          maxLength: 90
10405          description: The name of the department that owns the course
10406          example: Engineering
10407        dc:
10408          type: string
10409          minLength: 1
10410          maxLength: 90
10411          description: The code of the department that owns the course
10412          example: ENG
10413        level:
10414          type: string
10415          minLength: 0
10416          nullable: true
10417          maxLength: 45
10418          description: 'can be used for years or BA, MA etc.'
10419        owner:
10420          type: string
10421          description: Staff code for the course owner
10422          nullable: true
10423          minLength: 0
10424          maxLength: 45
10425        minc:
10426          type: integer
10427          minimum: 0
10428          maximum: 9999
10429          nullable: true
10430          description: Minimum credits for the year
10431        maxc:
10432          type: integer
10433          minimum: 0
10434          maximum: 9999
10435          nullable: true
10436          description: Maximum credits for the year
10437        events:
10438          type: integer
10439          minimum: 0
10440          maximum: 0
10441          description: Total number of events in course (currently always 0)
10442        scheduledEvents:
10443          type: integer
10444          minimum: 0
10445          maximum: 0
10446          description: Total number of scheduled events (currently always 0)
10447        moCodes:
10448          type: string
10449          description: >-
10450            CSV list of module offer codes in the course. If 'useOfferAltc'
10451            is used the module offer alt codes are shown instead.
10452          minLength: 1
10453          nullable: true
10454        moCore:
10455          type: string
10456          description: CSV list of Core module offer codes in the course
10457          minLength: 1
10458          nullable: true
10459        moCore.json:
10460          type: array
10461          items:
10462            $ref: '#/components/schemas/OfferName'
10463        moOptional:
10464          type: string
10465          description: CSV list of Optional module offer codes in the course
10466          minLength: 1
10467          nullable: true
10468        moOptional.json:
10469          type: array
10470          items:
10471            $ref: '#/components/schemas/OfferName'
10472        offers:
10473          type: array
10474          items:
10475            $ref: '#/components/schemas/OfferReference'
10476        altc:
10477          type: string
10478          minLength: 0
10479          maxLength: 64
10480          description: Alt Code
10481        user1:
10482          type: string
10483          minLength: 0
10484          maxLength: 256
10485          description: User-definable field 1
10486        user2:
10487          type: string
10488          minLength: 0
10489          maxLength: 256
10490          description: User-definable field 2
10491        showCourse:
10492          type: integer
10493          description: >-
10494            Flag controlling whether students can see
10495            the entire course in the student portal
10496        tags:
10497          type: array
10498          items:
10499            $ref: '#/components/schemas/TagObject'
10500        desc:
10501          type: string
10502          minLength: 1
10503          maxLength: 255
10504          description: Course Description
10505        td:
10506          type: number
10507          minimum: 0
10508          maximum: 1
10509          description: To be used and set to 1 when the Course is to be marked for deletion
10510    CourseOfferMapping:
10511      description: a list of all course-offer mappings
10512      type: object
10513      properties:
10514        Core:
10515          type: number
10516          minimum: 0
10517          maximum: 1
10518          nullable: false
10519          description: Core offer mapping flag
10520        Optional:
10521          type: number
10522          minimum: 0
10523          maximum: 1
10524          nullable: false
10525          description: Optional offer mapping flag
10526        cc:
10527          type: string
10528          description: Course code
10529          minLength: 1
10530          maxLength: 45
10531        o:
10532          type: string
10533          description: Offer name
10534          minLength: 1
10535          maxLength: 255
10536        mc:
10537          type: string
10538          description: Module Offer code
10539          minLength: 1
10540          maxLength: 255
10541    StudentCourseMapping:
10542      description: a list of all student-course mappings
10543      type: object
10544      properties:
10545        s:
10546          type: string
10547          description: Student code
10548          minLength: 1
10549          maxLength: 255
10550        cc:
10551          type: string
10552          description: Course code
10553          minLength: 1
10554          maxLength: 255
10555    StudentOfferMappings:
10556      description: a list of all student-offer mappings
10557      type: object
10558      properties:
10559        s:
10560          type: string
10561          description: Student code
10562          minLength: 1
10563          maxLength: 255
10564        o:
10565          type: string
10566          description: Offer name
10567          minLength: 1
10568          maxLength: 255
10569        mc:
10570          type: string
10571          description: Module Offer code
10572          minLength: 1
10573          maxLength: 255
10574        mtc:
10575          type: string
10576          description: The code for the Student-Module Offer map type.
10577          minLength: 1
10578          maxLength: 255
10579    ModuleCode:
10580      description: Unique code to identify the Module
10581      type: string
10582      minLength: 1
10583      maxLength: 255
10584      example: 107ACC
10585    Module:
10586      type: object
10587      properties:
10588        cc:
10589          type: string
10590          description: The module code
10591          minLength: 0
10592          maxLength: 50
10593        n:
10594          type: string
10595          minLength: 0
10596          maxLength: 255
10597          nullable: true
10598          description: The full name of the module
10599        dn:
10600          type: string
10601          minLength: 1
10602          maxLength: 90
10603          description: The code of the department that owns the module
10604        dc:
10605          type: string
10606          description: The code of the department that owns the module
10607          minLength: 1
10608          maxLength: 255
10609          example: ENG
10610        owner:
10611          type: string
10612          description: Staff code for the module owner.
10613          nullable: true
10614          minLength: 0
10615          maxLength: 45
10616        credits:
10617          type: number
10618          minimum: 0
10619          maximum: 9999.999
10620          nullable: true
10621          description: The credits for the module
10622        events:
10623          type: integer
10624          minimum: 0
10625          maximum: 0
10626          description: Total number of events in module (currently always 0)
10627        scheduledEvents:
10628          type: integer
10629          minimum: 0
10630          maximum: 0
10631          description: Total number of scheduled events (currently always 0)
10632        offers:
10633          type: string
10634          description: CSV list of module offer names for this module
10635          minLength: 1
10636          nullable: true
10637        offers.json:
10638          type: array
10639          items:
10640            $ref: '#/components/schemas/OfferName'
10641        altc:
10642          type: string
10643          minLength: 0
10644          maxLength: 64
10645          description: Alt Code
10646        contactRequirements:
10647          type: string
10648          description: CSV list of contact requirements codes for this module
10649          minLength: 1
10650          nullable: true
10651        contactRequirements.json:
10652          type: array
10653          items:
10654            $ref: '#/components/schemas/ContactRequirementCode'
10655    OfferName:
10656      type: string
10657      description: The offer name
10658      minLength: 1
10659      maxLength: 255
10660      example: 105EKN
10661    Offer:
10662      type: object
10663      properties:
10664        n:
10665          type: string
10666          description: The offer name
10667        m:
10668          type: string
10669          description: The module code
10670        tf:
10671          type: string
10672          description: The timeframe code
10673        s:
10674          type: string
10675          description: The code for the staff owner
10676        dt:
10677          type: string
10678          description: The day template
10679        r:
10680          type: integer
10681          description: Running flag
10682        caft:
10683          type: integer
10684          description: 1 if all Activities created from this Offer must use a Contact Requirement (0 otherwise)
10685        notr:
10686          type: integer
10687          description: 1 if this is a no teachng required module, 0 otherwise.
10688        ps:
10689          type: integer
10690          description: Planned size
10691        altc:
10692          type: string
10693          minLength: 0
10694          maxLength: 255
10695          description: Alt Code
10696        user1:
10697          type: string
10698          minLength: 0
10699          maxLength: 256
10700          description: User-definable field 1
10701        user2:
10702          type: string
10703          minLength: 0
10704          maxLength: 256
10705          description: User-definable field 2
10706        cc:
10707          type: string
10708          description: CSV list of course codes
10709          example: BUS002/2, ECU005/1
10710        gc:
10711          type: string
10712          description: CSV list of group codes
10713          example: 1000110, 1002438
10714        module:
10715          type: object
10716          properties:
10717            mc:
10718              type: string
10719              description: Module code
10720              example: 125EMN
10721            altc:
10722              type: string
10723              description: Alt code for the module
10724            n:
10725              type: string
10726              description: Module name
10727              example: Civil and Environmental Engineering Fundamentals
10728            d:
10729              type: string
10730              description: Code for the department the module belongs to
10731            td:
10732              description: To Delete flag
10733              type: integer
10734              minimum: 0
10735              maximum: 1
10736            user1:
10737              type: string
10738              minLength: 0
10739              maxLength: 256
10740              description: User-definable field 1
10741            user2:
10742              type: string
10743              minLength: 0
10744              maxLength: 256
10745              description: User-definable field 2
10746        groups:
10747          type: array
10748          items:
10749            type: object
10750            properties:
10751              gc:
10752                type: string
10753                description: Unique code to identify the Student Group
10754                minLength: 1
10755                maxLength: 45
10756                example: studentgroup123
10757              gn:
10758                type: string
10759                description: Name for the Student Group
10760                minLength: 1
10761                maxLength: 255
10762                example: Student Group 123
10763              goUrl:
10764                type: string
10765                description: The URL for this group-offer mapping
10766                example: 'https://www.example-url.co.uk?params'
10767        courses:
10768          type: array
10769          items:
10770            type: object
10771            properties:
10772              cc:
10773                type: string
10774                description: Unique code to identify the Course
10775                minLength: 1
10776                maxLength: 255
10777                example: Business Management BA Year 2
10778        location:
10779          type: string
10780          description: Unique code to identify a Location
10781          minLength: 1
10782          maxLength: 255
10783          example: ABC123
10784          nullable: true
10785        tags:
10786          type: array
10787          items:
10788            $ref: '#/components/schemas/TagObject'
10789        url:
10790          type: string
10791          description: URL string for the module offer
10792          nullable: true
10793          minLength: 1
10794          maxLength: 65535
10795          example: 'https://www.example-meeting-url.co.uk?meeting=params'
10796        staffObjects:
10797          type: array
10798          description: >-
10799            A JSON array of staff objects of all the activities in the offer.
10800            Each object returns the staff name and code
10801          items:
10802            type: object
10803            properties:
10804              c:
10805                type: string
10806                description: Unique code to identify the staff member
10807                minLength: 1
10808                maxLength: 45
10809                example: STAFF0123
10810              n:
10811                type: string
10812                description: Name of the staff memver
10813                minLength: 1
10814                maxLength: 100
10815                example: Prof. Smith
10816        studentObjects:
10817          type: array
10818          description: >-
10819            A JSON array of student objects of all the activities in the offer.
10820            Each object returns the student name and code
10821          items:
10822            type: object
10823            properties:
10824              c:
10825                type: string
10826                description: Unique code to identify the student
10827                minLength: 1
10828                maxLength: 255
10829                example: STU0123
10830              n:
10831                type: string
10832                description: Student name
10833                minLength: 1
10834                maxLength: 255
10835                example: Jane Smith
10836    OfferReference:
10837      type: object
10838      properties:
10839        n:
10840          type: string
10841          description: The Offer name (present if userOfferAltc is not set)
10842          example: 105EKN-Semester1
10843        m:
10844          type: string
10845          description: The module code (present if userOfferAltc is not set)
10846          example: 105EKN
10847        altc:
10848          type: string
10849          description: The Alt Code for the Offer (present if userOfferAltc is set)
10850          example: 105EKN
10851    OfferReferenceWithGroupOfferUrl:
10852      type: object
10853      properties:
10854        n:
10855          type: string
10856          description: The Offer name (present if userOfferAltc is not set)
10857          example: 105EKN-Semester1
10858        m:
10859          type: string
10860          description: The module code (present if userOfferAltc is not set)
10861          example: 105EKN
10862        altc:
10863          type: string
10864          description: The Alt Code for the Offer (present if userOfferAltc is set)
10865          example: 105EKN
10866        goUrl:
10867          type: string
10868          description: The URL for this group-offer mapping
10869          example: 'https://www.example-url.co.uk?params'
10870    ClassicExam:
10871      type: object
10872      properties:
10873        assessmentPeriod:
10874          description: Code of the Assessment Period to which the Assessment belongs
10875          type: string
10876          nullable: false
10877          example: 2020FINALS
10878          minLength: 1
10879          maxLength: 25
10880        assessmentType:
10881          description: Optional user-defined name for the type of the assessment
10882          type: string
10883          nullable: true
10884          example: Multiple choice
10885          minLength: 1
10886          maxLength: 255
10887        building:
10888          description: If the exam must be scheduled into a specific building, then this field is the code of that building
10889          type: string
10890          nullable: true
10891          example: Appleton Tower
10892          minLength: 1
10893          maxLength: 45
10894        campus:
10895          description: If the exam must be scheduled into a specific campus, then this field is the code of that campus
10896          type: string
10897          nullable: true
10898          example: Central
10899          minLength: 1
10900          maxLength: 45
10901        canCreateSessions:
10902          description: >-
10903            0 means that the automatic Exam scheduler must use existing Exam Sessions,
10904            otherwise it is allowed to create new Exam Sessions
10905          nullable: false
10906          example: 0
10907          type: integer
10908          minimum: 0
10909          maximum: 1
10910        capabilities:
10911          description: List of room capabilities required by the exam
10912          type: string
10913          example:
10914          nullable: true
10915        code:
10916          description: A code to identify one classic exams from amongst all the classic exams
10917          type: string
10918          nullable: false
10919          example: MATH101-PAPER1
10920          minLength: 1
10921          maxLength: 255
10922        complexity:
10923          description: A calculated value representing how hard the exam is to scheduled (higher numbers are harder to schedule)
10924          type: integer
10925          nullable: true
10926          example: 1000
10927        dayTemplate:
10928          type: string
10929          description: The name of the day template for the exam
10930          example: Mon-Fri 9-5
10931          minLength: 1
10932          maxLength: 45
10933          nullable: true
10934        description:
10935          type: string
10936          description: A description of the exam
10937          example: Maths 101 Paper A (6 pages)
10938          minLength: 1
10939          maxLength: 255
10940          nullable: true
10941        durationMins:
10942          description: Duration of the exam in minutes
10943          type: integer
10944          nullable: false
10945          example: 120
10946        endDate:
10947          type: string
10948          description: The latest date on which the scheduler should put the exam
10949          example: '2020-09-01 00:00:00'
10950          minLength: 19
10951          maxLength: 19
10952          nullable: true
10953        exclusiveStaff:
10954          description: 1 if the academic staff associated with this exam cannot supervise any other exam concurrently with this exam, otherwise 0
10955          nullable: false
10956          example: 0
10957          type: integer
10958          minimum: 0
10959          maximum: 1
10960        fixedDay:
10961          type: number
10962          description: A number for the day of the week
10963          example: 1
10964          nullable: true
10965        fixedTime:
10966          type: number
10967          description: The time at which the exam should start, as a number of minutes past midnight
10968          example: 600
10969          nullable: true
10970        friendlyName:
10971          type: string
10972          description: Free-text alternative name for the exam
10973          example: Marketing Lecture
10974          minLength: 1
10975          maxLength: 255
10976          nullable: true
10977        layoutType:
10978          type: string
10979          description: Optional code for the type of Room Layout wanted for the Exam
10980          example: SINGLE
10981          minLength: 1
10982          maxLength: 30
10983          nullable: true
10984        maxPerInvigilator:
10985          type: number
10986          description: The maximum number of candidates that an invigilator should have to supervise for this exam
10987          example: 20
10988          nullable: true
10989        minRoomSize:
10990          type: number
10991          description: If the exam is split over multiple rooms, then each room should not be smaller than this value
10992          example: 5
10993          nullable: true
10994        name:
10995          type: string
10996          description: The name for the exam
10997          example: MATH 101 Paper 1
10998          minLength: 1
10999          maxLength: 255
11000          nullable: false
11001        noPublishStaff:
11002          description: Flag to say whether staff should see the Exam in their timetable (0) or (1)
11003          nullable: false
11004          type: integer
11005          minimum: 0
11006          maximum: 1
11007        noPublishStudents:
11008          description: Flag to say whether students should see the Exam in their timetable (0) or (1)
11009          nullable: false
11010          type: integer
11011          minimum: 0
11012          maximum: 1
11013        notes:
11014          type: string
11015          description: Free-text field
11016          minLength: 1
11017          maxLength: 1000
11018          nullable: true
11019        offer:
11020          type: string
11021          description: The code of the Module and the name of the Offer that the exam belongs to (with a space to separate them)
11022          example: 105EKN 105EKN
11023          minLength: 1
11024          maxLength: 511
11025          nullable: false
11026        personalDeadlineEnabled:
11027          description: Flag to say whether students can have a personal deadline
11028          nullable: false
11029          type: integer
11030          minimum: 0
11031          maximum: 1
11032        planSize:
11033          type: number
11034          description: The planned size for the exam
11035          example: 100
11036          nullable: true
11037        preferredStart:
11038          type: string
11039          description: The name of the Preferred Start Slots pattern that the automaic scheduler must use
11040          example: Exam Session Starts
11041          minLength: 1
11042          maxLength: 100
11043          nullable: true
11044        ready:
11045          description: Flag to say whether the Exam is ready
11046          nullable: false
11047          type: integer
11048          minimum: 0
11049          maximum: 1
11050        roomPool:
11051          type: string
11052          description: The name of the Room Pool that the automaic scheduler must use
11053          example: Block A
11054          minLength: 1
11055          maxLength: 65
11056          nullable: true
11057        sequence:
11058          type: number
11059          description: When provided, the automatic scheduler must schedule exams with higher sequence numbers after exams with lower sequence numbers
11060          example: 50
11061          nullable: true
11062        setupTimeMins:
11063          type: number
11064          description: When provided, the automatic scheduler must allow additional time at the start of the exam session for setup
11065          example: 30
11066          nullable: true
11067        sharing:
11068          description: Flag to say whether the automatic scheduler can schedule this exam in the same exam session as other exams
11069          nullable: false
11070          type: integer
11071          minimum: 0
11072          maximum: 1
11073        slotGroup:
11074          type: string
11075          description: An option Slot Group name.  The automatic scheduler must start all exams in the same Slot Group at the same time.
11076          minLength: 1
11077          maxLength: 255
11078          nullable: true
11079        splittable:
11080          description: Flag to say whether the automatic scheduler can split this exam over multiple rooms
11081          nullable: false
11082          type: integer
11083          minimum: 0
11084          maximum: 1
11085        staff:
11086          type: array
11087          description: The academics responsible for setting the Exam
11088          items:
11089            $ref: '#/components/schemas/StaffCode'
11090        startDate:
11091          type: string
11092          description: The earliest date on which the scheduler should put the exam
11093          example: '2020-09-01 00:00:00'
11094          minLength: 19
11095          maxLength: 19
11096          nullable: true
11097        takedownTimeMins:
11098          type: number
11099          description: When provided, the automatic scheduler must allow additional time at the end of the exam session for takedown
11100          example: 30
11101          nullable: true
11102        usePlanSize:
11103          description: Flag to say whether the automatic scheduler should use the Plan Size or the actual size (number of students) of the exam
11104          nullable: false
11105          type: integer
11106          minimum: 0
11107          maximum: 1
11108        user1:
11109          type: string
11110          description: User-defined field
11111          minLength: 1
11112          maxLength: 256
11113          nullable: true
11114        user2:
11115          type: string
11116          description: User-defined field
11117          minLength: 1
11118          maxLength: 256
11119          nullable: true
11120        user3:
11121          type: string
11122          description: User-defined field
11123          minLength: 1
11124          maxLength: 256
11125          nullable: true
11126        skipStudentClashes:
11127          type: integer
11128          description: >-
11129            Skip student clashes checks when auto-scheduling the exam. Does
11130            not skip student clash checks when manually moving the exam
11131          minimum: 0
11132          maximum: 1
11133          example: 1
11134    SerialExam:
11135      type: object
11136      properties:
11137        assessmentPeriod:
11138          description: Code of the Assessment Period to which the Assessment belongs
11139          type: string
11140          nullable: false
11141          example: 2020FINALS
11142          minLength: 1
11143          maxLength: 25
11144        assessmentType:
11145          description: Optional user-defined name for the type of the assessment
11146          type: string
11147          nullable: true
11148          example: Multiple choice
11149          minLength: 1
11150          maxLength: 255
11151        breakDurationMinutes:
11152          description: The amount of time that a break should last in minutes
11153          type: integer
11154          nullable: true
11155          example: 15
11156        building:
11157          description: If the exam must be scheduled into a specific building, then this field is the code of that building
11158          type: string
11159          nullable: true
11160          example: Appleton Tower
11161          minLength: 1
11162          maxLength: 45
11163        campus:
11164          description: If the exam must be scheduled into a specific campus, then this field is the code of that campus
11165          type: string
11166          nullable: true
11167          example: Central
11168          minLength: 1
11169          maxLength: 45
11170        capabilities:
11171          description: List of room capabilities required by the exam
11172          type: string
11173          example:
11174          nullable: true
11175        code:
11176          description: A code to identify one classic exams from amongst all the classic exams
11177          type: string
11178          nullable: false
11179          example: MATH101-PAPER1
11180          minLength: 1
11181          maxLength: 255
11182        complexity:
11183          description: A calculated value representing how hard the exam is to scheduled (higher numbers are harder to schedule)
11184          type: integer
11185          nullable: true
11186          example: 1000
11187        concurrency:
11188          description: The number of tracks that can run parallel to each other
11189          type: integer
11190          nullable: true
11191          example: 1
11192        dayTemplate:
11193          type: string
11194          description: The name of the day template for the exam
11195          example: Mon-Fri 9-5
11196          minLength: 1
11197          maxLength: 45
11198          nullable: true
11199        description:
11200          type: string
11201          description: A description of the exam
11202          example: Maths 101 Paper A (6 pages)
11203          minLength: 1
11204          maxLength: 255
11205          nullable: true
11206        endDate:
11207          type: string
11208          description: The latest date on which the scheduler should put the exam
11209          example: '2020-09-01 00:00:00'
11210          minLength: 19
11211          maxLength: 19
11212          nullable: true
11213        exclusiveStaff:
11214          description: 1 if the academic staff associated with this exam cannot supervise any other exam concurrently with this exam, otherwise 0
11215          nullable: false
11216          example: 0
11217          type: integer
11218          minimum: 0
11219          maximum: 1
11220        friendlyName:
11221          type: string
11222          description: Free-text alternative name for the exam
11223          example: Marketing Lecture
11224          minLength: 1
11225          maxLength: 255
11226          nullable: true
11227        maxPerInvigilator:
11228          type: number
11229          description: The maximum number of candidates that an invigilator should have to supervise for this exam
11230          example: 20
11231          nullable: true
11232        minutesBetweenBreaks:
11233          description: The amount of time that should separate breaks in minutes
11234          type: integer
11235          nullable: false
11236          example: 60
11237        name:
11238          type: string
11239          description: The name for the exam
11240          example: MATH 101 Paper 1
11241          minLength: 1
11242          maxLength: 255
11243          nullable: false
11244        noPublishStaff:
11245          description: Flag to say whether staff should see the Exam in their timetable (0) or (1)
11246          nullable: false
11247          type: integer
11248          minimum: 0
11249          maximum: 1
11250        noPublishStudents:
11251          description: Flag to say whether students should see the Exam in their timetable (0) or (1)
11252          nullable: false
11253          type: integer
11254          minimum: 0
11255          maximum: 1
11256        notes:
11257          type: string
11258          description: Free-text field
11259          minLength: 1
11260          maxLength: 1000
11261          nullable: true
11262        offer:
11263          type: string
11264          description: The code of the Module and the name of the Offer that the exam belongs to (with a space to separate them)
11265          example: 105EKN 105EKN
11266          minLength: 1
11267          maxLength: 511
11268          nullable: false
11269        personalDeadlineEnabled:
11270          description: Flag to say whether students can have a personal deadline
11271          nullable: false
11272          type: integer
11273          minimum: 0
11274          maximum: 1
11275        plannedSlotsPerTrack:
11276          description: The number of planned slots to have per track
11277          nullable: true
11278          type: integer
11279          example: 3
11280        plannedStartDateTime:
11281          description: The date and time that the Serial Exam is planned to start at
11282          nullable: true
11283          example: "2020-09-01 00:00:00"
11284          type: string
11285        plannedStudentsPerTrackSlot:
11286          description: The number of students who can participate per track slot
11287          type: integer
11288          nullable: false
11289          default: 1
11290          example: 1
11291        planSize:
11292          description: The planned size for the exam
11293          type: integer
11294          nullable: true
11295          example: 1
11296        preferredStart:
11297          type: string
11298          description: The name of the Preferred Start Slots pattern that the automaic scheduler must use
11299          example: Exam Session Starts
11300          minLength: 1
11301          maxLength: 100
11302          nullable: true
11303        ready:
11304          description: Flag to say whether the Exam is ready
11305          nullable: false
11306          type: integer
11307          minimum: 0
11308          maximum: 1
11309        roomPool:
11310          type: string
11311          description: The name of the Room Pool that the automaic scheduler must use
11312          example: Block A
11313          minLength: 1
11314          maxLength: 65
11315          nullable: true
11316        roomSizePerTrack:
11317          description: The minimum size of the room into which a Track can be put
11318          type: integer
11319          nullable: false
11320          example: 5
11321        sequence:
11322          type: number
11323          description: When provided, the automatic scheduler must schedule exams with higher sequence numbers after exams with lower sequence numbers
11324          example: 50
11325          nullable: true
11326        setupTimeMins:
11327          type: number
11328          description: When provided, the automatic scheduler must allow additional time at the start of the exam session for setup
11329          example: 30
11330          nullable: true
11331        slotGroup:
11332          type: string
11333          description: An option Slot Group name.  The automatic scheduler must start all exams in the same Slot Group at the same time.
11334          minLength: 1
11335          maxLength: 255
11336          nullable: true
11337        staff:
11338          type: array
11339          description: The academics responsible for setting the Exam
11340          items:
11341            $ref: '#/components/schemas/StaffCode'
11342        startDate:
11343          type: string
11344          description: The earliest date on which the scheduler should put the exam
11345          example: '2020-09-01 00:00:00'
11346          minLength: 19
11347          maxLength: 19
11348          nullable: true
11349        takedownTimeMins:
11350          type: number
11351          description: When provided, the automatic scheduler must allow additional time at the end of the exam session for takedown
11352          example: 30
11353          nullable: false
11354        trackSlotLengthMins:
11355          type: number
11356          description: The default duration of each slot in a track measured in minutes
11357          example: 15
11358          nullable: false
11359        usePlanSize:
11360          type: integer
11361          description: Flag to say whether to use the Plan Size or not
11362          example: 0
11363          nullable: false
11364          default: 1
11365        user1:
11366          type: string
11367          description: User-defined field
11368          minLength: 1
11369          maxLength: 256
11370          nullable: true
11371        user2:
11372          type: string
11373          description: User-defined field
11374          minLength: 1
11375          maxLength: 256
11376          nullable: true
11377        user3:
11378          type: string
11379          description: User-defined field
11380          minLength: 1
11381          maxLength: 256
11382          nullable: true
11383        skipStudentClashes:
11384          type: integer
11385          description: >-
11386            Skip student clashes checks when auto-scheduling the exam. Does
11387            not skip student clash checks when manually moving the exam
11388          minimum: 0
11389          maximum: 1
11390          example: 1
11391    TakehomeExam:
11392      type: object
11393      properties:
11394        assessmentPeriod:
11395          description: Code of the Assessment Period to which the Assessment belongs
11396          type: string
11397          nullable: false
11398          example: 2020FINALS
11399          minLength: 1
11400          maxLength: 25
11401        assessmentType:
11402          description: Optional user-defined name for the type of the assessment
11403          type: string
11404          nullable: true
11405          example: Multiple choice
11406          minLength: 1
11407          maxLength: 255
11408        code:
11409          description: A code to identify one classic exams from amongst all the classic exams
11410          type: string
11411          nullable: false
11412          example: MATH101-PAPER1
11413          minLength: 1
11414          maxLength: 255
11415        complexity:
11416          description: A calculated value representing how hard the exam is to scheduled (higher numbers are harder to schedule)
11417          type: integer
11418          nullable: true
11419          example: 1000
11420        description:
11421          type: string
11422          description: A description of the exam
11423          example: Maths 101 Paper A (6 pages)
11424          minLength: 1
11425          maxLength: 255
11426          nullable: true
11427        durationMins:
11428          description: Duration of the exam in minutes
11429          type: integer
11430          nullable: false
11431          example: 120
11432        exclusive:
11433          description: 1 if the students taking the exam cannot take any other exams concurrently with this exam, otherwise 0
11434          nullable: false
11435          example: 0
11436          type: integer
11437          minimum: 0
11438          maximum: 1
11439        friendlyName:
11440          type: string
11441          description: Free-text alternative name for the exam
11442          example: Marketing Lecture
11443          minLength: 1
11444          maxLength: 255
11445          nullable: true
11446        name:
11447          type: string
11448          description: The name for the exam
11449          example: MATH 101 Paper 1
11450          minLength: 1
11451          maxLength: 255
11452          nullable: false
11453        noConscheck:
11454          description: The 'No Constraints Check' flag for the exam
11455          type: integer
11456          nullable: false
11457          minimum: 0
11458          maximum: 1
11459        noPublishStaff:
11460          description: Flag to say whether staff should see the Exam in their timetable (0) or (1)
11461          nullable: false
11462          type: integer
11463          minimum: 0
11464          maximum: 1
11465        noPublishStudents:
11466          description: Flag to say whether students should see the Exam in their timetable (0) or (1)
11467          nullable: false
11468          type: integer
11469          minimum: 0
11470          maximum: 1
11471        notes:
11472          description: Free-text field
11473          type: string
11474          minLength: 1
11475          maxLength: 1000
11476          nullable: true
11477        offer:
11478          description: The code of the Module and the name of the Offer that the exam belongs to (with a space to separate them)
11479          type: string
11480          example: 105EKN 105EKN
11481          minLength: 1
11482          maxLength: 511
11483          nullable: false
11484        personalDealineEnabled:
11485          description: Flag reflecting the 'Personal Deadline Enabled' setting for the exam
11486          nullable: false
11487          type: integer
11488          minimum: 0
11489          maximum: 1
11490        planSize:
11491          description: The planned size for the exam
11492          type: number
11493          example: 100
11494          nullable: true
11495        ready:
11496          description: Flag to say whether the Exam is ready
11497          nullable: false
11498          type: integer
11499          minimum: 0
11500          maximum: 1
11501        sequence:
11502          type: number
11503          description: When provided, the automatic scheduler must schedule exams with higher sequence numbers after exams with lower sequence numbers
11504          example: 50
11505          nullable: true
11506        skipStudentClashes:
11507          type: integer
11508          description: >-
11509            Skip student clashes checks when auto-scheduling the exam. Does
11510            not skip student clash checks when manually moving the exam
11511          minimum: 0
11512          maximum: 1
11513          example: 1
11514        staff:
11515          type: array
11516          description: The academics responsible for setting the Exam
11517          items:
11518            $ref: '#/components/schemas/StaffCode'
11519        submissionDate:
11520          type: string
11521          description: The date and time at which the completed takehome exam must be submitted by the students
11522          example: '2020-09-01 17:00:00'
11523          minLength: 19
11524          maxLength: 19
11525          nullable: true
11526        submissionStartDate:
11527          type: string
11528          description: The date and time at which the takehome exam is made available for students to start
11529          example: '2020-09-01 09:30:00'
11530          minLength: 19
11531          maxLength: 19
11532          nullable: true
11533        usePlanSize:
11534          description: Flag to say whether the automatic scheduler should use the Plan Size or the actual size (number of students) of the exam
11535          nullable: false
11536          type: integer
11537          minimum: 0
11538          maximum: 1
11539        user1:
11540          type: string
11541          description: User-defined field
11542          minLength: 1
11543          maxLength: 256
11544          nullable: true
11545        user2:
11546          type: string
11547          description: User-defined field
11548          minLength: 1
11549          maxLength: 256
11550          nullable: true
11551        user3:
11552          type: string
11553          description: User-defined field
11554          minLength: 1
11555          maxLength: 256
11556          nullable: true
11557
11558    Submission:
11559      type: object
11560      properties:
11561        activityName:
11562          description: Name of the activity for the submission
11563          type: string
11564          nullable: false
11565          example: Questionnaire
11566          minLength: 1
11567          maxLength: 255
11568        activityVisibility:
11569          description: Flag to say whether the activity is visible
11570          nullable: false
11571          type: integer
11572          minimum: 0
11573          maximum: 1
11574        allowLateSubmissions:
11575          description: Flag to say whether late submissions are allowed
11576          nullable: false
11577          type: integer
11578          minimum: 0
11579          maximum: 1
11580        assessmentType:
11581          description: Optional user-defined name for the type of the assessment
11582          type: string
11583          nullable: true
11584          example: Multiple choice
11585          minLength: 1
11586          maxLength: 255
11587        assessorAnonymity:
11588          description: Flag to say whether assessor anonymity is allowed
11589          nullable: false
11590          type: integer
11591          minimum: 0
11592          maximum: 1
11593        blindMarking:
11594          description: Flag to say whether marking must be done blind
11595          nullable: false
11596          type: integer
11597          minimum: 0
11598          maximum: 1
11599        code:
11600          description: A code to identify one submission from amongst all the submissions
11601          type: string
11602          nullable: false
11603          example: MATH101-PAPER1
11604          minLength: 1
11605          maxLength: 255
11606        description:
11607          type: string
11608          description: A description of the exam
11609          example: Maths 101 Paper A (6 pages)
11610          minLength: 1
11611          maxLength: 255
11612          nullable: true
11613        friendlyName:
11614          type: string
11615          description: Free-text alternative name for the exam
11616          example: Marketing Lecture
11617          minLength: 1
11618          maxLength: 255
11619          nullable: true
11620        generalFeedback:
11621          type: string
11622          description: The date by which general feedback will be given
11623          example: '2020-09-01 00:00:00'
11624          minLength: 19
11625          maxLength: 19
11626          nullable: true
11627        generalFeedbackEnable:
11628          description: Flag to say whether a general feedback will be given
11629          nullable: false
11630          type: integer
11631          minimum: 0
11632          maximum: 1
11633        individualFeedback:
11634          type: string
11635          description: The date by which individual feedback will be given
11636          example: '2020-09-01 00:00:00'
11637          minLength: 19
11638          maxLength: 19
11639          nullable: true
11640        mitigationEnabled:
11641          description: Flag to say whether a general feedback will be given
11642          nullable: false
11643          type: integer
11644          minimum: 0
11645          maximum: 1
11646        name:
11647          type: string
11648          description: The name for the exam
11649          example: MATH 101 Paper 1
11650          minLength: 1
11651          maxLength: 255
11652          nullable: false
11653        notes:
11654          type: string
11655          description: Free-text field
11656          minLength: 1
11657          maxLength: 1000
11658          nullable: true
11659        offer:
11660          type: string
11661          description: The code of the Module and the name of the Offer that the exam belongs to (with a space to separate them)
11662          example: 105EKN 105EKN
11663          minLength: 1
11664          maxLength: 511
11665          nullable: false
11666        personalDeadlineEnabled:
11667          description: Flag to say whether students can have a personal deadline
11668          nullable: false
11669          type: integer
11670          minimum: 0
11671          maximum: 1
11672        plagiarismAllowNonOrSubmissions:
11673          description: Flag
11674          nullable: false
11675          type: integer
11676          minimum: 0
11677          maximum: 1
11678        plagiarismCompareInternet:
11679          description: Flag
11680          nullable: false
11681          type: integer
11682          minimum: 0
11683          maximum: 1
11684        plagiarismCompareJournals:
11685          description: Flag
11686          nullable: false
11687          type: integer
11688          minimum: 0
11689          maximum: 1
11690        plagiarismCompareStudentPapers:
11691          description: Flag
11692          nullable: false
11693          type: integer
11694          minimum: 0
11695          maximum: 1
11696        plagiarismExcludeBiblio:
11697          description: Flag
11698          nullable: false
11699          type: integer
11700          minimum: 0
11701          maximum: 1
11702        plagiarismExcludeMatches:
11703          description: Flag
11704          nullable: false
11705          type: integer
11706          minimum: 0
11707          maximum: 2
11708        plagiarismExcludeMatchesValue:
11709          description: Flag
11710          nullable: true
11711          type: integer
11712          minimum: 0
11713        plagiarismExcludeQuoted:
11714          description: Flag
11715          nullable: false
11716          type: integer
11717          minimum: 0
11718          maximum: 1
11719        plagiarismReportGen:
11720          description: Flag
11721          nullable: true
11722          type: integer
11723          minimum: 0
11724          maximum: 2
11725        plagiarismShowStudentReport:
11726          description: Flag
11727          nullable: false
11728          type: integer
11729          minimum: 0
11730          maximum: 1
11731        plagiarismSubmitPapersTo:
11732          description: Flag
11733          nullable: false
11734          type: integer
11735          minimum: 0
11736          maximum: 1
11737        ready:
11738          description: Flag to say whether the Exam is ready
11739          nullable: false
11740          type: integer
11741          minimum: 0
11742          maximum: 1
11743        reassessment:
11744          description: Flag to say whether the Exam is ready
11745          nullable: false
11746          type: integer
11747          minimum: 0
11748          maximum: 1
11749        sequence:
11750          type: number
11751          description: When provided, the automatic scheduler must schedule exams with higher sequence numbers after exams with lower sequence numbers
11752          example: 50
11753          nullable: true
11754        submissionDate:
11755          type: string
11756          description: The earliest date on which the scheduler should put the exam
11757          example: '2020-09-01 00:00:00'
11758          minLength: 19
11759          maxLength: 19
11760          nullable: true
11761        submissionFileNumber:
11762          description: Maximum number of files that may be submitted
11763          nullable: true
11764          type: integer
11765          minimum: 0
11766        submissionFileSize:
11767          description: Maximum size of each submitted file
11768          type: string
11769          nullable: true
11770        submissionFileTypes:
11771          description: Type(s) of submitted files that will be accepted
11772          type: string
11773          nullable: false
11774        submissionStartDate:
11775          type: string
11776          description: Date (and time) at which students may start working on the submission
11777          example: '2020-09-01 00:00:00'
11778          minLength: 19
11779          maxLength: 19
11780          nullable: true
11781        useGroups:
11782          description: Flag to say whether groups are to be used
11783          nullable: false
11784          type: integer
11785          minimum: 0
11786          maximum: 1
11787        usePlagiarismCheckingSoftware:
11788          description: Flag to say whether plagiarism checking software is to be used
11789          nullable: false
11790          type: integer
11791          minimum: 0
11792          maximum: 1
11793        user1:
11794          type: string
11795          description: User-defined field
11796          minLength: 1
11797          maxLength: 255
11798          nullable: true
11799        user2:
11800          type: string
11801          description: User-defined field
11802          minLength: 1
11803          maxLength: 255
11804          nullable: true
11805        user3:
11806          type: string
11807          description: User-defined field
11808          minLength: 1
11809          maxLength: 255
11810          nullable: true
11811    Webhook:
11812      type: object
11813      x-examples:
11814        example-1: {}
11815      properties:
11816        c:
11817          type: string
11818          description: Any code that the customer wants to assign to the webhook to identify it.
11819          minLength: 1
11820          maxLength: 60
11821          example: staffChanged
11822        t:
11823          type: string
11824          minLength: 1
11825          maxLength: 255
11826          description: 'The type of object that, when changed, will cause the webhook to be invoked.'
11827          example: staff
11828        h:
11829          type: string
11830          description: An HTTP header to be sent by Semestry to the customer when the webhook is invoked.
11831          example: 'Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l'
11832          minLength: 5
11833          maxLength: 500
11834        u:
11835          type: string
11836          description: The URL to be called by Semestry when the webhook is invoked.
11837          example: 'https://s58.unimelon.co.uk/update/staff'
11838          minLength: 5
11839          maxLength: 500
11840        v:
11841          type: string
11842          minLength: 1
11843          maxLength: 20
11844          description: 'The verb (GET, POST, ...) to be used by Semestry when calling the webhook.'
11845          example: POST
11846        e:
11847          type: string
11848          description: The email to which Semestry sends notifications if/when the webhook call fails.
11849          example: integration@unimelon.co.uk
11850          minLength: 5
11851          maxLength: 500
11852        success:
11853          type: integer
11854          description: The number of times that Semestry has called the webhook successfully.
11855          example: 9999
11856        failure:
11857          type: integer
11858          description: The number of times that Semestry has tries and failed to call the webhook successfully.
11859          example: 1
11860        database:
11861          type: string
11862          description: name of the database
11863    ContactRequirementCode:
11864      description: Unique code to identify a Contact Requirement
11865      type: string
11866      minLength: 1
11867      maxLength: 100
11868      example: CR123
11869    ContactRequirement:
11870      type: object
11871      properties:
11872        c:
11873          type: string
11874          description: Unique code (to identify the Contact Requirement)
11875          minLength: 1
11876          maxLength: 100
11877          nullable: false
11878          example: CR123
11879        'n':
11880          type: string
11881          description: Name
11882          minLength: 1
11883          maxLength: 100
11884          example: Lecture
11885        m:
11886          type: string
11887          description: Code for the Module (to which the Contact Requirement belongs)
11888          minLength: 1
11889          maxLength: 255
11890          nullable: false
11891          example: EKN105
11892        sc:
11893          type: string
11894          description: Code for the Activity Type
11895          minLength: 1
11896          maxLength: 5
11897          nullable: false
11898          example: Lec
11899        h:
11900          type: number
11901          description: Number of contact hours
11902          minimum: 0
11903          nullable: true
11904          example: 20
11905        staff:
11906          type: string
11907          description: CSV list of Staff
11908          example: INV01,INV02,INV03
11909          minLength: 1
11910          nullable: true
11911        staff.json:
11912          type: array
11913          items:
11914            $ref: '#/components/schemas/StaffCode'
11915        u1:
11916          type: string
11917          description: User-defined field 1
11918          minLength: 1
11919          maxLength: 255
11920          example: XXX123
11921        u2:
11922          type: string
11923          description: User-defined field 2
11924          minLength: 1
11925          maxLength: 255
11926          nullable: true
11927          example: XXX123
11928        u3:
11929          type: string
11930          description: User-defined field 3
11931          minLength: 1
11932          maxLength: 255
11933          nullable: true
11934          example: XXX123
11935        wt:
11936          type: string
11937          description: Name of the Week Template
11938          minLength: 1
11939          maxLength: 50
11940          nullable: true
11941          example: Semester 1
11942        caps:
11943          type: string
11944          description: CSV list of Capabilities
11945          example: Projector, Whiteboard
11946          minLength: 1
11947          nullable: true
11948        caps.json:
11949          type: array
11950          items:
11951            $ref: '#/components/schemas/Capability'
11952        altc:
11953          type: string
11954          minLength: 0
11955          maxLength: 64
11956          description: Alt Code
11957        ps:
11958          type: number
11959          description: Plan size
11960          minimum: 0
11961          nullable: true
11962          example: 85
11963    RoomCapacities:
11964      type: array
11965      items:
11966        type: object
11967        description: Object to pass capacities with in the body of the request
11968        properties:
11969          code:
11970            type: string
11971            description: Activity type code
11972            example: Lec
11973          val:
11974            type: integer
11975            description: The user required value for the room capacity of the activity type
11976            example: 20
11977    BuildingsArray:
11978      type: object
11979      properties:
11980        buildings:
11981          type: array
11982          items:
11983            type: object
11984            properties:
11985              b:
11986                type: string
11987                description: building name
11988                example: A Block
11989              c:
11990                type: string
11991                description: Campus code
11992                example: Central
11993    AssessmentType:
11994      type: object
11995      properties:
11996        code:
11997          type: number
11998          description: >-
11999            Automatically generated unique code number to identify the assessment
12000            type. This property cannot be edited but is used to identify individual
12001            assessment types.
12002          nullable: false
12003          minimum: 1
12004          example: 19
12005        name:
12006          type: string
12007          description: >-
12008            Name of the Assessment Type. No two assessment
12009            types can have the same name and same parent.
12010          nullable: false
12011          minLength: 1
12012          maxLength: 255
12013          example: Take-home Exam
12014        parentCode:
12015          type: number
12016          description: >-
12017            Automatically generated unique code number to identify the assessment
12018            type's parent. This property cannot be edited but is used to identify
12019            individual assessment types.
12020          nullable: false
12021          minimum: 1
12022          example: 19
12023        parentName:
12024          type: string
12025          description: A unique name that identfies the parent (if any) of the Assessment Type
12026          nullable: true
12027          minLength: 1
12028          maxLength: 255
12029          example: Exam
12030    RoomBooking:
12031      type: object
12032      properties:
12033        id:
12034          type: number
12035          description: Unique number identifying the room booking on the database. Cannot be set.
12036          minimum: 1
12037          nullable: false
12038          example: 19
12039        code:
12040          type: string
12041          description: Unique string identifying the room booking on the database. Can be set by the user.
12042          minLength: 1
12043          maxLength: 255
12044          nullable: false
12045          example: B19
12046        des:
12047          type: string
12048          description: A description of the room booking
12049          minLength: 0
12050          maxLength: 200
12051          nullable: false
12052          example: Guest lecture
12053        type:
12054          type: string
12055          description: A unique code to identify the type of the room booking
12056          nullable: true
12057          minLength: 0
12058          maxLength: 5
12059          example: Lec
12060        state:
12061          type: string
12062          description: >-
12063            "Approval status of the room booking.
12064            Values: Pending, Approved, Declined"
12065          example: Approved
12066        reason:
12067          type: string
12068          description: Reason why the room booking was declined
12069          nullable: true
12070          minLength: 0
12071          maxLength: 1000
12072          example: Declined due to a shortage of staff
12073        cap:
12074          type: number
12075          description: Number of attendees
12076          minimum: 0
12077          nullable: true
12078        rooms:
12079          type: string
12080          description: CSV list of room codes for the activity's rooms
12081          minLength: 1
12082          nullable: true
12083          example: 'A-001,A-002'
12084        rooms.json:
12085          type: array
12086          items:
12087            $ref: '#/components/schemas/RoomCode'
12088        days:
12089          type: string
12090          description: A CSV list of days for the room booking
12091          minLength: 1
12092          nullable: false
12093          example: Mon,Wed,Fri
12094        time:
12095          type: string
12096          description: "The time of the booking. Format: hh:mm"
12097          example: "09:00"
12098          nullable: false
12099        du:
12100          type: string
12101          description: "The duration of the room booking. Format: hh:mm"
12102          example: "01:00"
12103          nullable: false
12104        weeks:
12105          type: string
12106          description: "CSV list of weeks that the room booking is scheduled. Format: YYYY-Www"
12107          example: '2019-W01,2019-W02,2019-W04'
12108          minLength: 1
12109          maxLength: 90
12110          nullable: false
12111        owner:
12112          type: string
12113          description: Staff or student code for the owner of the room booking
12114          nullable: false
12115          maxLength: 255
12116          example: S91005
12117        owntype:
12118          type: string
12119          description: A string indicating whether the owner is a staff member, a student or a full fat user
12120          nullable: false
12121          maxLength: 45
12122          example: staff
12123        contact:
12124          type: string
12125          description: Contact details for the owner/creator of the room booking
12126          nullable: true
12127          minLength: 0
12128          maxLength: 120
12129          example: booking.owner@email.com
12130        created:
12131          type: string
12132          description: "Date and time the room booking was created. Format: YYYY-MM-DD HH:MM:SS"
12133          nullable: false
12134          example: "2019-04-19 11:17:22"
12135        updated:
12136          type: string
12137          description: "Date and time the room booking was updated. Format: YYYY-MM-DD HH:MM:SS"
12138          nullable: false
12139          example: "2019-04-26 14:59:34"
12140        dep:
12141          type: string
12142          description: A unique identifier for the Department of the room booking
12143          example: BUS
12144          minLength: 1
12145          maxLength: 255
12146          nullable: false
12147        offer:
12148          $ref: '#/components/schemas/OfferReference'
12149        staff:
12150          type: string
12151          description: CSV list of attending staff members' codes
12152          nullable: true
12153          minLength: 0
12154          maxLength: 45
12155          example: S91005,S91031
12156        staff.json:
12157          type: array
12158          items:
12159            $ref: '#/components/schemas/StaffCode'
12160        student:
12161          type: string
12162          description: CSV list of attending students' codes
12163          nullable: true
12164          minLength: 0
12165          maxLength: 255
12166          example: 1002438,1000110
12167        student.json:
12168          type: array
12169          items:
12170            $ref: '#/components/schemas/StudentCode'
12171        rel:
12172          type: string
12173          description: Related bookings (set ups and take downs)
12174          nullable: true
12175          minLength: 0
12176          example: "Set Up: 26, Take Down: 27"
12177        parent:
12178          type: string
12179          description: Parent booking of set up or take down bookings
12180          nullable: true
12181          minLength: 0
12182          example: Set Up for 19
12183        note:
12184          type: string
12185          description: Free-text note for the room booking
12186          example: Room booking notes
12187          minLength: 0
12188          nullable: true
12189        user1:
12190          type: string
12191          description: User-definable field 1
12192          nullable: true
12193          minLength: 0
12194          maxLength: 60
12195          example: User 1
12196        user2:
12197          type: string
12198          description: User-definable field 2
12199          nullable: true
12200          minLength: 0
12201          maxLength: 60
12202          example: User 2
12203        user3:
12204          type: string
12205          description: User-definable field 3
12206          nullable: true
12207          minLength: 0
12208          maxLength: 60
12209          example: User 3
12210        user4:
12211          type: string
12212          description: User-definable field 4
12213          nullable: true
12214          minLength: 0
12215          maxLength: 60
12216          example: User 4
12217    ReportRoomBooking:
12218      type: object
12219      properties:
12220        id:
12221          type: number
12222          description: Unique number identifying the room booking on the database. Cannot be set.
12223          minimum: 1
12224          nullable: false
12225          example: 19
12226        code:
12227          type: string
12228          description: Unique string identifying the room booking on the database. Can be set by the user.
12229          minLength: 1
12230          maxLength: 255
12231          nullable: false
12232          example: B19
12233        description:
12234          type: string
12235          description: A description of the room booking
12236          minLength: 0
12237          maxLength: 200
12238          nullable: false
12239          example: Guest lecture
12240        bookingType:
12241          type: string
12242          description: A unique code to identify the type of the room booking
12243          nullable: true
12244          minLength: 0
12245          maxLength: 5
12246          example: Lec
12247        state:
12248          type: string
12249          description: >-
12250            "Approval status of the room booking.
12251            Values: Pending, Approved, Declined"
12252          example: Approved
12253        reason:
12254          type: string
12255          description: Reason why the room booking was declined
12256          nullable: true
12257          minLength: 0
12258          maxLength: 1000
12259          example: Declined due to a shortage of staff
12260        numberAttending:
12261          type: number
12262          description: Number of attendees
12263          minimum: 0
12264          nullable: true
12265        rooms:
12266          type: string
12267          description: CSV list of room codes for the activity's rooms
12268          minLength: 1
12269          nullable: true
12270          example: 'A-001,A-002'
12271        area:
12272          type: number
12273          description: Total area of room booking's rooms in square meters
12274          minimum: 0
12275          nullable: true
12276          example: 20
12277        Kg/yr:
12278          type: number
12279          description: Total carbon emissions of the room booking's rooms in kilograms per year
12280          minimum: 0
12281          nullable: true
12282          example: 90
12283        day:
12284          type: string
12285          description: A CSV list of days for the room booking
12286          minLength: 1
12287          nullable: false
12288          example: Mon,Wed,Fri
12289        time:
12290          type: string
12291          description: "The time of the booking. Format: hh:mm"
12292          example: "09:00"
12293          nullable: false
12294        endTime:
12295          type: string
12296          description: "The end time of the booking. Format: hh:mm"
12297          example: "10:30"
12298          nullable: false
12299        du:
12300          type: string
12301          description: "The duration of the room booking. Format: hh:mm"
12302          example: "01:30"
12303          nullable: false
12304        weeks:
12305          type: string
12306          description: "CSV list of weeks that the room booking is scheduled. Format: YYYY-Www"
12307          example: '2019-W01,2019-W02,2019-W04'
12308          minLength: 1
12309          maxLength: 90
12310          nullable: false
12311        owner:
12312          type: string
12313          description: Staff or student code for the owner of the room booking
12314          nullable: false
12315          maxLength: 255
12316          example: S91005
12317        owntype:
12318          type: string
12319          description: A string indicating whether the owner is a staff member, a student or a full fat user
12320          nullable: false
12321          maxLength: 45
12322          example: staff
12323        contactDetails:
12324          type: string
12325          description: Contact details for the owner/creator of the room booking
12326          nullable: true
12327          minLength: 0
12328          maxLength: 120
12329          example: booking.owner@email.com
12330        createdAt:
12331          type: string
12332          description: "Date and time the room booking was created. Format: YYYY-MM-DD HH:MM:SS"
12333          nullable: false
12334          example: "2019-04-19 11:17:22"
12335        updatedAt:
12336          type: string
12337          description: "Date and time the room booking was updated. Format: YYYY-MM-DD HH:MM:SS"
12338          nullable: false
12339          example: "2019-04-26 14:59:34"
12340        department:
12341          type: string
12342          description: A unique identifier for the Department of the room booking
12343          example: BUS
12344          minLength: 1
12345          maxLength: 255
12346          nullable: false
12347        moduleOffer:
12348          type: string
12349          description: "Module offer of the room booking"
12350          example: '105EKN-Semestr1 - 105EKN'
12351          minLength: 0
12352          nullable: true
12353        staff:
12354          type: string
12355          description: CSV list of attending staff members' codes
12356          nullable: true
12357          minLength: 0
12358          maxLength: 45
12359          example: S91005,S91031
12360        student:
12361          type: string
12362          description: CSV list of attending students' codes
12363          nullable: true
12364          minLength: 0
12365          maxLength: 255
12366          example: 1002438,1000110
12367        capabilities:
12368          type: string
12369          description: CSV list of room booking capabilities
12370          nullable: true
12371          example: E\/Data Projector,D\/Wheelchair
12372        relatedBookings:
12373          type: string
12374          description: Related bookings (set ups and take downs)
12375          nullable: true
12376          minLength: 0
12377          example: "Set Up: 26, Take Down: 27"
12378        parentBooking:
12379          type: string
12380          description: Parent booking of set up or take down bookings
12381          nullable: true
12382          minLength: 0
12383          example: Set Up for 19
12384        notes:
12385          type: string
12386          description: Free-text note for the room booking
12387          example: Room booking notes
12388          minLength: 0
12389          nullable: true
12390        user1:
12391          type: string
12392          description: User-definable field 1
12393          nullable: true
12394          minLength: 0
12395          maxLength: 60
12396          example: User 1
12397        user2:
12398          type: string
12399          description: User-definable field 2
12400          nullable: true
12401          minLength: 0
12402          maxLength: 60
12403          example: User 2
12404        user3:
12405          type: string
12406          description: User-definable field 3
12407          nullable: true
12408          minLength: 0
12409          maxLength: 60
12410          example: User 3
12411        user4:
12412          type: string
12413          description: User-definable field 4
12414          nullable: true
12415          minLength: 0
12416          maxLength: 60
12417          example: User 4
12418    ReportRoom:
12419      type: object
12420      properties:
12421        code:
12422          type: string
12423          description: Unique code to identify the room
12424          nullable: false
12425          minLength: 1
12426          maxLength: 45
12427          example: A-001
12428        name:
12429          type: string
12430          description: Room's name
12431          nullable: false
12432          minLength: 1
12433          maxLength: 255
12434          example: A-001 Theatre
12435        floor:
12436          type: string
12437          description: Name of the floor the room is on
12438          nullable: false
12439          minLength: 1
12440          maxLength: 45
12441          example: Ground
12442        floorCode:
12443          type: string
12444          description: Code of the floor the room is on
12445          nullable: false
12446          minLength: 1
12447          maxLength: 45
12448          example: C1B1F1
12449        building:
12450          type: string
12451          description: Name of the building the room is in
12452          nullable: false
12453          minLength: 1
12454          maxLength: 100
12455          example: A Block
12456        buildingCode:
12457          type: string
12458          description: Code of the building the room is in
12459          nullable: false
12460          minLength: 1
12461          maxLength: 100
12462          example: C1B1
12463        campus:
12464          type: string
12465          description: Name of the campus the room is in
12466          nullable: false
12467          minLength: 1
12468          maxLength: 100
12469          example: Central
12470        campusCode:
12471          type: string
12472          description: Code of the campus the room is in
12473          nullable: false
12474          minLength: 1
12475          maxLength: 100
12476          example: C1
12477        area:
12478          type: number
12479          description: Physical size of the room
12480          nullable: true
12481          minimum: 0
12482          example: 50
12483        KgYr:
12484          type: number
12485          description: Value of carbon emissions in Kg per year
12486          nullable: true
12487          minimum: 0
12488          example: 60
12489        notes:
12490          type: string
12491          description: Free-text notes for the room
12492          nullable: true
12493          minLength: 0
12494          maxLength: 1000
12495          example: Room notes
12496        department:
12497          type: string
12498          description: Unique code identifying the department the room belongs to
12499          nullable: false
12500          minLength: 1
12501          maxLength: 255
12502          example: ENG
12503        superRoom:
12504          type: string
12505          description: Name of super room
12506          nullable: true
12507          minLength: 0
12508          maxLength: 45
12509          example: A-001 Super Theatre
12510        del:
12511          type: number
12512          description: Deletion flag. When 1, it indicates that the room is to be deleted in the future
12513          nullable: true
12514          minimum: 0
12515          maximum: 1
12516          example: 1
12517        maxConcurrentExams:
12518          type: number
12519          description: Number of maximum concurent exams that can be scheduled in the room
12520          nullable: true
12521          minimum: 0
12522          example: 5
12523        reservedCapacity:
12524          type: number
12525          description: Room's reserved capacity
12526          nullable: true
12527          minimum: 0
12528          example: 19
12529        seatingPlan:
12530          type: string
12531          description: A CSV list of the room's seating plan
12532          nullable: true
12533          minLength: 0
12534          example: 1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20
12535        owner:
12536          type: string
12537          description: Name of the room's owner
12538          nullable: true
12539          minLength: 0
12540          maxLength: 100
12541          example: Dr. Silver
12542        setUpTime:
12543          type: string
12544          description: "Room's set up time. Format: hh:mm"
12545          nullable: true
12546          minLength: 0
12547          maxLength: 5
12548          example: 01:30
12549        takeDownTime:
12550          type: string
12551          description: "Room's take down time. Format: hh:mm"
12552          nullable: true
12553          minLength: 0
12554          maxLength: 5
12555          example: 01:30
12556        events:
12557          type: number
12558          description: A count of all events for the room
12559          nullable: true
12560          minimum: 0
12561          example: 841
12562        capacities:
12563          type: number
12564          description: >-
12565            Room's maximum capacities for each activity type.
12566            The number of these properties and their names will vary
12567            to match the activity types set in the config page.
12568          nullable: true
12569          minimum: 0
12570          example: 30
12571        capabilities:
12572          type: string
12573          description: A CSV list of room capabilities
12574          nullable: true
12575          minLength: 0
12576          example: L/Tiered,E/Data Projector,E/Hearing Loop,D/Wheelchair
12577        specialReq:
12578          type: string
12579          description: A CSV list of room's special requirements
12580          nullable: true
12581          minLength: 0
12582          example: Reader
12583        users:
12584          type: string
12585          description: A CSV list of room's users
12586          nullable: true
12587          minLength: 0
12588          example: Dr. Baker,Dr. Jones,Dr. Freeman
12589        usersWeekTemplates:
12590          type: string
12591          description: A CSV list of week templates set by room's users
12592          nullable: true
12593          minLength: 0
12594          example: All Year,Semester 1
12595        usersDayTemplates:
12596          type: string
12597          description: A CSV list of day templates set by room's users
12598          nullable: true
12599          minLength: 0
12600          example: Normal 9-5,Wed PM off
12601        pools:
12602          type: string
12603          description: A CSV list of room pool names that the room belongs to
12604          nullable: true
12605          minLength: 0
12606          example: A Block,B Block
12607        slotsYr:
12608          type: number
12609          description: Max number of slots per academic year for the room
12610          nullable: true
12611          minimum: 0
12612          example: 20
12613        slotsAct:
12614          type: number
12615          description: Number of slots with activities for the room, regardless of room availability
12616          nullable: true
12617          minimum: 0
12618          example: 735
12619        freqAct:
12620          type: string
12621          description: Percentage of slots with activities for the room, regardless of room availability
12622          nullable: true
12623          minLength: 0
12624          example: 31.3%
12625        freqAll:
12626          type: string
12627          description: The percentage of the time during which the Room is being used for an Activity (or Exam) or Booking. Note that this count will include any Slots where the Room is unavailable
12628          nullable: true
12629          minLength: 0
12630          example: 31.3%
12631        slotsActAvail:
12632          type: number
12633          description: Number of slots with activities when the room is available
12634          nullable: true
12635          minimum: 0
12636          example: 215
12637        freqActAvail:
12638          type: string
12639          description: Percentage of slots with activities when the room is available
12640          nullable: true
12641          minLength: 0
12642          example: 21.6%
12643        freqAllAvail:
12644          type: string
12645          description: The same as allFreq except that Slots where the Room is unavailable are not included
12646          nullable: true
12647          minLength: 0
12648          example: 21.6%
12649        slotsBook:
12650          type: number
12651          description: Number of slots with bookings for the room, regardless of room availability
12652          nullable: true
12653          minimum: 0
12654          example: 321
12655        staffBook:
12656          type: number
12657          description: Staff attendees for the slots with bookings for the room, regardless of room availability
12658          nullable: true
12659          minimum: 0
12660          example: 43
12661        stuBook:
12662          type: number
12663          description: Student attendees for the slots with bookings for the room, regardless of room availability
12664          nullable: true
12665          minimum: 0
12666          example: 654
12667        slotsBookAvail:
12668          type: number
12669          description: Number of slots with bookings when the room is available
12670          nullable: true
12671          minimum: 0
12672          example: 546
12673        bookAvailStaff:
12674          type: number
12675          description: Staff attendees for the slots with bookingswhen the room is available
12676          nullable: true
12677          minimum: 0
12678          example: 65
12679        bookAvailStu:
12680          type: number
12681          description: Student attendees for the slots with bookingswhen the room is available
12682          nullable: true
12683          minimum: 0
12684          example: 786
12685        occAct:
12686          type: string
12687          description: Room's occupancy percentage, regardless of room availability
12688          nullable: true
12689          minLength: 0
12690          example: 73.7%
12691        occActAvail:
12692          type: string
12693          description: Room's occupancy percentage when room is available
12694          nullable: true
12695          minLength: 0
12696          example: 84.5%
12697        slotsAll:
12698          type: number
12699          description: Number of all slots for the room with at least one activity or booking in them
12700          nullable: true
12701          minimum: 0
12702          example: 1056
12703        occAll:
12704          type: string
12705          description: Room's total occupancy percentage, regardless of room availability
12706          nullable: true
12707          minLength: 0
12708          example: 73.7%
12709        occAllAvail:
12710          type: string
12711          description: Room's total occupancy percentage when room is available
12712          nullable: true
12713          minLength: 0
12714          example: 84.5%
12715        utilAct:
12716          type: string
12717          description: Calculated as the product of freqAct and occAct
12718          nullable: true
12719          minLength: 0
12720          example: 34.5%
12721        utilActAvail:
12722          type: string
12723          description: Calculated as the product of freqActAvail and occActAvail
12724          nullable: true
12725          minLength: 0
12726          example: 34.5%
12727        utilAll:
12728          type: string
12729          description: Calculated as the product of freqAll and occAll
12730          nullable: true
12731          minLength: 0
12732          example: 34.5%
12733        utilAllAvail:
12734          type: string
12735          description: Calculated as the product of freqAllAvail and utilAllAvail
12736          nullable: true
12737          minLength: 0
12738          example: 34.5%
12739        maxCap:
12740          type: number
12741          description: Largest capacity for each of the room's section categories
12742          nullable: true
12743          minimum: 0
12744          example: 300
12745        maxCapYr:
12746          type: number
12747          description: Largest capacity for each of the room's section categories per year
12748          nullable: true
12749          minimum: 0
12750          example: 300
12751        slotsUnavail:
12752          type: number
12753          description: Room Unavailabilities
12754          nullable: true
12755          minimum: 0
12756          example: 10
12757    PerStudentPerExamSpecialRequirementBodyParams:
12758      type: object
12759      properties:
12760        addSpecialRequirements:
12761          type: string
12762          description: CSV list or JSON array of special requirements to add to the student-exam mapping
12763        removeSpecialRequirements:
12764          type: string
12765          description: CSV list or JSON array of special requirements to remove from the student-exam mapping
12766        setSpecialRequirements:
12767          type: string
12768          description: CSV list or JSON array of special requirements to set for the student-exam mapping
12769    Success:
12770      type: object
12771      properties:
12772        code:
12773          type: integer
12774          enum:
12775            - 0
12776        message:
12777          type: string
12778          example: 'It worked'
12779      required:
12780        - code
12781        - message
12782    SuccessReturnsCodes:
12783      type: object
12784      properties:
12785        code:
12786          type: integer
12787          enum:
12788            - 0
12789        message:
12790          type: string
12791          example: 'It worked'
12792        newObjectCodes:
12793          type: array
12794          items:
12795            type: string
12796      required:
12797        - code
12798        - message
12799        - newObjectCodes
12800    ApplicationError:
12801      type: object
12802      properties:
12803        code:
12804          type: integer
12805          enum:
12806            - 100
12807            - 101
12808            - 102
12809            - 103
12810            - 104
12811            - 105
12812            - 106
12813            - 107
12814            - 108
12815            - 109
12816            - 110
12817            - 114
12818          description: |
12819            Error codes:
12820              * `100` - Bad API key, e.g. too short or malformed
12821              * `101` - Unrecognised API key, i.e. not on the pre-agreed list of keys
12822              * `102` - Missing mandatory parameter
12823              * `103` - Missing optional parameter, used when the presence of one parameter is required beacuse of the presence of another parameter
12824              * `104` - No database found, may occur when a given database has not been loaded onto a test server
12825              * `105` - Internal server error, a catch-all for unexpected errors
12826              * `106` - No object found, i.e. the request contains a code that references no object in the database
12827              * `107` - Multiple objects found, i.e. the request contains a code that references more than one object in the database
12828              * `108` - Key not found in JSON, i.e. the API key was not found in the Authorization header and it was not found in the query parameters
12829              * `109` - Parameter has wrong format, e.g. a string was provided where a number was needed
12830              * `110` - Unauthorized, i.e. the user 'api' has not been configured with Create, Edit or Delete rights for the relevant Department(s)
12831              * `114` - Object in use - e.g., Student groups are linked to Activities
12832        message:
12833          type: string
12834      required:
12835        - code
12836        - message
12837  responses:
12838    CourseNotFound:
12839      description: The specified course was not found
12840      content:
12841        application/json:
12842          schema:
12843            $ref: '#/components/schemas/ApplicationError'
12844    ModuleOfferNotFound:
12845      description: The specified Module Offer was not found
12846      content:
12847        application/json:
12848          schema:
12849            $ref: '#/components/schemas/ApplicationError'
12850    OperationSucceeded:
12851      description: The operation requested completed without error
12852      content:
12853        application/json:
12854          schema:
12855            $ref: '#/components/schemas/Success'
12856    OperationSucceededReturnsCodes:
12857      description: The operation requested completed without error
12858      content:
12859        application/json:
12860          schema:
12861            $ref: '#/components/schemas/SuccessReturnsCodes'
12862    BadRequest:
12863      description: There's a problem with the contents of the request
12864      content:
12865        application/json:
12866          schema:
12867            $ref: '#/components/schemas/ApplicationError'
12868    Unauthorized:
12869      description: The 'api' user lacks authorisation for the operation
12870      content:
12871        application/json:
12872          schema:
12873            $ref: '#/components/schemas/ApplicationError'
12874    InternalServerError:
12875      description: An unanticipated situation is preventing the server from completing the operation
12876      content:
12877        application/json:
12878          schema:
12879            $ref: '#/components/schemas/ApplicationError'