· 6 years ago · Mar 10, 2020, 08:50 AM
1openapi: 3.0.0
2info:
3 version: 2.84.0
4 title: TeamBank-Welt API
5 description: API zur Bereitstellung von Funktionalitäten vom B2B-Guide für die
6 TeamBank-Welt
7servers:
8 - url: http://localhost:11110
9 description: Local
10 - url: https://b2bguide-acceptance.integ.easycredit.intern
11 description: Acceptance
12 - url: https://b2bguide.integ.easycredit.intern
13 description: Integ
14 - url: https://b2bguide.qsu.easycredit.intern
15 description: QSU
16 - url: https://b2bguide.qsu2.easycredit.intern
17 description: QSU2
18 - url: https://b2bguide.easycredit.intern
19 description: PROD
20paths:
21 "/api/v1/teambankwelt/massnahmenpakete":
22 parameters:
23 - in: header
24 name: benutzerPartnerkennung
25 required: true
26 description: Partnerkennung der Partnerbank vom Benutzer z.B. de.1.1234
27 schema:
28 type: string
29 - in: header
30 name: benutzerEcKennung
31 required: true
32 description: eC-Kennung des Benutzers z.B. de123456
33 schema:
34 type: string
35 get:
36 summary: Gibt alle buchbaren Maßnahmenpakete zurück
37 operationId: getMassnahmenpakete
38 tags:
39 - Massnahmenpaket
40 responses:
41 "200":
42 description: List mit buchbaren Maßnahmenpaketen
43 content:
44 application/json:
45 schema:
46 type: array
47 items:
48 $ref: "#/components/schemas/Massnahmenpaket"
49 "400":
50 description: Validierungsfehler
51 content:
52 application/json:
53 schema:
54 $ref: "#/components/schemas/Messages"
55 "403":
56 description: Benutzer darf für Partnerbank keine Maßnahmenpakete buchen
57 "500":
58 description: serverseitiger Fehler
59 "/api/v1/teambankwelt/massnahmenpakete/{partnerkennung}":
60 parameters:
61 - in: header
62 name: benutzerPartnerkennung
63 required: true
64 description: Partnerkennung der Partnerbank vom Benutzer z.B. de.1.1234
65 schema:
66 type: string
67 - in: header
68 name: benutzerEcKennung
69 required: true
70 description: eC-Kennung des Benutzers z.B. de123456
71 schema:
72 type: string
73 - in: path
74 name: partnerkennung
75 required: true
76 description: Partnerkennung der Partnerbank z.B. de.1.1234
77 schema:
78 type: string
79 get:
80 summary: Gibt alle gebuchten Maßnahmenpakete einer Partnerbank zurück (historisch)
81 operationId: getMassnahmenpaketePartnerkennung
82 tags:
83 - Massnahmenpaket
84 responses:
85 "200":
86 description: List mit gebuchten Maßnahmenpaketen
87 content:
88 application/json:
89 schema:
90 type: array
91 items:
92 $ref: "#/components/schemas/MassnahmenpaketGebucht"
93 "400":
94 description: Validierungsfehler
95 content:
96 application/json:
97 schema:
98 $ref: "#/components/schemas/Messages"
99 "403":
100 description: Benutzer darf für Partnerbank keine Maßnahmenpakete buchen
101 "500":
102 description: serverseitiger Fehler
103 post:
104 summary: neue Buchung von Maßnahmenpaketen einer Partnerbank
105 operationId: postMassnahmenpaketePartnerkennung
106 tags:
107 - Massnahmenpaket
108 requestBody:
109 content:
110 application/json:
111 schema:
112 type: array
113 items:
114 $ref: "#/components/schemas/MassnahmenpaketAnlage"
115 description: Anzulegende Maßnahmenpakete
116 required: true
117 responses:
118 "201":
119 description: List mit gebuchten Maßnahmenpaketen
120 content:
121 application/json:
122 schema:
123 type: array
124 items:
125 $ref: "#/components/schemas/MassnahmenpaketGebucht"
126 "400":
127 description: Validierungsfehler
128 content:
129 application/json:
130 schema:
131 $ref: "#/components/schemas/Messages"
132 "403":
133 description: Benutzer darf für Partnerbank keine Maßnahmenpakete buchen
134 "500":
135 description: serverseitiger Fehler
136 "/api/v1/teambankwelt/massnahmenpakete/{massnahmenpaketbuchungId}/file":
137 parameters:
138 - in: header
139 name: benutzerPartnerkennung
140 required: true
141 description: Partnerkennung der Partnerbank vom Benutzer z.B. de.1.1234
142 schema:
143 type: string
144 - in: header
145 name: benutzerEcKennung
146 required: true
147 description: eC-Kennung des Benutzers z.B. de123456
148 schema:
149 type: string
150 - in: path
151 name: massnahmenpaketbuchungId
152 required: true
153 description: eindeutige Buchungsnummer für die Massnahmenbuchung
154 schema:
155 type: integer
156 post:
157 summary: PDF zur Massnahmenbuchung hochladen
158 operationId: postMassnahmenpaketeMassnahmenpaketbuchungIdFile
159 tags:
160 - Massnahmenpaket
161 requestBody:
162 content:
163 multipart/form-data:
164 schema:
165 type: object
166 properties:
167 pdfMassnahmenbuchung:
168 type: string
169 format: binary
170 responses:
171 "200":
172 description: OK
173 "400":
174 description: Validierungsfehler
175 content:
176 application/json:
177 schema:
178 $ref: "#/components/schemas/Messages"
179 "403":
180 description: Benutzer darf für Partnerbank keine Maßnahmenpakete buchen
181 "500":
182 description: serverseitiger Fehler
183 get:
184 summary: PDF zur Massnahmenbuchung herunterladen
185 operationId: getMassnahmenpaketeFileMassnahmenpaketbuchungId
186 tags:
187 - Massnahmenpaket
188 responses:
189 "200":
190 description: OK
191 content:
192 application/pdf:
193 schema:
194 type: string
195 format: byte
196 example: byte
197 "400":
198 description: Validierungsfehler
199 content:
200 application/json:
201 schema:
202 $ref: "#/components/schemas/Messages"
203 "403":
204 description: Benutzer darf für Partnerbank keine Maßnahmenpakete buchen
205 "500":
206 description: serverseitiger Fehler
207components:
208 securitySchemes:
209 bearerAuth:
210 type: http
211 scheme: bearer
212 bearerFormat: JWT
213 description: eC-Kennung von Benutzer und Partnerbankkennung müssen als zusätzliche Attribute mitübertragen werden, damit bei jedem Request geprüft werden kann, ob Maßnahmepakete gebucht werden können
214 responses:
215 UnauthorizedError:
216 description: Bearer-Token ist nicht vorhanden oder nicht gültig
217 schemas:
218 Massnahmenpaket:
219 required: [technischerSchluessel, bezeichnung, gueltigAb, massnahmen]
220 properties:
221 technischerSchluessel:
222 type: string
223 description: eindeutiger Schlüssel vom Maßnahmenpaket mit Groß-/Kleinbuchstaben
224 ohne Leerzeichen/Sonderzeichen
225 example: DE_Fremdabloesequote_erhoehen
226 bezeichnung:
227 type: string
228 example: Fremdablösequote erhöhen
229 gueltigAb:
230 type: string
231 format: date
232 description: Datum im Format YYYY-MM-DD
233 example: "2019-12-01"
234 gueltigBis:
235 type: string
236 format: date
237 description: Datum im Format YYYY-MM-DD, wenn leer ist das Maßnahmenpaket
238 unbegrenzt buchbar
239 example: "2021-09-01"
240 massnahmen:
241 type: array
242 items:
243 type: object
244 properties:
245 technischerSchluessel:
246 type: string
247 description: eindeutiger Schlüssel der Maßnahme mit Groß-/Kleinbuchstaben
248 ohne Leerzeichen/Sonderzeichen
249 example: DE_Fremdabloesequote_erhoehen_Vertriebsimpulse
250 bezeichnung:
251 type: string
252 example: Vertriebsimpulse
253 gueltigAb:
254 type: string
255 format: date
256 description: Datum im Format YYYY-MM-DD
257 example: "2020-03-01"
258 gueltigBis:
259 type: string
260 format: date
261 description: Datum im Format YYYY-MM-DD, wenn leer ist die Maßnahme
262 unbegrenzt buchbar
263 example: "2022-07-01"
264 MassnahmenpaketAnlage:
265 required: [technischerSchluessel, massnahmen, datenweiterleitung]
266 properties:
267 technischerSchluessel:
268 type: string
269 description: eindeutiger Schlüssel vom Maßnahmenpaket mit Groß-/Kleinbuchstaben
270 ohne Leerzeichen/Sonderzeichen
271 example: DE_Fremdabloesequote_erhoehen
272 nutzungAb:
273 type: string
274 format: date
275 description: Datum im Format YYYY-MM-DD
276 example: "2020-03-01"
277 datenweiterleitung:
278 type: boolean
279 description: Einwilligung zur Datenweiterung vom Benutzer
280 example: true
281 massnahmen:
282 type: array
283 items:
284 type: object
285 required: [technischerSchluessel]
286 properties:
287 technischerSchluessel:
288 type: string
289 description: eindeutiger Schlüssel der Maßnahme mit Groß-/Kleinbuchstaben
290 ohne Leerzeichen/Sonderzeichen
291 example: DE_Neukunden_gewinnen_Mailing
292 MassnahmenpaketGebucht:
293 required: [technischerSchluessel, massnahmenpaketbuchungId, bezeichnung, gueltigAb, angefordertAm, massnahmen]
294 properties:
295 technischerSchluessel:
296 type: string
297 description: eindeutiger Schlüssel vom Maßnahmenpaket mit Groß-/Kleinbuchstaben
298 ohne Leerzeichen/Sonderzeichen
299 example: DE_Fremdabloesequote_erhoehen
300 massnahmenpaketbuchungId:
301 type: integer
302 description: eindeutige Buchungsnummer für das Maßnahmenpaket
303 example: "1234"
304 bezeichnung:
305 type: string
306 example: Fremdablösequote erhöhen
307 gueltigAb:
308 type: string
309 format: date
310 description: Datum im Format YYYY-MM-DD
311 example: "2019-12-01"
312 gueltigBis:
313 type: string
314 format: date
315 description: Datum im Format YYYY-MM-DD, wenn leer ist das Maßnahmenpaket
316 unbegrenzt buchbar
317 example: "2021-09-01"
318 angefordertAm:
319 type: string
320 format: date
321 description: Datum im Format YYYY-MM-DD
322 example: "2020-01-13"
323 nutzungAb:
324 type: string
325 format: date
326 description: Datum im Format YYYY-MM-DD
327 example: "2021-08-30"
328 nutzungBis:
329 type: string
330 format: date
331 description: Datum im Format YYYY-MM-DD
332 example: "2021-10-15"
333 massnahmen:
334 type: array
335 items:
336 type: object
337 required: [technischerSchluessel, bezeichnung, gueltigAb]
338 properties:
339 technischerSchluessel:
340 type: string
341 description: eindeutiger Schlüssel der Maßnahme mit Groß-/Kleinbuchstaben
342 ohne Leerzeichen/Sonderzeichen
343 example: DE_Fremdabloesequote_erhoehen_Vertriebsimpulse
344 bezeichnung:
345 type: string
346 example: Vertriebsimpulse
347 gueltigAb:
348 type: string
349 format: date
350 description: Datum im Format YYYY-MM-DD
351 example: "2020-03-01"
352 gueltigBis:
353 type: string
354 format: date
355 description: Datum im Format YYYY-MM-DD, wenn leer ist die Maßnahme
356 unbegrenzt buchbar
357 example: "2022-07-01"
358 Message:
359 properties:
360 key:
361 type: string
362 example: ERROR
363 field:
364 type: string
365 example: datenweiterleitung
366 message:
367 type: string
368 example: Beim Buchen von Maßnahmenpaketen muss die Zustimmung der Datenweiterleitung mitgegeben werden.
369 severity:
370 type: string
371 enum:
372 - ERROR
373 - WARNING
374 - INFO
375 Messages:
376 properties:
377 uuid:
378 type: string
379 example: "123e4567-e89b-12d3-a456-556642440000"
380 messages:
381 type: array
382 items:
383 $ref: "#/components/schemas/Message"
384security:
385 - bearerAuth: []