System-API: Kunden: Unterschied zwischen den Versionen

Aus sourceDESK Wiki
Wechseln zu: Navigation, Suche
(Die Seite wurde neu angelegt: „Der nachfolgend beschriebene API-Endpoint hat die URL <code>/client</code>. Zur Verwendung der System-API konsultieren Sie bitte die Grundsätze der System-A…“)
(kein Unterschied)

Version vom 5. Oktober 2018, 12:35 Uhr

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 tblclients als Key verwendet werden. Als Value ist der gewünschte neue Wert zu übergeben.

Rückgabe

JSON-Array mit "status" = "ok"