-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathsi-api.yaml
1207 lines (1206 loc) · 41.3 KB
/
si-api.yaml
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.1.0
x-stoplight:
id: ol7skl20b16sm
info:
title: SI API 1.0
version: '1.0'
summary: Exchange data with the StudioIntern SaaS app
description: 'This API works only as an addition to the StudioIntern main application. This means that you have to be a StudioIntern customer in order to use this API. But, there is a free 2 month test period available.'
contact:
name: Support
url: api.studiointern.de
email: [email protected]
termsOfService: 'https://www.ballettschul-software.de/agb.php'
servers:
- url: 'https://api.studiointern.de/{customer_shortname}/v1'
description: Generic
paths:
/cust/user:
post:
summary: Change user's password
operationId: post-user
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Response'
examples: {}
application/xml:
schema:
type: object
properties:
message:
type: string
code:
type: integer
x-examples:
Example 1:
message: Password updated
code: 0
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'412':
description: Precondition Failed
'417':
description: To Less Parameters
'500':
description: Internal Server Error
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
email:
type: string
new_password:
type: string
new_password2:
type: string
examples:
Example 1:
value:
email: [email protected]
new_password: super!secret!
new_password2: super!secret!
description: 'Post email address (for additonal user verification), new password and new password2 (for verification).'
description: Change password for a user (dance studio's customer) that has been authorized by Authorization header string.
security:
- UserPwdBase64: []
tags:
- Customer
get:
summary: Get user details
operationId: get-user
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
x-examples:
Example 1:
message: OK
code: 0
user:
id: '50066'
firstName: Barbara
lastName: Aachen
email: [email protected]
students:
- id: '240'
firstName: Barbara
lastName: Aachen
dayOfBirth: '1999-07-12'
email: ''
- id: '241'
firstName: Krawehl
lastName: Aachen
dayOfBirth: '1998-03-12'
email: ''
- id: '109'
firstName: Melusine
lastName: Aachen
dayOfBirth: '2002-01-17'
email: null
active: true
properties:
message:
type: string
code:
type: integer
user:
$ref: '#/components/schemas/User'
examples:
Example 1:
value:
message: OK
code: 0
user:
id: 1234
firstName: Barbara
lastName: Aachen
email: [email protected]
students:
- id: 12
firstName: Susi
lastName: Aachen
dayOfBirth: '2010-10-12'
email: ''
active: true
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: User Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Response'
'417':
description: Invalid parameter
content:
application/json:
schema:
$ref: '#/components/schemas/Response'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Response'
description: Get some information on a specific user (dance studio's customer). The user ID is retrieved from Authorization header string.
security:
- UserPwdBase64: []
tags:
- Customer
parameters: []
'/cust/courses/{id}':
get:
summary: Get current courses of a user's students
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
message:
type: string
code:
type: integer
classes:
type: array
items:
type: string
x-examples:
Example 1:
message: OK
code: 0
classes:
- '3'
- '2'
- '14'
examples:
Example 1:
value:
message: OK
code: 0
classes:
- '3'
- '2'
- '14'
'204':
description: No Content
content:
application/json:
schema:
$ref: '#/components/schemas/Response'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Response'
'500':
description: Internal Server Error
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Response'
operationId: get-cust-courses
description: |-
Get IDs of all classes/courses a specific user (dance studio's customer's student) has subscribed for. The user ID is calculated from Authorization string.
### Parameter
If the id parameter is given, return only courses of the student with `id`.
security:
- UserPwdBase64: []
tags:
- Customer
parameters:
- name: id
in: path
schema:
type: integer
description: 'ID of user or student, depending of context'
'/pub/events/{limit}/{filter}':
get:
summary: Get upcoming events
tags:
- Public
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
x-examples:
Example 1:
message: OK
code: 0
events:
- id: 07b74776-6b04-435f-9ca3-4114c39b9826
start: '2023-02-13 00:00:00'
end: '2023-02-13 00:00:00'
title: Winterferien
description: ''
place: ''
is_holiday: '1'
- id: [email protected]
start: '2023-02-13 00:00:00'
end: '2023-02-25 00:00:00'
title: Winterferien 2023 Sachsen
description: ''
place: ''
is_holiday: '1'
- id: 6b793626-b890-48b9-8862-5f64031dd9a3
start: '2023-04-07 00:00:00'
end: '2023-04-07 00:00:00'
title: Osterferien
description: ''
place: ''
is_holiday: '1'
- id: [email protected]
start: '2023-04-07 00:00:00'
end: '2023-04-16 00:00:00'
title: Osterferien 2023 Sachsen
description: ''
place: ''
is_holiday: '1'
- id: 9d616579-3c70-456e-80e0-9294b54fbcbe
start: '2023-05-19 00:00:00'
end: '2023-05-19 00:00:00'
title: Pfingstferien
description: ''
place: ''
is_holiday: '1'
- id: [email protected]
start: '2023-05-19 00:00:00'
end: '2023-05-20 00:00:00'
title: Pfingstferien 2023 Sachsen
description: ''
place: ''
is_holiday: '1'
- id: 8d3e2c3c-de45-437f-99d1-f795ec250023
start: '2023-07-10 00:00:00'
end: '2023-07-10 00:00:00'
title: Sommerferien
description: ''
place: ''
is_holiday: '1'
- id: [email protected]
start: '2023-07-10 00:00:00'
end: '2023-08-19 00:00:00'
title: Sommerferien 2023 Sachsen
description: ''
place: ''
is_holiday: '1'
- id: 6712a36d-6264-4acf-ba7c-923f557e8126
start: '2023-10-02 00:00:00'
end: '2023-10-02 00:00:00'
title: Herbstferien
description: ''
place: ''
is_holiday: '1'
- id: [email protected]
start: '2023-10-02 00:00:00'
end: '2023-10-15 00:00:00'
title: Herbstferien 2023 Sachsen
description: ''
place: ''
is_holiday: '1'
- id: [email protected]
start: '2023-10-30 00:00:00'
end: '2023-10-31 00:00:00'
title: Herbstferien 2023 Sachsen
description: ''
place: ''
is_holiday: '1'
- id: 227ef203-fd50-410c-88f7-9cfe72a1a116
start: '2023-11-30 00:00:00'
end: '2023-11-30 00:00:00'
title: Herbstferien
description: ''
place: ''
is_holiday: '1'
- id: df7d761c-752f-47f5-9e98-68bd7b0dce70
start: '2023-12-23 00:00:00'
end: '2023-12-23 00:00:00'
title: Weihnachtsferien
description: ''
place: ''
is_holiday: '1'
- id: [email protected]
start: '2023-12-23 00:00:00'
end: '2024-01-03 00:00:00'
title: Weihnachtsferien 2023 Sachsen
description: ''
place: ''
is_holiday: '1'
properties:
message:
type: string
code:
type: integer
events:
type: array
items:
$ref: '#/components/schemas/Event'
examples:
Example 1:
value:
message: OK
code: 0
events:
- id: 07b74776-6b04-435f-9ca3-4114c39b9826
start: '2023-02-13 00:00:00'
end: '2023-02-13 00:00:00'
title: Winterferien
description: ''
place: ''
is_holiday: true
- id: 6b793626-b890-48b9-8862-5f64031dd9a3
start: '2023-04-07 00:00:00'
end: '2023-04-07 00:00:00'
title: Osterferien
description: ''
place: ''
is_holiday: true
'204':
description: No Content
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'500':
description: Internal Server Error
operationId: get-pub-events
description: |-
This endpoint delivers all events that are in the studio's events calendar. These are mainly holidays, but can also include other dates. You can restrict the number of results by providing the optional »limit« parameter. You can also filter results by a string. The filter will apply to the »title« property. Use urlencoded filter string if it contains whitespaces or slashes.
## Parameters
### limit
An integer number that sets the maximum number of records to return.
### filter
A string. Records will be filtered by this string against the `title` field. You have to urlencode the string if it contains characters that will break the query string (e.g. whitespace). It's a goog idea to **always** urlencode the string.
security:
- APIKey1: []
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/filter'
/pub/courses:
get:
summary: Get all courses of the studio
tags:
- Public
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Course'
examples:
Example 1:
value:
- id: '14'
title: Fit für die Hochzeit
description: 'Crashkurs zum Bestehen des Hochzeitstanzes, keine Vorkenntnisse erforderlich'
hours: '1.00'
weekday: Dienstag
starttime: '18:30'
endtime: '19:30'
remark: ''
target_group: '4'
'204':
description: No Content
'401':
description: Unauthorized
'403':
description: Forbidden
'500':
description: Internal Server Error
operationId: get-pub-courses
description: Retrieve all courses (classes) that are currently offered by the studio with detail information. The value of the »description« data field depends on the studio's preference setting »Show description in course schedule?«.
security:
- APIKey1: []
/pub/nextcourses:
get:
summary: Get upcoming classes
tags:
- Public
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
x-examples:
Example 1:
- kuID: 5
shortname: Fit für die Hochzeit
title: Fit für die Hochzeit
description: ''
duration: 1
units: 4
schedules:
- - date: '2023-02-09 21:00:00.000000'
timezone_type: 3
timezone: Europe/Berlin
items:
$ref: '#/components/schemas/NextEvent'
examples:
Example 1:
value:
- kuID: 5
shortname: Fit für die Hochzeit
title: Fit für die Hochzeit
description: ''
duration: 1
units: 4
schedules:
- - date: '2023-02-09 21:00:00.000000'
timezone_type: 3
timezone: Europe/Berlin
- kuID: 9
shortname: Salsa Stufe 2
title: Salsa Aufbaukurs Stufe2
description: ''
duration: 1
units: 4
schedules:
- - date: '2023-02-03 19:00:00.000000'
timezone_type: 3
timezone: Europe/Berlin
- date: '2023-02-10 19:00:00.000000'
timezone_type: 3
timezone: Europe/Berlin
- - date: '2023-04-21 19:00:00.000000'
timezone_type: 3
timezone: Europe/Berlin
- date: '2023-04-28 19:00:00.000000'
timezone_type: 3
timezone: Europe/Berlin
'204':
description: No Content
'401':
description: Unauthorized
'403':
description: Forbidden
'500':
description: Internal Server Error
operationId: get-pub-nextcourses
description: Retrieve course list for courses that have a start date in the future (starting from today). Only for StudioIntern instances that run in "real calendar" mode (will return a 204 No Content header otherwise).
security:
- APIKey1: []
'/pub/schedule/{period}/{date}':
get:
summary: Get classes' schedule
tags:
- Public
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
x-examples:
Example 1:
message: OK
code: 0
events:
- id: 139
dow: Montag
dow_short: Mo
date: ''
start_time: '10:00:00'
end_time: '10:55:00'
title: Ballett Beginner B
description: keine/geringe VK
extra: 'Ballett für Erwachsene, Anfänger'
teacher:
- Yu-Ching
- Tsao
more_info: ''
room: Saal 1
hours: 1
color: '#e4d040'
- id: 123
dow: Montag
dow_short: Mo
date: ''
start_time: '11:00:00'
end_time: '11:55:00'
title: K+D E
description: keine VK
extra: Kraft+Dehnung
teacher:
- Yu-Ching
- Tsao
more_info: ''
room: Saal 1
hours: 1
color: '#e4d040'
properties:
message:
type: string
code:
type: integer
events:
type: array
items:
$ref: '#/components/schemas/CourseSchedule'
'204':
description: No Content
content:
application/json:
schema:
$ref: '#/components/schemas/Response'
'401':
description: Unauthorized
'403':
description: Forbidden
'417':
description: Expectation Failed
content:
application/json:
schema:
$ref: '#/components/schemas/Response'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Response'
operationId: get-pub-schedule
description: |-
Delivers the day or week schedule for all classes that will take place in the specific week. If no courses takes place in the specified period, the API will return a `204 No Content` response header.
## Parameters
### period
Can be one of these values: `today`, `week`, `weekofdate`. Defaults to `today`.
#### today
Get the schedule of the current day.
#### week
Get the schedule of the current week.
#### weekofdate
Get the schedule of the week in which the given date (next parameter) falls.
<!-- theme: warning -->
> #### Attention!
>
> This parameter is intended for the »real calendar« mode only in which StudioIntern is running. Since in »abstract week« mode every week has the same schedule, the `weekofdate` parameter makes no sense in this case. It will work, but the date is silently ignored.
### date
Date in »SQL format« `yyyy-mm-dd`. Example: `2023-02-20`. Other date formats will cause a 417 response code.
The given date will be ignored if the »period« parameter is not set to `weekofdate`. If the »period« parameter ist set to `weekofdate`and no date was given, the API will return a 417 response code.
security:
- APIKey1: []
parameters:
- name: period
in: path
schema:
type: string
description: '[today|weekday|weekofdate] default: today'
- name: date
in: path
schema:
type: string
description: 'Format: yyyy-mm-dd. Mandatory if parameter period ist set to »weekofdate«.'
/pub/studio:
get:
summary: Get information about the dance studio
tags:
- Public
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
message:
type: string
code:
type: integer
signature:
type: string
x-examples:
Example 1:
message: OK
code: 0
signature: "Tanzwerk Leipzig UG (haftungsbeschränkt)\r\nhttps://Leipziger-Ballettschule.de\r\nRosa-Luxemburg-Str. 21, 04103 Leipzig\r\nTel. 0341 - 24 33 66 36; Amtsgericht Leipzig, HRB 30795\r\nSitz der Gesellschaft: Leipzig, Geschäftsführer: Andreas Vent-Schmidt"
examples:
Example 1:
value:
message: OK
code: 0
signature: "Tanzwerk Leipzig UG (haftungsbeschränkt)\r\nhttps://Leipziger-Ballettschule.de\r\nRosa-Luxemburg-Str. 21, 04103 Leipzig\r\nTel. 0341 - 24 33 66 36; Amtsgericht Leipzig, HRB 30795\r\nSitz der Gesellschaft: Leipzig, Geschäftsführer: Andreas Vent-Schmidt"
'204':
description: No Content
'401':
description: Unauthorized
'403':
description: Forbidden
'500':
description: Internal Server Error
operationId: get-pub-studio
description: 'Returns some information about your studio. For now (version 1.0), there are no parameters available and only the mail signature is returned.'
security:
- APIKey1: []
/pub/user:
post:
summary: Create new user (studio's customer)
operationId: post-pub-user
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/Response'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Response'
'401':
description: Unauthorized
'403':
description: Forbidden
'417':
description: Expectation Failed
content:
application/json:
schema:
$ref: '#/components/schemas/Response'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Response'
tags:
- Public
description: |-
This endpoint creates a new end customer (user). Please don't mix up with StudioIntern's customer.
The intention of this endpoint is to send data from contact forms on the public studio's website where people fill in the form in order to ask for a test class.
Many of the StudioIntern's [extra modules](https://www.ballettschul-software.de/zusatzmodule.php) use this endpoint, too.
security:
- APIKey1: []
requestBody:
content:
application/json:
schema:
type: object
properties:
anrede:
type: string
minLength: 2
maxLength: 12
description: Salutation
titel:
type: string
maxLength: 120
description: Academic title
vorname:
type: string
maxLength: 64
description: First name
nachname:
type: string
maxLength: 48
description: 'Last '
adresse:
type: string
maxLength: 64
description: Address (Street + Number)
adresszusatz:
type: string
maxLength: 64
description: Additional address information
plz:
type: string
maxLength: 8
description: ZIP code
ort:
type: string
maxLength: 64
description: City / Place
mobil:
type: string
maxLength: 64
description: Mobile phone number
email:
type: string
maxLength: 120
description: Email a
bemerkungen:
type: string
description: Remarks
sch_vorname:
type: array
description: 'Students (children''s) first '
items:
type: string
maxLength: 64
sch_nachname:
type: array
description: Students (children's) last name
items:
type: string
maxLength: 48
sch_geb_tag:
type: array
description: 'Students (children''s) date of birth, day as 2-digit number'
deprecated: true
items:
type: string
minLength: 2
maxLength: 2
deprecated: true
sch_geb_monat:
type: array
description: 'Students (children''s) date of birth, month as 2-digit number'
deprecated: true
items:
type: string
minLength: 2
maxLength: 2
deprecated: true
sch_geb_jahr:
type: array
description: 'Students (children''s) date of birth, year as 4-digit number'
deprecated: true
items:
type: string
minLength: 4
maxLength: 4
deprecated: true
sch_geb:
format: date
description: 'Students (children''s) date of birth, different formats possible'
type: array
example: 14.01.2010 | 2010-01-14 | 14/01/2010
items:
type: string
example: 14.02.2010 | 2010-02-14 | 14/10/2010 | 20100214
minLength: 8
maxLength: 10
notify:
type: integer
minimum: 0
maximum: 1
description: 'If set to »1«, the studio will receive a message when new user was created'
notify_error:
type: integer
minimum: 0
maximum: 1
description: 'If set to »1«, the studio will receive a message in case of an error'
customer_message:
type: string
description: Additonal message that will be stored in the »remarks« filed of the customer's recoord.
required:
- anrede
- vorname
- nachname
- email
description: |-
## General usage
This endpoint is intented to receive data from an online contact form. You must name the form fields exactly as described here. Though in this API documentation all fields are part of an anonymous object, in real world you will not send an object but just regular POST data. Example:
`anrede=Herr&vorname=Max&nachname=Mustermann&[email protected]`
<!-- theme: warning -->
> #### Watch Out!
>
> These data describe a end-user (a studio's customer), not a StudioIntern customer.
## Student's data
You can also send student data to this endpoint. In most cases, these are the children of a customer. But, since StudioIntern distincts between customers and students, **every** student must be sent. So, in case an adult customer is the student, too, you must send his data also in the `sch_*` fields.
To stay with the above example: If Max Mustermann wants to take part in classes for himself, you must send data like this:
`anrede=Herr&vorname=Max&nachname=Mustermann&[email protected]&sch_vorname[0]=Max&sch_nachname[0]=Mustermann&sch_geb[0]=1998-08-30`
As the example shows, you must provide student's data in an array. This way you can send multiple students at once. But, you can also create more students with separate calls.
So if Max Mustermann's daughter Susane will also join a class, you could call the API again with this post data:
`anrede=Herr&vorname=Max&nachname=Mustermann&[email protected]&sch_vorname[0]=Susan&sch_nachname[0]=Mustermann&sch_geb[0]=2018-06-01`
<!-- theme: info -->
> ### Non-destructive endpoint!
>
> The API will **never** delete or overwrite existing data.
parameters: []
components:
schemas:
User:
type: object
x-examples:
Example 1:
id: '50066'
firstName: Barbara
lastName: Aachen
email: [email protected]
active: true
examples:
- id: 99
firstName: Monika
lastName: Muster
email: [email protected]
students:
- id: '42'
firstName: Mia
lastName: Muster
dayOfBirth: '2016-08-13'
email: [email protected]
active: true
properties:
id:
type: integer
description: The customers public number. This is not the internal database ID!
firstName:
type: string
lastName:
type: string
email:
type: string
students:
type: array
items:
$ref: '#/components/schemas/Student'
active:
type: boolean
description: True if the customer's state is »customer«
Student:
type: object
x-examples:
Example 1:
id: '241'
firstName: Krawehl
lastName: Aachen
dayOfBirth: '1998-03-12'
email: ''
examples:
- id: '42'
firstName: Mia
lastName: Muster
dayOfBirth: '2016-08-13'
email: [email protected]
properties:
id:
type: integer
description: The internal database ID of the student
firstName:
type: string
lastName:
type: string
dayOfBirth:
type: string
email:
type: string
Response:
type: object
properties:
message:
type: string
code:
type: integer
x-examples:
Example 1:
message: Password updated
code: 0
examples:
- message: OK
code: 0
Course:
type: object
x-examples:
Example 1:
id: '14'
title: Fit für die Hochzeit
description: ''
hours: '1.00'
weekday: Dienstag
starttime: '18:30'
endtime: '19:30'
remark: ''
target_group: '4'
examples:
- id: '14'
title: Fit für die Hochzeit
description: 'Crashkurs zum Bestehen des Hochzeitstanzes, keine Vorkenntnisse erforderlich'
hours: '1.00'
weekday: Dienstag
starttime: '18:30'
endtime: '19:30'
remark: ''
target_group: '4'
properties:
id:
type: integer
description: 'Internal database id (unique, of course)'
title:
type: string
description: The shortname of the course
description:
type: string
description: 'If »Show description field in schedule« is set to »true«: description, otherwise: course title'
hours:
type: number
description: 'Duration of the course. For instance, »1.50« means 1 hour and 30 minutes.'
weekday:
type: string
description: 'Day of week (name, localized)'
starttime:
type: string
description: 'Start time, format: HH:mm'
endtime:
type: string
description: 'End time, format: HH:mm'
remark:
type: string
target_group:
type: integer
description: 'Binary value: 1: Children, 2: Teenagers, 4: Adults'
Event:
type: object
x-examples:
Example 1:
id: 07b74776-6b04-435f-9ca3-4114c39b9826
start: '2023-02-13 00:00:00'
end: '2023-02-13 00:00:00'
title: Winterferien
description: ''
place: ''
is_holiday: '1'
examples:
- id: 07b74776-6b04-435f-9ca3-4114c39b9826
start: '2023-02-13 00:00:00'
end: '2023-02-13 00:00:00'
title: Winterferien
description: ''
place: ''
is_holiday: true
properties:
id:
type: string