Zum Inhalt

Client

Overview

Description Method Endpoint
Create client POST /hosting/api/client
Read all clients GET /hosting/api/client
Read clients GET /hosting/api/client/{clientId}
Update client PUT /hosting/api/client/{clientId}
Remove client DELETE /hosting/api/client/{clientId}
Search clients by username GET /hosting/api/client/by-username/{username}
Customer search for API-key GET /hosting/api/client/by-apiKey/{apiKey}
Client search (deprecated) GET /hosting/api/clientgetid/{searchTerm}

Create client

Endpoint:/hosting/api/client

Method:POST

Payload:Client

Response:

  • 201 - Resource successfully created
  • Client
  • 400 - Invalid or missing properties

Read all clients

Endpoint:/hosting/api/client

Method:GET

Response:

  • 200 - Success
  • Client[] - Specific to this endpoint, each element also contains the following properties:
  • actualCallCount: int
  • domainCountData: Array.\

Read customer

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

Method:GET

Query:

  • {clientId}: string - The ID of a CCM19-client account

Response:

  • 200 - Success
  • Client
  • 404 - Resource not found

Update client

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

Method:PUT

Query:

  • {clientId}: string - The ID of a CCM19-client account

Payload:Client

Response:

  • 200 - Success
  • Client
  • 400 - Invalid or missing properties
  • 404 - Resource not found

Remove client

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

Method:DELETE

Query:

  • {clientId}: string - The ID of a CCM19-client account

Response:

  • 204 - Resource successfully deleted
  • 404 - Resource not found