-
Notifications
You must be signed in to change notification settings - Fork 0
/
ooapiv4.json
5621 lines (5621 loc) · 183 KB
/
ooapiv4.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"openapi": "3.0.3",
"info": {
"version": "4.0",
"title": "Open Education API",
"description": "OpenAPI (fka Swagger) specification for the Open Education API.\n\n<figure>\n\t<a target=\"_blank\" href=\"OOAPI_model_v4.png\">\n <img src=\"OOAPI_model_v4.png\" alt=\"OOAPI information model that feeds OOAPI specification\" width=\"70%\" class=\"img-responsive\">\n </a>\n <figcaption> OOAPI information model that feeds OOAPI specification (click to enlage)</figcaption>\n</figure>\n\nThe model provides an overview of how the objects on which the API is specified are related. The overarching concept educations is not found in the in the end points of the API. The smaller concepts of programOffering, courseOffering and conceptOffering are all found in the offering endpoint. The different types of association can all be found in the association endpoint.\n\nThe program relations object is not found as a separate endpoint but relations between programs can be found within the program endpoint by expanding that endpoint.\n\nInformation about earlier meetings and presentations can be found <a target=\"_blank\" href=\"https://github.com/open-education-api/notulen\">here</a>\n\nInformation on the EDU-API model that was also used for this api is shown <a target=\"_blank\" href=\"eduapi.png\">here</a>\n",
"x-logo": {
"url": "../logo.png"
}
},
"tags": [
{
"name": "service metadata",
"description": "The service API provides additional metadata needed to make the OOAPI fit for this organization."
},
{
"name": "academic sessions",
"description": "The academic sessions API provides information about the different time periods a program can be offered."
},
{
"name": "associations",
"description": "The associations API provides information about the association between an offering and a person (e.g. students, lecturers, etc)."
},
{
"name": "buildings",
"description": "The building API provides a building that is currently used by the organization. Including all location details."
},
{
"name": "courses",
"description": "The courses API provides a self-contained and formally structured learning experience. Aimed at providing learning outcomes to students. Usually placed in the context of a program."
},
{
"name": "components",
"description": "The components API provides information about components being part of parent courses."
},
{
"name": "news",
"description": "The news API provides news feeds and items regarding a specific subject."
},
{
"name": "offerings",
"description": "The offerings API provides information about offerings which have a global timeframe, e.g. a period to which students can enroll."
},
{
"name": "organizations",
"description": "The organizations API provides the organizations that are responsible for the execution and recognition of education."
},
{
"name": "persons",
"description": "The persons API provides information about persons related to an organization."
},
{
"name": "programs",
"description": "The programs API provides a coherent set of educational components, aimed at the realization of competences or objectives in the field of knowledge, insight, attitudes and skills that the person who completes the program must have."
},
{
"name": "rooms",
"description": "The rooms API provides the part of a building where an activity can take place. Including detail information on the resources available, number of seats, etc. (Updated continuously)"
},
{
"name": "about identifiers",
"description": "All identifiers should be globally unique for the scope of an institute. This should be guaranteed automatically, when using UUID's as prescribed by this specification.\n"
},
{
"name": "query information (use of q)",
"description": "Endpoints can be searched using the q parameter. This parameter acts as a filter for the endpoint it filters items having a:\n* name,\n* abbreviation or\n* description\n\nor for persons:\n* givenName\n* surNamePrefix\n* surname\n* displayName\n* initials\n* mail\n* secondaryMail\n\ncontaining the given search term (exact partial match, case insensitive)\n\n# Examples\n<pre lang=\"json\"><code class=\"json\">\nGET /programs?q=stud\n\nResult:\n{\n \"programId\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"type\": \"alliance\",\n <strong>\"name\": \"Student Mobility\",\n \"abbreviation\": \"studM\",\n \"description\": \"program that is a place holder for all courses that are made available for student mobility\",</strong>\n \"ects\": 5,\n \"qualificationAwarded\": \"None\",\n \"lengthOfProgram\": 6,\n \"levelOfQualification\": 6,\n \"sector\": \"university education\",\n \"fieldsOfStudy\": \"0732\",\n \"crohoCreboCode\": \"59312\",\n \"profileOfProgram\": \"the program is meant to be a place holder for all courses that can be exchanged between Universities, therefore there is no main focus for this program\",\n \"learningOutcomes\": [\n \"string\"\n ],\n \"admissionRequirements\": \"Students need to be enrolled at qualifying institutions of higher education that participate in this alliance\",\n \"qualificationRequirements\": \"None\",\n \"link\": \"https://bijvak.nl\",\n \"ext\": { }\n}\n</code></pre>\n"
},
{
"name": "expand information",
"description": "Most endpoints also provide additional information which is not provided by default. To obtain this information we use an expand mechanism\n\n# Endpoints which are expandable\n* academic-session\n* association\n* component\n* component-offering\n* course\n* course-offering\n* organization\n* program\n* program-offering\n* room\n\n# Examples\nFirst expand the program only to show additional parent information:\n```\nGET /programs/{programId}?expand=parent\n\nResult:\n{\n\"programId\": \"123e4567-e89b-12d3-a456-426614174000\",\n\"type\": \"alliance\",\n\"name\": \"Student Mobility\",\n\"abbreviation\": \"studM\",\n\"description\": \"program that is a place holder for all courses that are made available for student mobility\",\n\"ects\": 5,\n\"qualificationAwarded\": \"None\",\n\"lengthOfProgram\": 6,\n\"levelOfQualification\": 6,\n\"sector\": \"university education\",\n\"fieldsOfStudy\": \"0732\",\n\"crohoCreboCode\": \"59312\",\n\"profileOfProgram\": \"the program is meant to be a place holder for all courses that can be exchanged between Universities, therefore there is no main focus for this program\",\n\"learningOutcomes\": [\n\"string\"\n],\n\"admissionRequirements\": \"Students need to be enrolled at qualifying institutions of higher education that participate in this alliance\",\n\"qualificationRequirements\": \"None\",\n\"link\": \"https://bijvak.nl\",\n\"ext\": { },\n\"parent\": {\n \"programId\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"type\": \"alliance\",\n \"name\": \"Student Mobility\",\n \"abbreviation\": \"studM\",\n \"description\": \"program that is a place holder for all courses that are made available for student mobility\",\n \"ects\": 5,\n \"qualificationAwarded\": \"None\",\n \"lengthOfProgram\": 6,\n \"levelOfQualification\": 6,\n \"sector\": \"university education\",\n \"fieldsOfStudy\": \"0732\",\n \"crohoCreboCode\": \"59312\",\n \"profileOfProgram\": \"the program is meant to be a place holder for all courses that can be exchanged between Universities, therefore there is no main focus for this program\",\n \"learningOutcomes\": [\n \"string\"\n ],\n \"admissionRequirements\": \"Students need to be enrolled at qualifying institutions of higher education that participate in this alliance\",\n \"qualificationRequirements\": \"None\",\n \"link\": \"https://bijvak.nl\",\n \"ext\": { }\n}\n}\n```\n\nWhen additional information is needed on a program the program information can be expanded further by including additional parameters in an array style. If no values are provided for expand there will be no additional information provided. An empty expand parameter will be handled in the same manner as the normal GET function to the API.\n\n\n```\nGET /programs/{programId}?expand=parent,children,organization\n\nResult:\n{\n\"programId\": \"123e4567-e89b-12d3-a456-426614174000\",\n\"type\": \"alliance\",\n\"name\": \"Student Mobility\",\n\"abbreviation\": \"studM\",\n\"description\": \"program that is a place holder for all courses that are made available for student mobility\",\n\"ects\": 5,\n\"qualificationAwarded\": \"None\",\n\"lengthOfProgram\": 6,\n\"levelOfQualification\": 6,\n\"sector\": \"university education\",\n\"fieldsOfStudy\": \"0732\",\n\"crohoCreboCode\": \"59312\",\n\"profileOfProgram\": \"the program is meant to be a place holder for all courses that can be exchanged between Universities, therefore there is no main focus for this program\",\n\"learningOutcomes\": [\n\"string\"\n],\n\"admissionRequirements\": \"Students need to be enrolled at qualifying institutions of higher education that participate in this alliance\",\n\"qualificationRequirements\": \"None\",\n\"link\": \"https://bijvak.nl\",\n\"ext\": { },\n\"parent\": {\n \"programId\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"type\": \"alliance\",\n \"name\": \"Student Mobility\",\n \"abbreviation\": \"studM\",\n \"description\": \"program that is a place holder for all courses that are made available for student mobility\",\n \"ects\": 5,\n \"qualificationAwarded\": \"None\",\n \"lengthOfProgram\": 6,\n \"levelOfQualification\": 6,\n \"sector\": \"university education\",\n \"fieldsOfStudy\": \"0732\",\n \"crohoCreboCode\": \"59312\",\n \"profileOfProgram\": \"the program is meant to be a place holder for all courses that can be exchanged between Universities, therefore there is no main focus for this program\",\n \"learningOutcomes\": [\n \"string\"\n ],\n \"admissionRequirements\": \"Students need to be enrolled at qualifying institutions of higher education that participate in this alliance\",\n \"qualificationRequirements\": \"None\",\n \"link\": \"https://bijvak.nl\",\n \"ext\": { }\n},\n\"children\": [\n {\n \"programId\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"type\": \"alliance\",\n \"name\": \"Student Mobility\",\n \"abbreviation\": \"studM\",\n \"description\": \"program that is a place holder for all courses that are made available for student mobility\",\n \"ects\": 5,\n \"qualificationAwarded\": \"None\",\n \"lengthOfProgram\": 6,\n \"levelOfQualification\": 6,\n \"sector\": \"university education\",\n \"fieldsOfStudy\": \"0732\",\n \"crohoCreboCode\": \"59312\",\n \"profileOfProgram\": \"the program is meant to be a place holder for all courses that can be exchanged between Universities, therefore there is no main focus for this program\",\n \"learningOutcomes\": [\n \"string\"\n ],\n \"admissionRequirements\": \"Students need to be enrolled at qualifying institutions of higher education that participate in this alliance\",\n \"qualificationRequirements\": \"None\",\n \"link\": \"https://bijvak.nl\",\n \"ext\": { }\n }\n],\n\"organization\": {\n \"organizationId\": \"123e4567-e89b-12d3-a456-123514174000\",\n \"name\": \"Coöperatie SURF U.A.\",\n \"shortName\": \"SURF\",\n \"description\": \"SURF is een coöperatieve vereniging van Nederlandse onderwijs- en onderzoeksinstellingen waarin de leden hun krachten bundelen. De leden zijn eigenaar van SURF.\",\n \"type\": \"root\",\n \"addresses\": [\n {\n \"type\": \"postal\",\n \"street\": \"Moreelsepark\",\n \"streetNumber\": \"48\",\n \"additional\": \"On the other side of the road\",\n \"postalCode\": \"3511 EP\",\n \"city\": \"Utrecht\",\n \"countryCode\": \"NL\",\n \"geolocation\": {\n \"latitude\": 52.089123,\n \"longitude\": 5.113337\n },\n \"ext\": { }\n }\n ],\n \"link\": \"https://surf.nl\",\n \"logo\": \"https://www.surf.nl/themes/surf/logo.svg\",\n \"brin\": \"00AA\",\n \"ext\": { }\n}\n}\n```\n"
},
{
"name": "sorting information",
"description": "Most endpoints provide sorting. To sort you can sort on the elements that are specified per endpoint. All elements can be sorted ascending by default o descending,\nby adding \"-\" in front of the element to be sorted. The sorting takes place based on comma separated values. e.g.:\n\n```\nGET /programs?sort=programId\n```\nprovides a list of all programs sorted ascending based on programId\n```\nGET /programs?sort=name,-ects\n```\nprovides a list of all programs first sorted on name ascending and ects descending\n"
},
{
"name": "extension information",
"description": "Most endpoints can be extended. This can be done by providing the extended information in the designated \"ext\" area of the endpoint. All users of the OOAPI are encouraged to feed their extensions back to the OOAPI working group so this information can be used as feedback for future versions of the OOAPI.\n"
},
{
"name": "Error responses",
"description": "Error responses are formatted in the `problem+json` media type ([RFC7807](https://tools.ietf.org/html/rfc7807)):\n```\n{\n \"status\": 404,\n \"title\": \"A short, human-readable summary of the problem type, e.g. 'resource not found'.\"\n \"detail\": \"An optional human-readable explanation specific to this occurrence of the problem.\"\n}\n```\n"
},
{
"name": "Multi-lingual support",
"description": "The OOAPI specifcation relies on the HTTP content negotiation mechanism to specify how a client can request information in a specific (natural) language, and how a server should respond to that request. In short: a client adds an `Accept-Language` header to their request, which the server uses to determine in what language the requested content should be returned. More information about this mechanism can be found at [Mozilla MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).\n"
}
],
"components": {
"securitySchemes": {
"bearerAuth": {
"type": "http",
"scheme": "bearer"
}
},
"parameters": {
"acceptLanguage": {
"name": "Accept-Language",
"in": "header",
"description": "The Accept-Language request HTTP header advertises which languages the client is able to understand, and which locale variant is preferred. See [Mozilla MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language) for more information.",
"required": false,
"schema": {
"type": "string"
}
},
"pageSize": {
"name": "pageSize",
"in": "query",
"description": "The number of items per page",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 10,
"enum": [
10,
20,
50,
100,
250
]
}
},
"pageNumber": {
"name": "pageNumber",
"in": "query",
"description": "The page number to get. Page numbers start at 1.",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
"personSearch": {
"name": "q",
"in": "query",
"description": "Filter by persons having a givenName, surNamePrefix, surname, displayName, initials, mail or secondaryMail containing the given search term (exact partial match, case insensitive)",
"required": false,
"schema": {
"type": "string"
}
},
"search": {
"name": "q",
"in": "query",
"description": "Filter by items having a name, abbreviation or description containing the given search term (exact partial match, case insensitive)",
"required": false,
"schema": {
"type": "string"
}
}
},
"schemas": {
"Ext": {
"type": "object",
"description": "Object for additional non-standard attributes"
},
"Service": {
"type": "object",
"description": "A metadataset providing details on the provider of this OOAPI implementation",
"required": [
"contactEmail",
"specification",
"documentation"
],
"properties": {
"contactEmail": {
"type": "string",
"description": "Contact e-mail address of the service owner",
"format": "email",
"maxLength": 256,
"example": "[email protected]"
},
"specification": {
"type": "string",
"description": "URL of the API specification (YAML or JSON, compliant with [Open API Specification v3](https://github.com/OAI/OpenAPI-Specification/))",
"format": "uri",
"maxLength": 2048,
"example": "https://rawgit.com/open-education-api/specification/v3/docs.html#tag/course-offerings/paths/~1course-offerings/get"
},
"documentation": {
"type": "string",
"description": "URL of the API documentation, including general terms and privacy statement",
"format": "uri",
"maxLength": 2048,
"example": "https://open-education-api.github.io/specification/v4/docs.html"
},
"ext": {
"$ref": "#/components/schemas/Ext"
}
}
},
"Problem": {
"type": "object",
"description": "A system message including the error code and an explanation",
"required": [
"status",
"title"
],
"properties": {
"status": {
"type": "string",
"description": "The HTTP status code",
"example": "404"
},
"title": {
"type": "string",
"description": "A short, human-readable summary of the problem type",
"example": "Resource not found"
},
"detail": {
"type": "string",
"description": "A human-readable explanation specific to this occurrence of the problem"
}
}
},
"personAffiliations": {
"type": "array",
"description": "The affiliations of this person, the relations a person has with the organization providing this endpoint\n- student: student\n- employee: medewerker\n- guest: gast\n",
"items": {
"type": "string",
"enum": [
"student",
"employee",
"guest"
],
"example": "student"
}
},
"gender": {
"type": "string",
"description": "The gender of this person",
"enum": [
"M",
"F",
"U",
"X"
],
"example": "F"
},
"postalType": {
"type": "string",
"description": "Address type\n- postal: post\n- visit: bezoek\n- deliveries: bezorg\n",
"enum": [
"postal",
"visit",
"deliveries"
]
},
"Address": {
"type": "object",
"description": "The full street address",
"required": [
"type"
],
"properties": {
"type": {
"$ref": "#/components/schemas/postalType"
},
"street": {
"type": "string",
"description": "The street name",
"example": "Moreelsepark"
},
"streetNumber": {
"type": "string",
"description": "The street number",
"example": "48"
},
"additional": {
"type": "string",
"description": "Further details like building name, suite, apartment number, etc.",
"example": "On the other side of the road"
},
"postalCode": {
"type": "string",
"description": "Postal code",
"example": "3511 EP"
},
"city": {
"type": "string",
"description": "name of the city / locality",
"example": "Utrecht"
},
"countryCode": {
"type": "string",
"description": "the country code according to [iso-3166-1-alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)",
"example": "NL"
},
"geolocation": {
"type": "object",
"description": "Geolocation of the entrance of this address (WGS84 coordinate reference system)",
"required": [
"latitude",
"longitude"
],
"properties": {
"latitude": {
"type": "number",
"format": "double",
"example": 52.089123
},
"longitude": {
"type": "number",
"format": "double",
"example": 5.113337
}
}
},
"ext": {
"$ref": "#/components/schemas/Ext"
}
}
},
"ICERelationType": {
"type": "string",
"description": "Type of relation between person and In Case of Emergency contact",
"enum": [
"partner",
"parent",
"other"
],
"example": "partner"
},
"Person": {
"type": "object",
"description": "A person that has a relationship with this institution",
"required": [
"personId",
"givenName",
"surname",
"displayName",
"affiliations",
"mail"
],
"properties": {
"personId": {
"type": "string",
"description": "Unique id of this person",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426614174000"
},
"givenName": {
"type": "string",
"description": "The first name of this person",
"maxLength": 256,
"example": "Maartje"
},
"surnamePrefix": {
"type": "string",
"description": "The prefix of the family name of this person",
"example": "van"
},
"surname": {
"type": "string",
"description": "The family name of this person",
"maxLength": 256,
"example": "Damme"
},
"displayName": {
"type": "string",
"description": "The name of this person which will be displayed",
"maxLength": 256,
"example": "Maartje van Damme"
},
"initials": {
"type": "string",
"description": "The initials of this person",
"example": "MCW"
},
"dateOfBirth": {
"type": "string",
"description": "The date of birth of this person, RFC3339 (full-date)",
"format": "date",
"example": "2003-09-30"
},
"cityOfBirth": {
"type": "string",
"description": "The city of birth of this person",
"example": "Utrecht"
},
"countryOfBirth": {
"type": "string",
"description": "The country of birth of this person the country code according to [iso-3166-1-alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)",
"example": "NL"
},
"nationality": {
"type": "string",
"description": "The nationality of this person the nationality according to https://gist.github.com/zspine/2365808",
"example": "Dutch"
},
"dateOfNationality": {
"type": "string",
"description": "The date of nationality of this person, RFC3339 (full-date)",
"format": "date",
"example": "2003-09-30"
},
"affiliations": {
"$ref": "#/components/schemas/personAffiliations"
},
"mail": {
"type": "string",
"description": "The primary e-mailaddress of this person",
"format": "email",
"maxLength": 256,
"example": "[email protected]"
},
"secondaryMail": {
"type": "string",
"description": "The secondary e-mailaddress of this person",
"format": "email",
"maxLength": 256,
"example": "[email protected]"
},
"telephoneNumber": {
"type": "string",
"description": "The telephone number of this person",
"maxLength": 256,
"example": "+31 123 456 789"
},
"mobileNumber": {
"type": "string",
"description": "The mobile number of this person",
"maxLength": 256,
"example": "+31 612 345 678"
},
"photoSocial": {
"type": "string",
"description": "The url of the informal picture of this person",
"format": "uri",
"maxLength": 2048,
"example": "https://upload.wikimedia.org/wikipedia/commons/thumb/d/d5/Placeholder_female_superhero_c.png/203px-Placeholder_female_superhero_c.png"
},
"photoOfficial": {
"type": "string",
"description": "The url of the official picture of this person",
"format": "uri",
"maxLength": 2048,
"example": "https://upload.wikimedia.org/wikipedia/commons/6/66/Johannes_Vermeer_%281632-1675%29_-_The_Girl_With_The_Pearl_Earring_%281665%29.jpg"
},
"gender": {
"$ref": "#/components/schemas/gender"
},
"titlePrefix": {
"type": "string",
"description": "A title prefix to be used for this person",
"example": "drs"
},
"titleSuffix": {
"type": "string",
"description": "A title suffix to be used for this person",
"example": "BSc"
},
"office": {
"type": "string",
"description": "The name of the office where this person is located"
},
"address": {
"$ref": "#/components/schemas/Address"
},
"ICEName": {
"type": "string",
"description": "Full name of In Case of Emergency contact",
"maxLength": 256,
"example": "Janne"
},
"ICEPhoneNumber": {
"type": "string",
"description": "Phone number of In Case of Emergency contact",
"maxLength": 256,
"example": "+31 623 456 789"
},
"ICERelation": {
"$ref": "#/components/schemas/ICERelationType"
},
"languageOfChoice": {
"type": "array",
"description": "The language(s) of choice for this person, RFC3066",
"items": {
"type": "string",
"example": "nl-NL"
}
},
"ext": {
"$ref": "#/components/schemas/Ext"
}
}
},
"associationRole": {
"type": "string",
"description": "The role of this person associated with the offering\n - student: student\n - lecturer: docent\n - teaching assistant: studentassistent\n - coordinator: coördinator\n - guest: gast\n",
"enum": [
"student",
"lecturer",
"teaching assistant",
"coordinator",
"guest"
],
"example": "student"
},
"associationState": {
"type": "string",
"description": "The state of this association",
"enum": [
"pending",
"canceled",
"denied",
"associated"
],
"example": "associated"
},
"resultState": {
"type": "string",
"description": "The state of this result",
"enum": [
"in progress",
"postponed",
"completed"
],
"example": "completed"
},
"Association": {
"type": "object",
"description": "A relationship between a person object and an offering",
"required": [
"associationId",
"type",
"role",
"state"
],
"properties": {
"associationId": {
"type": "string",
"description": "Unique id of this association",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-1237891417400"
},
"type": {
"type": "string",
"description": "The type of this association",
"enum": [
"programOfferingAssociation",
"courseOfferingAssociation",
"componentOfferingAssociation"
],
"example": "componentOfferingAssociation"
},
"role": {
"$ref": "#/components/schemas/associationRole"
},
"state": {
"$ref": "#/components/schemas/associationState"
},
"ext": {
"$ref": "#/components/schemas/Ext"
}
}
},
"Result": {
"type": "object",
"description": "A result as part of an association",
"required": [
"state",
"resultDate"
],
"properties": {
"state": {
"$ref": "#/components/schemas/resultState"
},
"comment": {
"type": "string",
"description": "The comment on this result",
"example": "None"
},
"score": {
"type": "string",
"description": "The score of this program/course/component association (based on resultValueType in offering)",
"example": "9"
},
"resultDate": {
"type": "string",
"description": "The date this result has been published, RFC3339 (full-date)",
"format": "date",
"example": "2020-09-28"
},
"ext": {
"$ref": "#/components/schemas/Ext"
}
}
},
"ProgramResult": {
"allOf": [
{
"$ref": "#/components/schemas/Result"
},
{
"type": "object",
"required": [
"ects"
],
"properties": {
"ects": {
"type": "number",
"description": "The number of EC's that have been earned to the current moment",
"minimum": 0,
"example": 15
}
}
}
]
},
"ProgramOfferingAssociation": {
"allOf": [
{
"$ref": "#/components/schemas/Association"
},
{
"type": "object",
"properties": {
"result": {
"$ref": "#/components/schemas/ProgramResult"
}
}
}
]
},
"AcademicSession": {
"type": "object",
"description": "A period in time during which an offering can take place. Academicsessions can be nested.",
"required": [
"academicSessionId",
"name",
"startDate",
"endDate"
],
"properties": {
"academicSessionId": {
"type": "string",
"description": "Unique id for this academic session",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426614174000"
},
"name": {
"type": "string",
"description": "The name of this academic session",
"maxLength": 256,
"example": "Fall semester 2020"
},
"startDate": {
"type": "string",
"description": "The day on which this academic session starts, RFC3339 (full-date)",
"format": "date",
"example": "2020-08-17"
},
"endDate": {
"type": "string",
"description": "The day on which this academic session ends, RFC3339 (full-date)",
"format": "date",
"example": "2020-12-18"
},
"ext": {
"$ref": "#/components/schemas/Ext"
}
}
},
"resultValueType": {
"type": "string",
"description": "The result value type for this offering",
"enum": [
"pass-or-fail",
"US letter",
"UK letter",
"0-100",
"1-10"
],
"example": "1-10"
},
"Offering": {
"type": "object",
"description": "Either a program, course or component offering which descrbes the program, course or offering in time",
"required": [
"offeringId",
"type",
"name",
"description",
"mainLanguage",
"isLineItem"
],
"properties": {
"offeringId": {
"type": "string",
"description": "Unique id of this offering",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-134564174000"
},
"type": {
"type": "string",
"description": "The type of this offering",
"enum": [
"program",
"course",
"component"
],
"example": "component"
},
"academicSession": {
"$ref": "#/components/schemas/AcademicSession"
},
"name": {
"type": "string",
"description": "The name of this offering",
"maxLength": 256,
"example": "Final written test for INFOMQNM for fall semseter 2020"
},
"abbreviation": {
"type": "string",
"description": "The abbreviation or internal code used to identify this offering",
"maxLength": 256,
"example": "Test-INFOMQNM-20FS"
},
"description": {
"type": "string",
"description": "The description of this offering",
"example": "Prove in wirting knowledge of research methods, including: Acquire knowledge of HCI research paradigms Able to design suitable research studies (e.g., choose between within and between subject designs) Define/apply/design metrics and scales Define/produce materials (e.g., stimuli and questionnaires) Define protocols for research studies Understands and take in account concepts of reliability and validity Analyze and improve methods and analysis of published scientific articles Able to deliver scientific reports Prove in writing knowledge of statistics, including: Handle hypothesis testing with complex designs (e.g., including , dependent, independent, and co variates) Data preparation (e.g., coding and feature selection) Reason towards adequate techniques to ensure valid outcomes (e.g., be aware of type I, type II errors) Select an appropriate sampling method (e.g., stratified) Perform parametric tests (e.g., repeated measures (M)ANOVA) Perform non-parametric tests (e.g., Chi-square, Mann-Whitney, and Kruskal-Wallis)"
},
"mainLanguage": {
"type": "string",
"description": "The main language in which the courses within this program are given, RFC3066",
"example": "nl-NL"
},
"maxNumberStudents": {
"type": "number",
"description": "The maximum number of students allowed to enroll for this offering",
"format": "int32",
"minimum": 0,
"example": 200
},
"enrolledNumberStudents": {
"type": "number",
"description": "The number of students that have already enrolled for this offering",
"format": "int32",
"minimum": 0,
"example": 150
},
"pendingNumberStudents": {
"type": "number",
"description": "The number of students that have a pending enrollment request for this offering",
"format": "int32",
"minimum": 0,
"example": 50
},
"isLineItem": {
"type": "boolean",
"description": "Whether the offering is a line item or not",
"example": true
},
"resultValueType": {
"$ref": "#/components/schemas/resultValueType"
},
"ext": {
"$ref": "#/components/schemas/Ext"
}
}
},
"modeOfStudy": {
"type": "string",
"description": "Indicate whether the course is full-time, part-time, dual or self-paced.\n - full-time: fulltime\n - part-time: parttime\n - dual training: duaal\n - self-paced: eigen tempo\n",
"enum": [
"full-time",
"part-time",
"dual training",
"self-paced"
]
},
"ProgramOffering": {
"allOf": [
{
"$ref": "#/components/schemas/Offering"
},
{
"type": "object",
"required": [
"modeOfStudy",
"startDate",
"endDate"
],
"properties": {
"modeOfStudy": {
"$ref": "#/components/schemas/modeOfStudy"
},
"startDate": {
"type": "string",
"description": "The moment on which this offering starts, RFC3339 (full-date)",
"format": "date",
"example": "2019-08-21"
},
"endDate": {
"type": "string",
"description": "The moment on which this offering ends, RFC3339 (full-date)",
"format": "date",
"example": "2023-06-15"
}
}
}
]
},
"CourseResult": {
"allOf": [
{
"$ref": "#/components/schemas/Result"
},
{
"type": "object",
"required": [
"ects"
],
"properties": {
"ects": {
"type": "number",
"description": "The number of EC's that is earned",
"minimum": 0,
"example": 7.5
}
}
}
]
},
"CourseOfferingAssociation": {
"allOf": [
{
"$ref": "#/components/schemas/Association"
},
{
"type": "object",
"properties": {
"result": {
"$ref": "#/components/schemas/CourseResult"
}
}
}
]
},
"CourseOffering": {
"allOf": [
{
"$ref": "#/components/schemas/Offering"
},
{
"type": "object",
"required": [
"modeOfStudy",
"startDate",
"endDate"
],
"properties": {
"modeOfStudy": {
"$ref": "#/components/schemas/modeOfStudy"
},
"startDate": {
"type": "string",
"description": "The moment on which this offering starts, RFC3339 (full-date)",
"format": "date"
},
"endDate": {
"type": "string",
"description": "The moment on which this offering ends, RFC3339 (full-date)",
"format": "date"
}
}
}
]
},
"ComponentResult": {
"allOf": [
{
"$ref": "#/components/schemas/Result"
},
{
"type": "object",
"required": [
"weight"
],
"properties": {
"weight": {
"type": "integer",
"description": "The weight to 100 as total for this offering in the course",
"format": "int32",
"minimum": 0,
"maximum": 100,
"example": 100
}
}
}
]
},
"ComponentOfferingAssociation": {
"allOf": [
{
"$ref": "#/components/schemas/Association"
},
{
"type": "object",
"properties": {
"result": {
"$ref": "#/components/schemas/ComponentResult"
}
}
}
]
},
"roomType": {
"type": "string",
"description": "The type of this room\n- general purpose: algemeen\n- lecture room: collegezaal\n- computer room: computerruimte\n- laboratory: laboratorium\n- office: kantoor\n- workspace: werkruimte\n- exam location: tentamenruimte\n- study room: studieruimte\n- examination room: onderzoekskamer\n- conference room: vergaderkamer\n",
"enum": [
"general purpose",
"lecture room",
"computer room",
"laboratory",
"office",
"workspace",
"exam location",
"study room",
"examination room",
"conference room"
],
"example": "exam location"
},
"Room": {
"type": "object",
"description": "An area within a building where education can take place",
"required": [
"roomId",
"name",
"type"
],
"properties": {
"roomId": {
"type": "string",
"description": "Unique id for this room",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-332114174000"
},
"abbreviation": {
"type": "string",
"description": "The abbreviation of the name of this room",
"maxLength": 256,
"example": "Bb 4.54"
},
"name": {
"type": "string",
"description": "The name of this room",
"maxLength": 256,
"example": "Beatrix building room 4.54"
},
"type": {
"$ref": "#/components/schemas/roomType"
},
"description": {
"type": "string",
"description": "The description of this room",
"example": "External education and exam room 4.54"
},
"totalSeats": {
"type": "integer",
"format": "int32",
"description": "The total number of seats located in the room",
"example": 300
},
"availableSeats": {
"type": "integer",
"format": "int32",
"description": "The total number of available (=non-reserved) seats in the room",
"example": 200
},
"floor": {
"type": "string",
"description": "The floor on which this room is located",
"example": "4"
},
"wing": {
"type": "string",
"description": "The wing in which this room is located",
"example": "None"
},
"geolocation": {
"type": "object",
"description": "Geolocation of the entrance of this room (WGS84 coordinate reference system)",
"required": [
"latitude",
"longitude"
],
"properties": {
"latitude": {
"type": "number",
"format": "double",
"example": 52.088255
},
"longitude": {
"type": "number",
"format": "double",