afb-CMS Composed-API for Uploading Document Files from Digitizer App API documentation

Resource: /{code}

API-Spec for upload resource: Submitting document to upload service.

/{code}

[DE] Request zum Übertragen einer Datei für einen Dokumenten-Container für eine Dokumenten-Akte
[EN] Request for submitting a file for a specific document container for a document file

Request
Response

URI Parameters
- code string
  [DE] Upload-Code zur Prüfung und Zuordnung eines Dokumenten-Containers [EN] Upload code for validating and associating a document container
  Example
  d1ceac9b-74fd-408a-a5a4-9ae5230665f2

Headers
- x-client-type Enum one of[IOS_APP, ANDROID_APP]
  [DE] Version der Digitizer-App [EN] Version of Digitizer App
  Example
  IOS_APP
- x-client-version string
  [DE] Versionsnummer der Digitizer-App [EN] Version number of Digitizer App
  Example
  2.1.4
- x-id string
  [DE] Vorgangsnummer aus QR-Code extrahiert [EN] Transaction number extracted from QR code
  Example
  10201301

Body
Media type: multipart/form-data

Type: object
- file file
  [DE] Dateianhang zum Übertragen (gescanntes Bild) [EN] File attachment for submission (scanned picture)
- { "file": "20200527233247231.pdf" } Copy
```
{ "file": "20200527233247231.pdf" }
```

201
400
404
500

Description
The request was successfully processed

Description
The request could not be processed

Description
Upload code not found or expired

Description
The processing failed / internal error occurred

Upload-Codes for Testing

Example upload QR codes: Use these upload codes for testing.

Upload-Codes zum Testen

[DE] Beispiel Upload-Codes zum Übertragen einer Datei für einen Dokumenten-Container für eine Dokumenten-Akte
[EN] Example upload codes for submitting a file for a specific document container for a document file

Successful
Expired

Example 1: Upload successfully processed

Expected result: 201 - Created

[DE] Für den Deeeplink werden die Elemente DN und UU URL-encoded!
[EN] For the deeplink the elements DN und UU are URL encoded!

Digitizer App aufrufen

ID =

10101318

DN =

Vollmacht & Nachweis

UU =

https://api.brainleap.it/addm/qrcode/v2/d1ceac9b-74fd-408a-a5a4-9ae5230665f2/files

Content QR

ID=10101318#DN=Vollmacht & Nachweis#UU=https://api.brainleap.it/addm/qrcode/v2/
d1ceac9b-74fd-408a-a5a4-9ae5230665f2/files

Content DL

digitizer://params?ID=10101318&DN=Vollmacht%20%26%20Nachweis&UU=https%3A%2F%2Fapi.brainleap.it
%2Faddm%2Fqrcode%2Fv2%2Fd1ceac9b-74fd-408a-a5a4-9ae5230665f2%2Ffiles

Example 2: Upload successfully processed

Expected result: 201 - Created

[DE] Für den Deeeplink werden die Elemente DN und UU URL-encoded!
[EN] For the deeplink the elements DN und UU are URL encoded!

Digitizer App aufrufen

ID =

10101318

DN =

Vollmacht & Nachweis

UU =

https://api.brainleap.it/addm/qrcode/v2/d1ceac9b-74fd-408a-a5a4-9ae5230665g2/files

Content QR

ID=10101318#DN=Vollmacht & Nachweis#UU=https://api.brainleap.it/addm/qrcode/v2/
d1ceac9b-74fd-408a-a5a4-9ae5230665g2/files

Content DL

digitizer://params?ID=10101318&DN=Vollmacht%20%26%20Nachweis&UU=https%3A%2F%2Fapi.brainleap.it
%2Faddm%2Fqrcode%2Fv2%2Fd1ceac9b-74fd-408a-a5a4-9ae5230665g2%2Ffiles

Example 1: Upload code not found or expired

Expected result: 404 - Not found or invalid request

[DE] Für den Deeeplink werden die Elemente DN und UU URL-encoded!
[EN] For the deeplink the elements DN und UU are URL encoded!

Digitizer App aufrufen

ID =

10101318

DN =

Vollmacht & Nachweis

UU =

https://api.brainleap.it/addm/qrcode/v2/d1ceac9b-74fd-408a-a5a4-9ae5230665f1/files

Content QR

ID=10101318#DN=Vollmacht & Nachweis#UU=https://api.brainleap.it/addm/qrcode/v2/
d1ceac9b-74fd-408a-a5a4-9ae5230665f1/files

Content DL

digitizer://params?ID=10101318&DN=Vollmacht%20%26%20Nachweis&UU=https%3A%2F%2Fapi.brainleap.it
%2Faddm%2Fqrcode%2Fv2%2Fd1ceac9b-74fd-408a-a5a4-9ae5230665f1%2Ffiles

Example 2: Upload code not found or expired

Expected result: 404 - Not found or invalid request

[DE] Für den Deeeplink werden die Elemente DN und UU URL-encoded!
[EN] For the deeplink the elements DN und UU are URL encoded!

Digitizer App aufrufen

ID =

10101318

DN =

Vollmacht & Nachweis

UU =

https://api.brainleap.it/addm/qrcode/v2/d1ceac9b-74fd-408a-a5a4-9ae5230665g1/files

Content QR

ID=10101318#DN=Vollmacht & Nachweis#UU=https://api.brainleap.it/addm/qrcode/v2/
d1ceac9b-74fd-408a-a5a4-9ae5230665g1/files

Content DL

digitizer://params?ID=10101318&DN=Vollmacht%20%26%20Nachweis&UU=https%3A%2F%2Fapi.brainleap.it
%2Faddm%2Fqrcode%2Fv2%2Fd1ceac9b-74fd-408a-a5a4-9ae5230665g1%2Ffiles

Download the API-Spec / Postman-Collection

Download as RAML: CMSDE-afb-API-DOC-Digitizer.raml
Download as YAML: CMSDE-afb-API-DOC-Digitizer.yaml
Download Postman-Collection: CMSDE-DGTZ.postman_collection.json