System-API: Kunden

Diese Dokumentation ist veraltet. Bitte nutzen Sie die dedizierte API-Dokumentation.

Der nachfolgend beschriebene API-Endpoint hat die URL /client. Zur Verwendung der System-API konsultieren Sie bitte die Grundsätze der System-API.

GET (alle Kunden)

Erwartete Parameter

Keine

Rückgabe

JSON-Array mit allen Kunden und jeweils den folgenden Elementen:

• ID
• firstname
• lastname
• company
• mail

GET (ein Kunde)

URL

/client/CLIENT_ID

Erwartete Parameter

Keine

Rückgabe

JSON-Array mit allen Daten des Kunden

POST (Kunde anlegen)

Erwartete Parameter

• firstname
• lastname
• mail
• pwd (optional, wenn nicht gegeben wird ein Passwort generiert)

Rückgabe

JSON-Array mit Element "id", der ID des neuen Kunden

Falls kein Passwort gesetzt wurde, wird das generierte Passwort als Element "pwd" zurückgegeben

PUT (Kunde bearbeiten)

URL

/client/CLIENT_ID

Erwartete Parameter

Es können alle Spalten aus der Tabelle clients als Key verwendet werden. Als Value ist der gewünschte neue Wert zu übergeben.

Rückgabe

JSON-Array mit "status" = "ok"