From 37b4de28919310c5b019fac0c5dbd546998557e0 Mon Sep 17 00:00:00 2001 From: Steffen Petelka Date: Tue, 8 Dec 2020 14:30:45 +0100 Subject: [PATCH 1/3] Update README.md (#52) --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 6e6c160..d1041ce 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,16 @@ # Unterlagen API + +### Scope der API +Die Übertragung der Unterlagen des Verbrauchers zum Produktanbieter. + +### wichtigste Use Cases API um die [digitale Unterlagenakte](https://europace2.zendesk.com/hc/de/sections/360004174293-Die-digitale-Unterlagenakte) zu bedienen. Mit dieser API können folgende Aktionen durchgeführt werden: * Als Vertrieb kann ein Dokument am Vorgang hochgeladen werden. * Als Vertrieb kann ein Dokument kategorisiert werden und somit in eine Unterlage umgewandet werden. * Als Vertrieb können Unterlagen an Anträgen für Produktanbieter freigegeben werden. * Als Vertrieb und Produktanbieter können freigegebene Unterlagen an einem Antrag abgerufen werden. + * Hinweis zu Antragsdokumenten in Baufismart: nicht abrufbar sind Antragsdokumente wie z.b. die Kreditentscheidungsinformation oder die Selbstauskunft zum Antrag. Diese Dokumente können per https://github.com/europace/baufismart-antraege-api abgerufen werden. + From 9e658953ba396583053ebe1cccdae5ebb05e333e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michael=20Kr=C3=BCger-Haubenschild?= Date: Tue, 8 Dec 2020 17:05:40 +0100 Subject: [PATCH 2/3] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index d1041ce..cff6491 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,7 @@ Erste Schritte zur Nutzung der Europace APIs sind [hier](https://docs.api.europa Bitte benutze [![Authentication](https://img.shields.io/badge/Auth-OAuth2-green)](https://github.com/europace/authorization-api), um Zugang zur API bekommen. Um die API verwenden zu können, benötigt der OAuth2-Client folgende Scopes: + | Scope | API Use case | |-----------------------------------|---------------------------------| | `unterlagen:dokument:lesen` | als Vertrieb, Abruf der Metadaten und des Inhalts hochgeladener Dokumente. | From 0ff8baf5d7ec4516687190f25cf4fc332fb4ef0a Mon Sep 17 00:00:00 2001 From: Steffen Petelka Date: Tue, 26 Jan 2021 07:22:54 +0100 Subject: [PATCH 3/3] =?UTF-8?q?[DUCK-1616]=20Sortierung=20der=20Seiten=20e?= =?UTF-8?q?rm=C3=B6glichen=20+=20boyscout?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- swagger.yaml | 54 +++++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 47 insertions(+), 7 deletions(-) diff --git a/swagger.yaml b/swagger.yaml index 91aa241..a9e0aa7 100644 --- a/swagger.yaml +++ b/swagger.yaml @@ -665,6 +665,53 @@ paths: - unterlagen:unterlage:lesen tags: - Seiten + put: + summary: Sortierung der Seiten Ändern + description: Seiten werden werden in der angegeben Reihenfolge gespeichert. Es kann die Liste aller Seiten oder auch eine Teilliste davon übergeben werden. Bei einer Teilliste wird die Position in der Gesamtliste durch die erste Seite der Teilliste bestimmt. + operationId: setzeReihenfolge + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: "#/components/schemas/SeitenReferenz" + description: Die Seiten-Referenzen der Seiten, die in dieser Reihenfolge gespeichert werden sollen. + required: true + responses: + "200": + description: Ok + "400": + description: Fehler in den Eingabedaten. + content: + application/json: + schema: + $ref: "#/components/schemas/Error" + "401": + description: Authentifizierung fehlgeschlagen durch z.b. fehlender/ungültiger Authorization Header + content: + application/json: + schema: + $ref: "#/components/schemas/Error" + "403": + description: Authorisierung fehlgeschlagen durch z.b. fehlende Berechtigung auf den Vorgang + content: + application/json: + schema: + $ref: "#/components/schemas/Error" + default: + description: Unerwarteter Fehler + content: + application/json: + schema: + $ref: "#/components/schemas/Error" + security: + - europace_oauth2_legacy: + - API + - europace_oauth2: + - unterlagen:unterlage:schreiben + tags: + - Seiten "/dokumente/zuordnung/{kategorie}": put: summary: Zuordnung (Kategorie und Bezug) für mehrere Seiten setzen @@ -682,13 +729,6 @@ paths: required: false schema: type: string - - name: antragsNummer - in: query - description: z.T. beziehen sich die Angaben in der Seite auf Angaben im Vorgang - zum Zeitpunkt, als der Antrag angenommen wurde. - required: false - schema: - type: string requestBody: content: application/json: