-
Notifications
You must be signed in to change notification settings - Fork 1
/
produktanbieter-vertrieb-openapi.yaml
335 lines (335 loc) · 10.8 KB
/
produktanbieter-vertrieb-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
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
openapi: 3.0.1
info:
title: Produktanbietervertriebsangaben API
description: Diese Schnittstelle erlaubt das Aktualisieren von Produktanbietervertriebsangaben
an Vorgängen auf der Europace Plattform.
termsOfService: https://docs.api.europace.de/nutzungsbedingungen/
contact:
name: Europace AG
url: http://developer.europace.de
email: [email protected]
version: 1.1.7; 132109364df3a65bce03eb2b2357d079775cb2aa
servers:
- url: https://baufinanzierung.api.europace.de
description: Produktionsserver
tags:
- name: Produktanbietervertrieb
description: Produktanbietervertriebsangaben an einem existierenden Vorgang aktualisieren
paths:
/produktanbieter-vertrieb/{vorgangsnummer}:
post:
tags:
- Produktanbietervertrieb
summary: Produktanbietervertriebsangaben an einem existierenden Vorgang aktualisieren
description: "Produktanbietervertriebsangaben werden in BaufiSmart an einem\
\ existierenden Vorgang aktualisiert. Der Scope `baufinanzierung:echtgeschaeft`wird\
\ benötigt, wenn der Datenkontext `ECHT_GESCHAEFT` gewählt wird."
operationId: updateProduktanbieterVertriebsAngaben
parameters:
- name: vorgangsnummer
in: path
description: "Nummer des Vorgangs, dessen Daten aktualisiert werden"
required: true
style: simple
explode: false
schema:
type: string
example: UT5MDV
- name: Authorization
in: header
description: Authorization Bearer Token
required: true
style: simple
explode: false
schema:
type: string
- name: TraceId
in: header
description: Eine eindeutige technische Id zur Identifikation des Requests
required: false
style: simple
explode: false
schema:
type: string
requestBody:
content:
application/json;version=1.0:
schema:
$ref: '#/components/schemas/UpdateRequest'
required: true
responses:
"404":
description: Der Vorgang existiert nicht
"403":
description: "Es fehlt die Berechtigung, um die Anfrage auszuführen"
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
"503":
description: Der Service kann den Request momentan nicht verarbeiten
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
"401":
description: Die Authentifizierung ist fehlgeschlagen
"200":
description: Produktanbietervertriebsangaben in existierenden Vorgang importiert
"400":
description: Der Request hat ein fehlerhaftes Format oder der Datentyp eines
Felds weicht von der Spezifikation ab.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/BadRequestProblem'
security:
- oAuth2:
- baufinanzierung:vorgang:schreiben
- baufinanzierung:echtgeschaeft
components:
schemas:
AllgemeineVerbundweiterleitungAngaben:
type: object
properties:
ursprungsDarlehen:
type: array
description: Liste von Angaben zu den Ursprungsdarlehen
items:
$ref: '#/components/schemas/VerbundweiterleitungUrsprungsDarlehen'
provision:
$ref: '#/components/schemas/VerbundweiterleitungProvision'
reservierung:
$ref: '#/components/schemas/VerbundweiterleitungReservierung'
untervermittler:
$ref: '#/components/schemas/VerbundweiterleitungUntervermittler'
description: "Allgemeine Verbundweiterleitungs-Angaben zu einem Vorgang, die\
\ für alle Verbundpartner gelten"
KonditionsAngaben:
type: object
properties:
olb:
$ref: '#/components/schemas/OlbKonditionsAngaben'
description: Produktanbietervertriebsspezifische Konditionsangaben zu einem
Vorgang
OlbKonditionsAngaben:
type: object
properties:
abschlaege:
type: array
items:
type: string
description: Für den Kunden anzuwendende Konditionsabschläge.
enum:
- NEUKUNDE
- MITARBEITER
description: OLB-spezifische Konditionsangaben
OlbScoring:
type: object
properties:
bonitaetsklasse:
type: string
description: OLB-Bonitätsklasse der Gesamtheit der Antragsteller eines Vorgangs
example: KLASSE_8
enum:
- KLASSE_1
- KLASSE_2
- KLASSE_3
- KLASSE_4
- KLASSE_5
- KLASSE_6
- KLASSE_7
- KLASSE_8
- KLASSE_9
- KLASSE_10
- KLASSE_11
- KLASSE_12
- KLASSE_13
- KLASSE_14
- KLASSE_15
- KLASSE_16
description: OLB-spezifisches Scoring
ScoringAngaben:
type: object
properties:
olb:
$ref: '#/components/schemas/OlbScoring'
description: Produktanbietervertriebsspezifische Scoringangaben zu einem Vorgang
UpdateRequest:
required:
- scoring
type: object
properties:
scoring:
$ref: '#/components/schemas/ScoringAngaben'
kondition:
$ref: '#/components/schemas/KonditionsAngaben'
verbundweiterleitung:
$ref: '#/components/schemas/VerbundweiterleitungAngaben'
VerbundweiterleitungAngaben:
type: object
properties:
allgemein:
$ref: '#/components/schemas/AllgemeineVerbundweiterleitungAngaben'
description: Produktanbietervertriebsspezifische Verbundweiterleitungs-Angaben
zu einem Vorgang
VerbundweiterleitungProvision:
type: object
properties:
kundenbetreuerProvision:
type: number
description: Provisionsanteil in Euro des Kundenbetreuers des weitergeleiteten
Antrags an der Vertriebsprovision des Verbunddarlehens
format: double
vertriebsProvisionGesamt:
type: number
description: Gesamte Vertriebsprovision des Verbunddarlehens im weitergeleiteten
Antrag
format: double
description: Angaben zur Provision aus dem weitergeleiteten Antrag
VerbundweiterleitungReservierung:
required:
- einstandsdatum
type: object
properties:
einstandsdatum:
type: string
description: Einstandsdatum und -zeit der reservierten Kondition im ISO-Date-Time-Format
format: date-time
description: Angaben zur Konditions-Reservierung der Verbundweiterleitung
VerbundweiterleitungUntervermittler:
required:
- partnerId
type: object
properties:
partnerId:
type: string
firmierung:
type: string
anrede:
type: string
vorname:
type: string
nachname:
type: string
telefonnummer:
type: string
email:
type: string
registrierungsNummer:
type: string
aufsichtsBehoerde:
type: string
vertriebsOrganisation:
type: string
vertriebsOrganisationsId:
type: string
externerKreditSachbearbeiterId:
type: string
anschrift:
$ref: '#/components/schemas/VerbundweiterleitungUntervermittlerAnschrift'
description: "Daten des ursprünglichen Vermittlers, der in der Verbundweiterleitung\
\ als Untervermittler agiert."
example: ABC12
VerbundweiterleitungUntervermittlerAnschrift:
type: object
properties:
strasse:
type: string
hausnummer:
type: string
plz:
type: string
ort:
type: string
description: Anschrift eines Untervermittlers
VerbundweiterleitungUrsprungsDarlehen:
required:
- produktId
type: object
properties:
produktId:
type: string
description: Die Produkt-/ProduzentenId
description: Angaben zum Ursprungsdarlehen
Problem:
required:
- status
- title
- type
type: object
properties:
type:
type: string
description: "Eine absolute URI, die den Problemtyp eindeutig identifiziert."
format: uri
example: https://api.europace.de/produktanbieter-vertrieb/problem/constraint-violation
title:
type: string
description: Eine kurze Zusammenfassung des Problemtyps.
example: Ressource unbekannt
status:
maximum: 600
exclusiveMaximum: true
minimum: 100
type: number
description: "Der HTTP Statuscode des Services, bei dem das Problem ursprü\
nglich aufgetreten ist."
example: 503
detail:
type: string
description: "Ein menschenlesbarer Text, der das konkrete Problem beschreibt."
example: Die Anfrage kann aufgrund fehlender Informationen nicht verarbeitet
werden.
instance:
type: string
description: "Eine relative URI, die das Problem verursacht hat. "
format: uri
example: /produktanbieter-vertrieb
BadRequestProblem:
allOf:
- $ref: '#/components/schemas/Problem'
- type: object
properties:
violations:
$ref: '#/components/schemas/BadRequestProblem_violations'
BadRequestProblem_violations:
required:
- field
type: object
properties:
field:
type: string
description: "Das Feld, welches einen ungültigen Wert beinhaltet"
message:
type: string
description: Eine genauere Beschreibung des Fehlers
responses:
BadRequest:
description: Der Request hat ein fehlerhaftes Format oder der Datentyp eines
Felds weicht von der Spezifikation ab.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/BadRequestProblem'
Forbidden:
description: "Es fehlt die Berechtigung, um die Anfrage auszuführen"
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
ServiceNotAvailable:
description: Der Service kann den Request momentan nicht verarbeiten
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
securitySchemes:
oAuth2:
type: oauth2
flows:
clientCredentials:
tokenUrl: https://api.europace.de/auth/access-token
scopes:
baufinanzierung:vorgang:schreiben: Aktualisieren eines Vorgangs
baufinanzierung:echtgeschaeft: Aktualisieren eines Vorgangs im Echtgeschäft