Zum Inhalt

Client

Overview

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

Create Clients

Endpoint: /hosting/api/client

Method: POST

Payload: Client

Response:

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

Retrieve all clients

Endpoint: /hosting/api/client

Method: GET

Response:

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

Read clients

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

Method: GET

Query:

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

Response:

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

Update clients

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

Method: PUT

Query:

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

Payload: Client

Response:

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

Delete client

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

Method: DELETE

Query:

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

Response:

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

Search for a client by username

Endpoint: /hosting/api/client/by-username/{username}

Method: GET

Query:

  • {username}: string – Username

Response:

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

Customer search by API-key

Endpoint: /hosting/api/client/by-apiKey/{username}

Method: GET

Query:

  • {apiKey}: string – API-key

Response:

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

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

Method: GET

Query:

  • {searchTerm}: string – Username or E-mail address

Response:

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