Ein Bild hochladen/herunterladen/löschen

In diesem Beispiel zeigen wir Ihnen, wie Sie ein Bild hoch bzw. ein vorhandenes Bild herunterladen oder löschen können.

Hochladen

POST /api/Adressen/{id}/Image

Beispiel Request URL:

http(s)://host:port/api/Adressen/{id}/Image

Beispiel Response:

{
  "errorMessage": "Upload erfolgreich",
  "errorType": 0,
}

Herunterladen

GET /api/Adressen/{id}/Image

Beispiel Request URL:

http(s)://host:port/api/Adressen/{id}/Image

Löschen

DEL /api/Adressen/{id}/Documents/Image

Beispiel Request URL:

http(s)://host:port/api/Adressen/{id}/Image

Ein Bild hochladen mit Postman

• Öffnen Sie das Programm »Postman«.
• Klicken Sie auf die Schaltfläche »New« und erstellen Sie eine neue Abfrage durch den Befehl »HTTP«.

• Benennen Sie die neue Abfrage mit »Bild hochladen«. Bewegen Sie den Mauszeiger in die Kopfzeile, so erscheint eine Auswahl des relevanten Textteiles. Klicken Sie auf diesen, können Sie einen neuen Titel vergeben.
• Legen Sie die neue Abfrage als »POST«-Befehl fest.
• Tragen Sie die relevante Zieleadresse mit dem definierten Port ein. Die Form entspricht: »http://host:port/api/Adressen/{id}/Image« bzw. »https://host:port/api/Adressen/{id}/Image«.

In unserem Beispiel handelt es sich um die exemplarische Adressen-ID »1994«.

Sie können Ihrem Bild eine Beschreibung mitgeben. Hängen Sie hierzu den Parameter »?description=Beschreibung« an die Form der Befehlszeile an. In unserem Beispiel lautet die Beschreibung: »cobra CRM«.

Alternativ können Sie in den Register »Params« wechseln. Fügen Sie dort »description« in der Spalte »Key« hinzu. Tragen Sie in der gleichen Zeile Ihre Beschreibung in der Spalte »Value« ein. Der Parameter wird automatisch in der Befehlszeile ergänzt.

• Wechseln Sie in das Register »Headers«.
• Tragen Sie hier den Namen und Wert der Schnittstelle ein.

• Klicken Sie auf das Register »Authorization«.
• Wählen Sie »Bearer Token« als Typ der Authentifizierung aus.
• Tragen Sie Ihren »JWT Bearer Token« ein. Wie Sie Ihren »JWT Bearer Token« abrufen können, siehe hier.

In unserem Beispiel wollen wir ein Bild einer Adresse hinterlegen.

• Wechseln Sie in das Register »Body«.
• Wählen Sie hier als Eigenschaft »form-data«.
• Tragen sie als Wert für das Feld »Key« »file« ein und selektieren Sie die Eigenschaft »File«.
• Für das Feld »Value« können Sie jetzt das relevante Bild durch »Select Files« hinterlegen.

• Klicken Sie auf »Send«.

Sie haben das Dokument erfolgreich hochgeladen.

• Klicken Sie auf »Save«, um Ihre angelegte Abfrage zu speichern.

Ein Bild herunterladen mit Postman

• Öffnen Sie das Programm »Postman«.
• Klicken Sie auf die Schaltfläche »New« und erstellen Sie eine neue Abfrage durch den Befehl »HTTP«.

• Benennen Sie die neue Abfrage mit »Bild herunterladen«. Bewegen Sie den Mauszeiger in die Kopfzeile, so erscheint eine Auswahl des relevanten Textteiles. Klicken Sie auf diesen, können Sie einen neuen Titel vergeben.
• Legen Sie die neue Abfrage als »GET«-Befehl fest.
• Tragen Sie die relevante Zieleadresse mit dem definierten Port ein. Die Form entspricht: »http://host:port/api/Adressen/{id}/Image« bzw. »https://host:port/api/Adressen/{id}/Image«.

In unserem Beispiel handelt es sich um die exemplarische Adressen-ID »1994«.

Sie können das Bild in einer Vorschau anzeigen. Hängen Sie hierzu den Parameter »?preview=true« an die Form der Befehlszeile an. Sie werden bei der Abfrage des Bildes eine übersichtliche Vorschau des Bildes herhalten.

Alternativ können Sie in den Register »Params« wechseln. Fügen Sie dort »preview« in der Spalte »Key« hinzu. Tragen Sie in der gleichen Zeile »true« in der Spalte »Value« ein. Der Parameter wird automatisch in der Befehlszeile ergänzt.

• Wechseln Sie in das Register »Headers«.
• Tragen Sie hier den Namen und Wert der Schnittstelle ein.

• Klicken Sie auf das Register »Authorization«.
• Wählen Sie »Bearer Token« als Typ der Authentifizierung aus.
• Tragen Sie Ihren »JWT Bearer Token« ein. Wie Sie Ihren »JWT Bearer Token« abrufen können, siehe hier.

• Klicken Sie auf »Send«.

Sie haben das Dokument erfolgreich heruntergeladen.

• Klicken Sie auf »Save«, um Ihre angelegte Abfrage zu speichern.

Ein Bild löschen mit Postman

• Öffnen Sie das Programm »Postman«.
• Klicken Sie auf die Schaltfläche »New« und erstellen Sie eine neue Abfrage durch den Befehl »HTTP«.

• Benennen Sie die neue Abfrage mit »Bild löschen«. Bewegen Sie den Mauszeiger in die Kopfzeile, so erscheint eine Auswahl des relevanten Textteiles. Klicken Sie auf diesen, können Sie einen neuen Titel vergeben.
• Legen Sie die neue Abfrage als »DELETE«-Befehl fest.
• Tragen Sie die relevante Zieleadresse mit dem definierten Port ein. Die Form entspricht: »http://host:port/api/Adressen/{id}/Image« bzw. »https://host:port/api/Adressen/{id}/Image«.

In unserem Beispiel wollen wir das Bild zur Adresse mit der Eintragsnummer »1998« löschen.

• Wechseln Sie in das Register »Headers«.
• Tragen Sie hier den Namen und Wert der Schnittstelle ein.

• Klicken Sie auf das Register »Authorization«.
• Wählen Sie »Bearer Token« als Typ der Authentifizierung aus.
• Tragen Sie Ihren »JWT Bearer Token« ein. Wie Sie Ihren »JWT Bearer Token« abrufen können, siehe hier.

• Klicken Sie auf »Send«.

Sie haben das Dokument erfolgreich gelöscht.

• Klicken Sie auf »Save«, um Ihre angelegte Abfrage zu speichern.