-
Notifications
You must be signed in to change notification settings - Fork 5
Expand file tree
/
Copy pathopenapi.yaml
More file actions
1896 lines (1896 loc) · 64 KB
/
openapi.yaml
File metadata and controls
1896 lines (1896 loc) · 64 KB
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.1"
info:
title: "Deutscher Bundestag - DIP"
description: "API des Dokumentations- und Informationssystems für Parlamentsmaterialien"
version: "1.2"
termsOfService: "https://dip.bundestag.de/%C3%BCber-dip/nutzungsbedingungen"
contact:
name: "Auskunfts- und Rechercheservice der Parlamentsdokumentation"
email: "parlamentsdokumentation@bundestag.de"
servers:
- url: "https://search.dip.bundestag.de/api/v1"
security:
- ApiKeyHeader: []
- ApiKeyQuery: []
paths:
/vorgang:
get:
tags:
- "Vorgänge"
operationId: "getVorgangList"
summary: "Liefert eine Liste von Metadaten zu Vorgängen"
parameters:
- $ref: "#/components/parameters/DatumStartFilter"
- $ref: "#/components/parameters/DatumEndFilter"
- $ref: "#/components/parameters/AktualisiertStartFilter"
- $ref: "#/components/parameters/AktualisiertEndFilter"
- $ref: "#/components/parameters/WahlperiodeFilter"
- $ref: "#/components/parameters/DrucksacheFilter"
- $ref: "#/components/parameters/IdFilter"
- $ref: "#/components/parameters/PlenarprotokollFilter"
- $ref: "#/components/parameters/DokumentartFilter"
- $ref: "#/components/parameters/DokumentnummerFilter"
- $ref: "#/components/parameters/DrucksachtypFilter"
- $ref: "#/components/parameters/FrageNummerFilter"
- $ref: "#/components/parameters/GestaFilter"
- $ref: "#/components/parameters/Format"
- $ref: "#/components/parameters/Cursor"
responses:
"200":
description: "Liste von Metadaten zu Vorgängen"
content:
application/json:
schema:
$ref: "#/components/schemas/VorgangListResponse"
application/xml:
schema:
$ref: "#/components/schemas/VorgangListResponse"
"400":
$ref: "#/components/responses/BadRequestResponse"
"401":
$ref: "#/components/responses/UnauthorizedResponse"
/vorgang/{id}:
get:
tags:
- "Vorgänge"
operationId: "getVorgang"
summary: "Liefert Metadaten zu einem Vorgang"
parameters:
- $ref: "#/components/parameters/Id"
- $ref: "#/components/parameters/Format"
responses:
"200":
description: "Metadaten eines Vorgangs"
content:
application/json:
schema:
$ref: "#/components/schemas/Vorgang"
application/xml:
schema:
$ref: "#/components/schemas/Vorgang"
"401":
$ref: "#/components/responses/UnauthorizedResponse"
"404":
$ref: "#/components/responses/NotFoundResponse"
/vorgangsposition:
get:
tags:
- "Vorgangspositionen"
operationId: "getVorgangspositionList"
summary: "Liefert eine Liste von Metadaten zu Vorgangspositionen"
parameters:
- $ref: "#/components/parameters/AktualisiertStartFilter"
- $ref: "#/components/parameters/AktualisiertEndFilter"
- $ref: "#/components/parameters/AktivitaetFilter"
- $ref: "#/components/parameters/DatumStartFilter"
- $ref: "#/components/parameters/DatumEndFilter"
- $ref: "#/components/parameters/WahlperiodeFilter"
- $ref: "#/components/parameters/DrucksacheFilter"
- $ref: "#/components/parameters/IdFilter"
- $ref: "#/components/parameters/PlenarprotokollFilter"
- $ref: "#/components/parameters/VorgangFilter"
- $ref: "#/components/parameters/DokumentartFilter"
- $ref: "#/components/parameters/DokumentnummerFilter"
- $ref: "#/components/parameters/DrucksachtypFilter"
- $ref: "#/components/parameters/FrageNummerFilter"
- $ref: "#/components/parameters/ZuordnungFilter"
- $ref: "#/components/parameters/Format"
- $ref: "#/components/parameters/Cursor"
responses:
"200":
description: "Metadaten zu Vorgangspositionen"
content:
application/json:
schema:
$ref: "#/components/schemas/VorgangspositionListResponse"
application/xml:
schema:
$ref: "#/components/schemas/VorgangspositionListResponse"
"400":
$ref: "#/components/responses/BadRequestResponse"
"401":
$ref: "#/components/responses/UnauthorizedResponse"
/vorgangsposition/{id}:
get:
tags:
- "Vorgangspositionen"
operationId: "getVorgangsposition"
summary: "Liefert Metadaten zu einer Vorgangsposition"
parameters:
- $ref: "#/components/parameters/Id"
- $ref: "#/components/parameters/Format"
responses:
"200":
description: "Metadaten einer Vorgangsposition"
content:
application/json:
schema:
$ref: "#/components/schemas/Vorgangsposition"
application/xml:
schema:
$ref: "#/components/schemas/Vorgangsposition"
"401":
$ref: "#/components/responses/UnauthorizedResponse"
"404":
$ref: "#/components/responses/NotFoundResponse"
/drucksache:
get:
tags:
- "Drucksachen"
operationId: "getDrucksacheList"
summary: "Liefert eine Liste von Metadaten zu Drucksachen"
parameters:
- $ref: "#/components/parameters/AktualisiertStartFilter"
- $ref: "#/components/parameters/AktualisiertEndFilter"
- $ref: "#/components/parameters/DatumStartFilter"
- $ref: "#/components/parameters/DatumEndFilter"
- $ref: "#/components/parameters/WahlperiodeFilter"
- $ref: "#/components/parameters/IdFilter"
- $ref: "#/components/parameters/DokumentnummerFilter"
- $ref: "#/components/parameters/DrucksachtypFilter"
- $ref: "#/components/parameters/ZuordnungFilter"
- $ref: "#/components/parameters/Format"
- $ref: "#/components/parameters/Cursor"
responses:
"200":
description: "Metadaten zu Drucksachen"
content:
application/json:
schema:
$ref: "#/components/schemas/DrucksacheListResponse"
application/xml:
schema:
$ref: "#/components/schemas/DrucksacheListResponse"
"400":
$ref: "#/components/responses/BadRequestResponse"
"401":
$ref: "#/components/responses/UnauthorizedResponse"
/drucksache/{id}:
get:
tags:
- "Drucksachen"
operationId: "getDrucksache"
summary: "Liefert Metadaten zu einer Drucksache"
parameters:
- $ref: "#/components/parameters/Id"
- $ref: "#/components/parameters/Format"
responses:
"200":
description: "Metadaten einer Drucksache"
content:
application/json:
schema:
$ref: "#/components/schemas/Drucksache"
application/xml:
schema:
$ref: "#/components/schemas/Drucksache"
"401":
$ref: "#/components/responses/UnauthorizedResponse"
"404":
$ref: "#/components/responses/NotFoundResponse"
/drucksache-text:
get:
tags:
- "Drucksachen"
operationId: "getDrucksacheTextList"
summary: "Liefert eine Liste von Volltexten und Metadaten zu Drucksachen"
parameters:
- $ref: "#/components/parameters/AktualisiertStartFilter"
- $ref: "#/components/parameters/AktualisiertEndFilter"
- $ref: "#/components/parameters/DatumStartFilter"
- $ref: "#/components/parameters/DatumEndFilter"
- $ref: "#/components/parameters/WahlperiodeFilter"
- $ref: "#/components/parameters/IdFilter"
- $ref: "#/components/parameters/DokumentnummerFilter"
- $ref: "#/components/parameters/DrucksachtypFilter"
- $ref: "#/components/parameters/ZuordnungFilter"
- $ref: "#/components/parameters/Format"
- $ref: "#/components/parameters/Cursor"
responses:
"200":
description: "Volltext und Metadaten zu Drucksachen"
content:
application/json:
schema:
$ref: "#/components/schemas/DrucksacheTextListResponse"
application/xml:
schema:
$ref: "#/components/schemas/DrucksacheTextListResponse"
"400":
$ref: "#/components/responses/BadRequestResponse"
"401":
$ref: "#/components/responses/UnauthorizedResponse"
/drucksache-text/{id}:
get:
tags:
- "Drucksachen"
operationId: "getDrucksacheText"
summary: "Liefert Volltext und Metadaten zu einer Drucksache"
parameters:
- $ref: "#/components/parameters/Id"
- $ref: "#/components/parameters/Format"
responses:
"200":
description: "Volltext und Metadaten einer Drucksache"
content:
application/json:
schema:
$ref: "#/components/schemas/DrucksacheText"
application/xml:
schema:
$ref: "#/components/schemas/DrucksacheText"
"401":
$ref: "#/components/responses/UnauthorizedResponse"
"404":
$ref: "#/components/responses/NotFoundResponse"
/plenarprotokoll:
get:
tags:
- "Plenarprotokolle"
operationId: "getPlenarprotokollList"
summary: "Liefert eine Liste von Metadaten zu Plenarprotokollen"
parameters:
- $ref: "#/components/parameters/AktualisiertStartFilter"
- $ref: "#/components/parameters/AktualisiertEndFilter"
- $ref: "#/components/parameters/DatumStartFilter"
- $ref: "#/components/parameters/DatumEndFilter"
- $ref: "#/components/parameters/WahlperiodeFilter"
- $ref: "#/components/parameters/IdFilter"
- $ref: "#/components/parameters/DokumentnummerFilter"
- $ref: "#/components/parameters/ZuordnungFilter"
- $ref: "#/components/parameters/Format"
- $ref: "#/components/parameters/Cursor"
responses:
"200":
description: "Metadaten zu Plenarprotokollen"
content:
application/json:
schema:
$ref: "#/components/schemas/PlenarprotokollListResponse"
application/xml:
schema:
$ref: "#/components/schemas/PlenarprotokollListResponse"
"400":
$ref: "#/components/responses/BadRequestResponse"
"401":
$ref: "#/components/responses/UnauthorizedResponse"
/plenarprotokoll/{id}:
get:
tags:
- "Plenarprotokolle"
operationId: "getPlenarprotokoll"
summary: "Liefert Metadaten zu einem Plenarprotokoll"
parameters:
- $ref: "#/components/parameters/Id"
- $ref: "#/components/parameters/Format"
responses:
"200":
description: "Metadaten eines Plenarprotokolls"
content:
application/json:
schema:
$ref: "#/components/schemas/Plenarprotokoll"
application/xml:
schema:
$ref: "#/components/schemas/Plenarprotokoll"
"401":
$ref: "#/components/responses/UnauthorizedResponse"
"404":
$ref: "#/components/responses/NotFoundResponse"
/plenarprotokoll-text:
get:
tags:
- "Plenarprotokolle"
operationId: "getPlenarprotokollTextList"
summary: "Liefert eine Liste von Volltexten und Metadaten zu Plenarprotokollen"
parameters:
- $ref: "#/components/parameters/AktualisiertStartFilter"
- $ref: "#/components/parameters/AktualisiertEndFilter"
- $ref: "#/components/parameters/DatumStartFilter"
- $ref: "#/components/parameters/DatumEndFilter"
- $ref: "#/components/parameters/WahlperiodeFilter"
- $ref: "#/components/parameters/IdFilter"
- $ref: "#/components/parameters/DokumentnummerFilter"
- $ref: "#/components/parameters/ZuordnungFilter"
- $ref: "#/components/parameters/Format"
- $ref: "#/components/parameters/Cursor"
responses:
"200":
description: "Volltext und Metadaten zu Plenarprotokollen"
content:
application/json:
schema:
$ref: "#/components/schemas/PlenarprotokollTextListResponse"
application/xml:
schema:
$ref: "#/components/schemas/PlenarprotokollTextListResponse"
"400":
$ref: "#/components/responses/BadRequestResponse"
"401":
$ref: "#/components/responses/UnauthorizedResponse"
/plenarprotokoll-text/{id}:
get:
tags:
- "Plenarprotokolle"
operationId: "getPlenarprotokollText"
summary: "Liefert Volltext und Metadaten zu einem Plenarprotokoll"
parameters:
- $ref: "#/components/parameters/Id"
- $ref: "#/components/parameters/Format"
responses:
"200":
description: "Volltext und Metadaten eines Plenarprotokolls"
content:
application/json:
schema:
$ref: "#/components/schemas/PlenarprotokollText"
application/xml:
schema:
$ref: "#/components/schemas/PlenarprotokollText"
"401":
$ref: "#/components/responses/UnauthorizedResponse"
"404":
$ref: "#/components/responses/NotFoundResponse"
/aktivitaet:
get:
tags:
- "Aktivitäten"
operationId: "getAktivitaetList"
summary: "Liefert eine Liste von Metadaten zu Aktivitäten"
parameters:
- $ref: "#/components/parameters/AktualisiertStartFilter"
- $ref: "#/components/parameters/AktualisiertEndFilter"
- $ref: "#/components/parameters/DatumStartFilter"
- $ref: "#/components/parameters/DatumEndFilter"
- $ref: "#/components/parameters/WahlperiodeFilter"
- $ref: "#/components/parameters/DrucksacheFilter"
- $ref: "#/components/parameters/IdFilter"
- $ref: "#/components/parameters/PlenarprotokollFilter"
- $ref: "#/components/parameters/DokumentartFilter"
- $ref: "#/components/parameters/DokumentnummerFilter"
- $ref: "#/components/parameters/DrucksachtypFilter"
- $ref: "#/components/parameters/FrageNummerFilter"
- $ref: "#/components/parameters/ZuordnungFilter"
- $ref: "#/components/parameters/Format"
- $ref: "#/components/parameters/Cursor"
responses:
"200":
description: "Metadaten zu Aktivitäten"
content:
application/json:
schema:
$ref: "#/components/schemas/AktivitaetListResponse"
application/xml:
schema:
$ref: "#/components/schemas/AktivitaetListResponse"
"400":
$ref: "#/components/responses/BadRequestResponse"
"401":
$ref: "#/components/responses/UnauthorizedResponse"
/aktivitaet/{id}:
get:
tags:
- "Aktivitäten"
operationId: "getAktivitaet"
summary: "Liefert Metadaten zu einer Aktivität"
parameters:
- $ref: "#/components/parameters/Id"
- $ref: "#/components/parameters/Format"
responses:
"200":
description: "Metadaten einer Aktivität"
content:
application/json:
schema:
$ref: "#/components/schemas/Aktivitaet"
application/xml:
schema:
$ref: "#/components/schemas/Aktivitaet"
"401":
$ref: "#/components/responses/UnauthorizedResponse"
"404":
$ref: "#/components/responses/NotFoundResponse"
/person:
get:
tags:
- "Personenstammdaten"
operationId: "getPersonList"
summary: "Liefert eine Liste von Personenstammdaten"
parameters:
- $ref: "#/components/parameters/AktualisiertStartFilter"
- $ref: "#/components/parameters/AktualisiertEndFilter"
- $ref: "#/components/parameters/DatumStartFilter"
- $ref: "#/components/parameters/DatumEndFilter"
- $ref: "#/components/parameters/WahlperiodeFilter"
- $ref: "#/components/parameters/IdFilter"
- $ref: "#/components/parameters/Format"
- $ref: "#/components/parameters/Cursor"
responses:
"200":
description: "Personenstammdaten"
content:
application/json:
schema:
$ref: "#/components/schemas/PersonListResponse"
application/xml:
schema:
$ref: "#/components/schemas/PersonListResponse"
"400":
$ref: "#/components/responses/BadRequestResponse"
"401":
$ref: "#/components/responses/UnauthorizedResponse"
/person/{id}:
get:
tags:
- "Personenstammdaten"
operationId: "getPerson"
summary: "Liefert Personenstammdaten zu einer Person"
parameters:
- $ref: "#/components/parameters/Id"
- $ref: "#/components/parameters/Format"
responses:
"200":
description: "Personenstammdaten"
content:
application/json:
schema:
$ref: "#/components/schemas/Person"
application/xml:
schema:
$ref: "#/components/schemas/Person"
"401":
$ref: "#/components/responses/UnauthorizedResponse"
"404":
$ref: "#/components/responses/NotFoundResponse"
components:
securitySchemes:
ApiKeyHeader:
type: "apiKey"
in: "header"
name: "Authorization"
description: "Beispiel: *ApiKey rgsaY4U.oZRQKUHdJhF9qguHMkwCGIoLaqEcaHjYLF*\n"
ApiKeyQuery:
type: "apiKey"
in: "query"
name: "apikey"
description: "Beispiel: *rgsaY4U.oZRQKUHdJhF9qguHMkwCGIoLaqEcaHjYLF*\n"
parameters:
Id:
name: "id"
in: "path"
required: true
schema:
type: "integer"
example: 1
AktivitaetFilter:
name: "f.aktivitaet"
in: "query"
schema:
type: "integer"
description: "ID einer verknüpften Aktivität\n\nSelektiert alle Entitäten, die\
\ mit der angegebenen Aktivität verknüpft sind.\n"
DatumStartFilter:
name: "f.datum.start"
in: "query"
schema:
$ref: "#/components/schemas/Datum"
description: "Frühestes Datum der Entität\n\nSelektiert Entitäten in einem Datumsbereich\
\ basierend auf dem Dokumentdatum. Für Vorgänge und Personen wird der Datumsbereich\
\ aller zugehörigen Dokumente herangezogen.\n"
example: "2021-01-11"
DatumEndFilter:
name: "f.datum.end"
in: "query"
schema:
$ref: "#/components/schemas/Datum"
description: "Spätestes Datum der Entität\n\nSelektiert Entitäten in einem Datumsbereich\
\ basierend auf dem Dokumentdatum. Für Vorgänge und Personen wird der Datumsbereich\
\ aller zugehörigen Dokumente herangezogen.\n"
example: "2021-01-15"
AktualisiertStartFilter:
name: "f.aktualisiert.start"
in: "query"
schema:
type: "string"
format: "date-time"
description: "Frühestes Aktualisierungsdatum der Entität\n\nSelektiert Entitä\
ten in einem Datumsbereich basierend auf dem letzten Aktualisierungsdatum.\n"
example: "2022-06-01T15:00:00+02:00"
AktualisiertEndFilter:
name: "f.aktualisiert.end"
in: "query"
schema:
type: "string"
format: "date-time"
description: "Spätestes Aktualisierungsdatum der Entität\n\nSelektiert Entitä\
ten in einem Datumsbereich basierend auf dem letzten Aktualisierungsdatum.\n"
WahlperiodeFilter:
name: "f.wahlperiode"
in: "query"
schema:
type: "integer"
description: "Nummer der Wahlperiode\n\nSelektiert alle Entitäten, die der angegebenen\
\ Wahlperiode zugeordnet sind.\nKann wiederholt werden, um mehrere Wahlperioden\
\ zu selektieren.\n"
DrucksacheFilter:
name: "f.drucksache"
in: "query"
schema:
type: "integer"
description: "ID einer verknüpften Drucksache\n\nSelektiert alle Entitäten,\
\ die mit der angegebenen Drucksache verknüpft sind.\n"
IdFilter:
name: "f.id"
in: "query"
schema:
type: "integer"
description: "ID der Entität\n\nKann wiederholt werden, um mehrere Entitäten\
\ zu selektieren.\n"
PlenarprotokollFilter:
name: "f.plenarprotokoll"
in: "query"
schema:
type: "integer"
description: "ID eines verknüpften Plenarprotokolls\n\nSelektiert alle Entitä\
ten, die mit dem angegebenen Plenarprotokoll verknüpft sind.\n"
VorgangFilter:
name: "f.vorgang"
in: "query"
schema:
type: "integer"
description: "ID eines verknüpften Vorgangs\n\nSelektiert alle Entitäten, die\
\ mit dem angegebenen Vorgang verknüpft sind.\n"
DokumentnummerFilter:
name: "f.dokumentnummer"
in: "query"
schema:
type: "string"
description: "Dokumentnummer einer Drucksache oder eines Plenarprotokolls\n\n\
Selektiert alle Entitäten, die mit der angegebenen Dokumentnummer verknüpft\
\ sind.\nKann wiederholt werden, um mehrere Dokumentnummern zu selektieren.\n"
DokumentartFilter:
name: "f.dokumentart"
in: "query"
schema:
type: "string"
enum:
- "Drucksache"
- "Plenarprotokoll"
description: "Drucksache oder Plenarprotokoll\n\nSelektiert alle Entitäten,\
\ die mit der angegebenen Dokumentart verknüpft sind.\n"
DrucksachtypFilter:
name: "f.drucksachetyp"
in: "query"
schema:
type: "string"
description: "Typ der Drucksache\n\nSelektiert alle Entitäten, die mit dem angegebenen\
\ Drucksachetyp verknüpft sind.\n"
FrageNummerFilter:
name: "f.frage_nummer"
in: "query"
schema:
type: "string"
description: "Fragenummer/Listenziffer\n\nSelektiert alle Entitäten, die mit\
\ der angegebenen Fragenummer in einer Drucksache verknüpft sind.\nKann wiederholt\
\ werden, um mehrere Fragenummern zu selektieren.\n"
GestaFilter:
name: "f.gesta"
in: "query"
schema:
type: "string"
description: "GESTA-Ordnungsnummer\n\nSelektiert alle Entitäten, die der angegebenen\
\ GESTA-Ordnungsnummer zugeordnet sind.\nKann wiederholt werden, um mehrere\
\ Ordnungsnummern zu selektieren.\n"
ZuordnungFilter:
name: "f.zuordnung"
in: "query"
schema:
$ref: "#/components/schemas/Zuordnung"
description: "Zuordnung der Entität zum Bundestag, Bundesrat, Bundesversammlung\
\ oder Europakammer"
Format:
name: "format"
in: "query"
schema:
type: "string"
enum:
- "json"
- "xml"
default: "json"
description: "Steuert das Datenformat der Antwort, möglich sind JSON (voreingestellt)\
\ oder XML."
Cursor:
name: "cursor"
in: "query"
schema:
type: "string"
description: "Position des Cursors zur Anfrage weiterer Entitäten\n\nÜbersteigt\
\ die Anzahl der gefundenen Entitäten das jeweilige Limit, muss eine Folgeanfrage\
\ gestellt werden, um weitere Entitäten zu laden.\nEine Folgeanfrage wird\
\ gebildet, indem alle Parameter der ursprünglichen Anfrage wiederholt werden\
\ und zusätzlich der cursor Parameter der letzten Antwort eingesetzt wird.\n\
Es können solange Folgeanfragen gestellt werden, bis sich der cursor nicht\
\ mehr ändert. Dies signalisiert, dass alle Entitäten geladen wurden.\n"
responses:
BadRequestResponse:
description: "Syntaxfehler in einem der Anfrageparameter"
content:
application/json:
schema:
type: "object"
properties:
code:
type: "integer"
enum:
- 400
message:
type: "string"
example: "Invalid cursor"
required:
- "code"
- "message"
UnauthorizedResponse:
description: "Ein gültiger API-Key ist für alle Anfragen erforderlich. Dieser\
\ kann entweder im HTTP Authorization Header oder als Anfrageparameter apikey\
\ gesendet werden."
content:
application/json:
schema:
type: "object"
properties:
code:
type: "integer"
enum:
- 401
message:
type: "string"
enum:
- "An API key is required to access this service. Please refer to\
\ https://dip.bundestag.de/über-dip/hilfe/api how to apply for a\
\ key. Misuse of this service may lead to blocking your requests."
required:
- "code"
- "message"
NotFoundResponse:
description: "Die angefragte Entität wurde nicht gefunden"
content:
application/json:
schema:
type: "object"
properties:
code:
type: "integer"
enum:
- 404
message:
type: "string"
example: "ID not found: 0"
required:
- "code"
- "message"
schemas:
ListResponseBase:
type: "object"
xml:
name: "response"
properties:
numFound:
type: "integer"
format: "int32"
example: 176
cursor:
type: "string"
example: "AoJwgNjC_PYCMURydWNrc2FjaGUtMjQ5MjYw"
required:
- "numFound"
- "cursor"
VorgangListResponse:
allOf:
- $ref: "#/components/schemas/ListResponseBase"
- type: "object"
properties:
documents:
type: "array"
items:
$ref: "#/components/schemas/Vorgang"
minItems: 0
maxItems: 100
required:
- "documents"
VorgangspositionListResponse:
allOf:
- $ref: "#/components/schemas/ListResponseBase"
- type: "object"
properties:
documents:
type: "array"
items:
$ref: "#/components/schemas/Vorgangsposition"
minItems: 0
maxItems: 100
required:
- "documents"
PlenarprotokollListResponse:
allOf:
- $ref: "#/components/schemas/ListResponseBase"
- type: "object"
properties:
documents:
type: "array"
items:
$ref: "#/components/schemas/Plenarprotokoll"
minItems: 0
maxItems: 100
required:
- "documents"
DrucksacheListResponse:
allOf:
- $ref: "#/components/schemas/ListResponseBase"
- type: "object"
properties:
documents:
type: "array"
items:
$ref: "#/components/schemas/Drucksache"
minItems: 0
maxItems: 100
required:
- "documents"
PlenarprotokollTextListResponse:
allOf:
- $ref: "#/components/schemas/ListResponseBase"
- type: "object"
properties:
documents:
type: "array"
items:
$ref: "#/components/schemas/PlenarprotokollText"
minItems: 0
maxItems: 10
required:
- "documents"
DrucksacheTextListResponse:
allOf:
- $ref: "#/components/schemas/ListResponseBase"
- type: "object"
properties:
documents:
type: "array"
items:
$ref: "#/components/schemas/DrucksacheText"
minItems: 0
maxItems: 10
required:
- "documents"
AktivitaetListResponse:
allOf:
- $ref: "#/components/schemas/ListResponseBase"
- type: "object"
properties:
documents:
type: "array"
items:
$ref: "#/components/schemas/Aktivitaet"
minItems: 0
maxItems: 100
required:
- "documents"
PersonListResponse:
allOf:
- $ref: "#/components/schemas/ListResponseBase"
- type: "object"
properties:
documents:
type: "array"
items:
$ref: "#/components/schemas/Person"
minItems: 0
maxItems: 100
required:
- "documents"
Vorgang:
description: "Liefert Metadaten zu einem Vorgang."
type: "object"
xml:
name: "document"
properties:
id:
type: "string"
pattern: "^\\d+$"
example: "84343"
typ:
type: "string"
enum:
- "Vorgang"
example: "Vorgang"
beratungsstand:
type: "string"
example: "Abgeschlossen"
vorgangstyp:
type: "string"
example: "Geschäftsordnung"
wahlperiode:
type: "integer"
format: "int32"
example: 19
initiative:
type: "array"
items:
type: "string"
example: "Fraktion der CDU/CSU"
datum:
type: "string"
format: "date"
example: "2019-03-27"
description: "Datierung des letzten zugehörigen Dokuments"
aktualisiert:
type: "string"
format: "date-time"
example: "2022-08-01T15:30:16+02:00"
description: "Letzte Aktualisierung der Entität"
titel:
type: "string"
example: "Weitergeltung von Geschäftsordnungsrecht"
abstract:
type: "string"
example: "Übernahme von Geschäftsordnungen durch den 19. Deutschen Bundestag:\
\ Geschäftsordnung des Deutschen Bundestages, Gemeinsame Geschäftsordnung\
\ für den Vermittlungsausschuss, Geschäftsordnung für den Gemeinsamen\
\ Ausschuss, Geschäftsordnung für das Verfahren nach Art. 115d GG, Richtlinien\
\ zur Überprüfung auf eine Stasi-Tätigkeit"
sachgebiet:
type: "array"
items:
type: "string"
example: "Bundestag"
deskriptor:
type: "array"
items:
$ref: "#/components/schemas/VorgangDeskriptor"
gesta:
type: "string"
example: "B101"
description: "GESTA-Ordnungsnummer"
zustimmungsbeduerftigkeit:
type: "array"
items:
type: "string"
example: "Nein, laut Verkündung (BGBl I)"
kom:
type: "string"
example: "(2017) 600 endg."
description: "KOM-Nr."
ratsdok:
type: "string"
example: "11018/17"
description: "Ratsdok-Nr."
verkuendung:
type: "array"
items:
$ref: "#/components/schemas/Verkuendung"
inkrafttreten:
type: "array"
items:
$ref: "#/components/schemas/Inkrafttreten"
archiv:
type: "string"
example: "XIX/288"
description: "Archivsignatur"
mitteilung:
type: "string"
example: "Tag des Inkrafttretens bestimmter Teile des Gesetzes wird durch\
\ das BMI im BGBl bekanntgemacht, weiteres siehe im BGBl"
vorgang_verlinkung:
type: "array"
items:
$ref: "#/components/schemas/VorgangVerlinkung"
sek:
type: "string"
example: "(2010) 305 endg."
description: "SEK-Nr."
required:
- "id"
- "typ"
- "vorgangstyp"
- "wahlperiode"
- "aktualisiert"
- "titel"
Vorgangsposition:
description: "Liefert Metadaten zu einer Vorgangsposition (Vorgangsschritt)."
type: "object"
xml:
name: "document"
properties:
id:
type: "string"
pattern: "^\\d+$"
example: "173376"
vorgangsposition:
type: "string"
example: "Antrag zur Weitergeltung der Geschäftsordnung"
zuordnung:
$ref: "#/components/schemas/Zuordnung"
gang:
type: "boolean"
description: "Alle Vorgangsschritte, die von besonderer Bedeutung für den\
\ Fortgang der Beratung sind, werden durch das Attribut `gang: true` gekennzeichnet.\n\
\nIst ein solcher Vorgangsschritt mit einer Drucksache verknüpft, werden\
\ im Frontend unter der Benennung \"Wichtige Drucksachen\" Herausgeber,\
\ Nummer und Typ sowie das Datum der entsprechenden Drucksachen ausgegeben\
\ (z.B. BT-Drs 18/13014 (Beschlussempfehlung), 28.06.2017). \nIst er mit\
\ einem Plenarprotokoll verknüpft, werden im Frontend unter der Benennung\
\ \"Plenum\" der Klartext der Vorgangsposition, Datum, Herausgeber und\
\ Nummer des Plenarprotokolls mit Anfangsseite/Quadrant und Endseite/Quadrant\
\ dargestellt (z.B. 2. Beratung: 29.06.2017, BT-PlPr 18/243, S. 24964C\
\ - 24973C).\n"
fortsetzung:
type: "boolean"
description: "Erstreckt sich eine Beratung über mehrere Plenarprotokolle,\
\ so müssen entsprechend viele Vorgangsschritte mit je gleicher Vorgangsposition\
\ im Vorgangsablauf angelegt werden. Der zweite und jeder weitere dieser\
\ Schritte wird dann als \"Fortsetzung\" gekennzeichnet (Attribut `fortsetzung:\
\ true`). \nFür die Beratung des Gesetzentwurfs für die Feststellung des\
\ Haushaltsplanes (Haushaltsberatungen) gelten abweichende Regelungen.\n"
nachtrag:
type: "boolean"
description: "Eine Auswertungseinheit eines Plenarprotokolls kann nur an\
\ genau einen Vorgangsschritt angebunden werden. \nMüssen aber mehrere\
\ Auswertungseinheiten für einen Vorgangsschritt gebildet werden (weil\
\ die Ergänzung einer Rede erst in einem späteren Protokoll erscheint\
\ oder weil sich z.B. bei einer Verbundenen Beratung (§ 24 GO-BT) nicht\
\ alle Schriftlichen Erklärungen nach § 31 GO-BT auf sämtliche Vorlagen\
\ beziehen), \ndann müssen im Vorgangsablauf mehrere Vorgangsschritte\
\ mit der gleichen Vorgangsposition angelegt werden. Der zweite und jeder\
\ weitere dieser Schritte wird dann als \"Nachtrag\" gekennzeichnet (Attribut\
\ `nachtrag: true`)\n"
vorgangstyp:
type: "string"
example: "Geschäftsordnung"
description: "Vorgangstyp des zugehörigen Vorgangs"
typ:
type: "string"
enum:
- "Vorgangsposition"
example: "Vorgangsposition"
titel:
type: "string"
example: "Weitergeltung von Geschäftsordnungsrecht"
description: "Titel des zugehörigen Vorgangs"
dokumentart:
type: "string"
enum:
- "Drucksache"
- "Plenarprotokoll"
example: "Drucksache"
vorgang_id:
type: "string"
pattern: "^\\d+$"
example: "84343"
description: "ID des zugehörigen Vorgangs"
datum:
type: "string"
format: "date"
example: "2017-10-24"
description: "Datum des zugehörigen Dokuments"
aktualisiert:
type: "string"
format: "date-time"
example: "2022-08-01T15:30:16+02:00"
description: "Letzte Aktualisierung der Entität oder des zugehörigen Dokuments"