generated from bundesAPI/api-doc-template
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi_en.yaml
93 lines (93 loc) · 2.62 KB
/
openapi_en.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
openapi: 3.0.0
info:
title: Tagesordnungen API
version: 1.0.0
servers:
- url: https://api.hutt.io/
paths:
/bt-to/csv:
get:
summary: Get Tagesordnungen in CSV format
parameters:
- name: year
in: query
description: The year for which to retrieve Tagesordnungen (optional)
schema:
type: integer
- name: week
in: query
description: The calendar week for which to retrieve Tagesordnungen (optional; can be combined with year)
schema:
type: integer
responses:
'200':
description: Successful response
content:
text/csv:
schema:
type: string
/bt-to/json:
get:
summary: Get Tagesordnungen in JSON format
parameters:
- name: week
in: query
description: The calendar week for which to retrieve Tagesordnungen (optional)
schema:
type: integer
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: array
items:
type: object
/bt-to/xml:
get:
summary: Get Tagesordnungen in XML format
parameters:
- name: year
in: query
description: The year for which to retrieve Tagesordnungen (optional)
schema:
type: integer
- name: week
in: query
description: The calendar week for which to retrieve Tagesordnungen (optional; can be combined with year)
schema:
type: integer
responses:
'200':
description: Successful response
content:
application/xml:
schema:
type: string
/bt-to/ical:
get:
summary: Get Tagesordnungen in iCal format
parameters:
- name: na
in: query
description: Create additional calendar entries for Namentliche Abstimmungen (optional; combinable)
schema:
type: boolean
- name: naAlarm
in: query
description: Add alarms 15 minutes before Namentliche Abstimmungen (optional; combinable)
schema:
type: boolean
- name: showSW
in: query
description: Create all-day appointments for Sitzungswochen (optional; combinable)
schema:
type: boolean
responses:
'200':
description: Successful response
content:
text/calendar:
schema:
type: string