Client

Overview

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 clients

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

Customer search by user name

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

Method:GET

Query:

• {username}: string - user name

Response:

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

Client search for API key

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

Method:GET

Query:

• {apiKey}: string - API key

Response:

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

Client search (obsolete)

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

Method:GET

Query:

• {searchTerm}: string - user name or e-mail address

Response:

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