System-API: Kunden: Unterschied zwischen den Versionen
Aus sourceDESK Wiki
(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…“) |
|||
| (Eine dazwischenliegende Version desselben Benutzers wird nicht angezeigt) | |||
| Zeile 1: | Zeile 1: | ||
| + | <html> | ||
| + | <div style="border: 1px solid red; padding: 10px; color: red; font-weight: bold;">Diese Dokumentation ist veraltet. Bitte nutzen Sie <a href="https://admin-api.sourcedesk.de" target="_blank">die dedizierte API-Dokumentation</a>.</div> | ||
| + | </html> | ||
| + | |||
Der nachfolgend beschriebene API-Endpoint hat die URL <code>/client</code>. Zur Verwendung der System-API konsultieren Sie bitte die [[Grundsätze der System-API]]. | Der nachfolgend beschriebene API-Endpoint hat die URL <code>/client</code>. Zur Verwendung der System-API konsultieren Sie bitte die [[Grundsätze der System-API]]. | ||
| Zeile 54: | Zeile 58: | ||
'''Erwartete Parameter''' | '''Erwartete Parameter''' | ||
| − | Es können alle Spalten aus der Tabelle <code> | + | Es können alle Spalten aus der Tabelle <code>clients</code> als Key verwendet werden. Als Value ist der gewünschte neue Wert zu übergeben. |
'''Rückgabe''' | '''Rückgabe''' | ||
JSON-Array mit "status" = "ok" | JSON-Array mit "status" = "ok" | ||
Aktuelle Version vom 13. Januar 2019, 17:30 Uhr
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.
Inhaltsverzeichnis
GET (alle Kunden)
Erwartete Parameter
Keine
Rückgabe
JSON-Array mit allen Kunden und jeweils den folgenden Elementen:
- ID
- firstname
- lastname
- company
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
- 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"
