-
Notifications
You must be signed in to change notification settings - Fork 0
/
dokumente-openapi.yaml
290 lines (289 loc) · 10.3 KB
/
dokumente-openapi.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
openapi: 3.0.0
info:
title: baufismart-dokumente-api
description: |-
With this API, case- and application- documents can be downloaded and uploaded.
Note: As a sales organization, the Unterlagen-API should be used for documents and proofs in a construction financing. This API is mainly for application documents from the product provider or documents created by the sales organization.
contact:
name: Europace AG
url: www.europace2.de
email: helpdesk@europace2.de
version: 1.0.0
servers:
- url: 'https://api.europace2.de'
paths:
/dokumentenverwaltung/dokument:
get:
tags:
- document
summary: download document
description: 'download a document from a case or application. The document-id is provided by the upload, or another API such as the Vorgaenge-API or Antraege-API.'
operationId: getDocument
parameters:
- name: id
in: query
description: document-id
required: true
style: form
schema:
type: string
example: '{{id}}'
- name: Accept
in: header
description: accepted file format
required: true
style: simple
schema:
type: string
example: 'text/html;charset=UTF-8, text/rtf;charset=UTF-8, text/plain;charset=UTF-8, text/xml;charset=UTF-8, image/gif, image/jpg, image/jpeg, image/png, image/bmp, image/png,image/svg+xml, image/tiff, application/zip, application/excel, application/vnd.ms-outlook, application/pdf;charset=UTF-8, application/vnd.openxmlformats-officedocument.presentationml.presentation, application/mspowerpoint, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/msword, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties: {}
application/pdf:
schema:
type: object
properties: {}
headers:
content-type:
schema:
type: string
description: document type e.g. application/pdf;charset=UTF-8
content-disposition:
schema:
type: string
description: inline; filename="MeinTestUpload.pdf"
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/error-message'
examples:
example-1:
value:
traceId: ep2-64oyr
seitenName: Authentifizierung fehlgeschlagen
ueberschrift: Fehlerhafte Anmeldedaten
nachricht: 'Solltest du dein Passwort vergessen haben,<br/>nutze bitte den Passwort-Vergessen-Link auf der Login-Seite.'
errorMessageForUser: " "
statusCode: 401
redirectTarget: /dokumentenverwaltung/login?oeffne=%2Fdokumentenverwaltung%2Fdokument%2F%3Fid%3D85c9771d07ac5c27400abb7ece039133a1d5aebee5c1baae5b4fd7572ebbf9cabf3d1aad7ff480625e95cf828e4871f2d78db9842960ee32b762b24911dd0
internalErrorMessage: null
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/error-message'
examples:
example-1:
value:
traceId: ep2-96gqd-backend
seitenName: Keine Berechtigung
ueberschrift: Keine Berechtigung
nachricht: Du hast keine Berechtigung für den Zugriff auf diese Daten.
errorMessageForUser: Du hast keine Berechtigung für den Zugriff auf diese Daten.
statusCode: 403
redirectTarget: null
internalErrorMessage: null
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/error-message'
examples:
example-1:
value:
traceId: string
seitenName: string
ueberschrift: string
nachricht: string
errorMessageForUser: string
statusCode: 0
redirectTarget: null
internalErrorMessage: null
security:
- Authorization: []
/vorgang/dokumente:
post:
tags:
- document
summary: add document
description: upload a document and adding it to a case or application
operationId: addDocument
parameters:
- name: anzeigename
in: query
description: file name displayed in BaufiSmart
required: false
style: form
schema:
type: string
example: test_dokument
- name: teilAntragNummer
in: query
description: The application to which the document should be added. When uploading, either a VorgangsNummer or a TeilAntragNummer must be specified.
required: false
style: form
schema:
type: string
example: '123456789'
- name: vorgangsNummer
in: query
description: The case to which the document should be added. When uploading, either a VorgangsNummer or a TeilAntragNummer must be specified.
required: false
style: form
schema:
type: string
format: 'YYY-MM-DDThh:mm:ss.SSSZ'
example: AB1234
- name: erstellungsdatum
in: query
description: creation date
required: false
style: form
schema:
type: string
format: 'YYY-MM-DDThh:mm:ss.SSSZ'
example: '2016-04-07T13:30:11.633Z'
- name: sichtbarFuerVertrieb
in: query
description: visibleForSales - if true, the document ist visible for sales organization
required: false
style: form
schema:
type: boolean
example: true
- name: Content-Type
in: header
style: simple
schema:
type: string
example: multipart/form-data
required: true
requestBody:
content:
multipart/form-data:
schema:
description: ''
type: object
properties:
traceId:
type: string
minLength: 1
seitenName:
type: string
minLength: 1
ueberschrift:
type: string
minLength: 1
nachricht:
type: string
minLength: 1
errorMessageForUser: {}
statusCode:
type: number
redirectTarget: {}
internalErrorMessage: {}
required:
- traceId
- seitenName
- ueberschrift
- nachricht
- statusCode
required: true
responses:
'201':
description: Created
headers:
Location:
schema:
type: string
description: download uri of the document (contains document-id)
'403':
description: 'Forbidden - Scope ''dokumente:dokument:schreiben'' not set'
content:
application/json:
schema:
$ref: '#/components/schemas/error-message'
examples:
example-1:
value:
traceId: ep2-96gqd-backend
seitenName: Keine Berechtigung
ueberschrift: Keine Berechtigung
nachricht: Du hast keine Berechtigung für den Zugriff auf diese Daten.
errorMessageForUser: Du hast keine Berechtigung für den Zugriff auf diese Daten.
statusCode: 403
redirectTarget: null
internalErrorMessage: null
'404':
description: Not Found - case or application not available
content:
application/json:
schema:
$ref: '#/components/schemas/error-message'
examples: {}
'422':
description: Unprocessable Entity. Will be returned if parameters are missing or incorrect.
content:
application/json:
schema:
$ref: '#/components/schemas/error-message'
examples:
example-1:
value:
traceId: ep2-i4t9r-backend
seitenName: ''
ueberschrift: 'Das Dokument kann dem Vorgang nicht hinzugefügt werden, da das Flag ''sichtbarFuerVertrieb'' nicht gesetzt ist.'
nachricht: ' '
errorMessageForUser: 'Das Dokument kann dem Vorgang nicht hinzugefügt werden, da das Flag ''sichtbarFuerVertrieb'' nicht gesetzt ist.'
statusCode: 422
redirectTarget: null
internalErrorMessage: null
security: []
tags:
- name: document
description: self-generated quotes or applications- and contract-documents
components:
securitySchemes:
Authorization:
type: http
scheme: bearer
schemas:
error-message:
title: error messages
type: object
properties:
traceId:
type: string
minLength: 1
seitenName:
type: string
ueberschrift:
type: string
minLength: 1
nachricht:
type: string
minLength: 1
errorMessageForUser:
type: string
minLength: 1
statusCode:
type: number
redirectTarget: {}
internalErrorMessage: {}
required:
- traceId
- seitenName
- ueberschrift
- nachricht
- errorMessageForUser
- statusCode
description: ''