Zum Inhalt

Client

Übersicht

Beschreibung Methode Endpunkt
Kunden erstellen POST /hosting/api/client
Alle Kunden auslesen GET /hosting/api/client
Kunden auslesen GET /hosting/api/client/{clientId}
Kunden aktualisieren PUT /hosting/api/client/{clientId}
Kunden entfernen DELETE /hosting/api/client/{clientId}
Kundensuche GET /hosting/api/clientgetid/{searchTerm}

Kunden erstellen

Endpunkt: /hosting/api/client

Methode: POST

Payload: Client

Response:

  • 201 – Ressource erfolgreich erzeugt
  • Client
  • 400 – Ungültige oder fehlende Eigenschaften

Alle Kunden auslesen

Endpunkt: /hosting/api/client

Methode: GET

Response:

  • 200 – Erfolg
  • Client[] – Spezifisch für diesen Endpunkt enthält jedes Element zusätzlich folgende Eigenschaften:
  • actualCallCount: int
  • domainCountData: Array.\

Kunden auslesen

Endpunkt: /hosting/api/client/{clientId}

Methode: GET

Query:

  • {clientId}: string – Die ID eines CCM19-Kundenkontos

Response:

  • 200 – Erfolg
  • Client
  • 404 – Ressource nicht gefunden

Kunden aktualisieren

Endpunkt: /hosting/api/client/{clientId}

Methode: PUT

Query:

  • {clientId}: string – Die ID eines CCM19-Kundenkontos

Payload: Client

Response:

  • 200 – Erfolg
  • Client
  • 400 – Ungültige oder fehlende Eigenschaften
  • 404 – Ressource nicht gefunden

Kunden entfernen

Endpunkt: /hosting/api/client/{clientId}

Methode: DELETE

Query:

  • {clientId}: string – Die ID eines CCM19-Kundenkontos

Response:

  • 204 – Ressource erfolgreich gelöscht
  • 404 – Ressource nicht gefunden

Endpunkt: /hosting/api/clientgetid/{searchTerm}

Methode: GET

Query:

  • {searchTerm}: string – Benutzername oder E-Mail-Adresse

Response:

  • 200 – Erfolg
  • Client
  • 404 – Ressource nicht gefunden
Zurück zum Seitenanfang