The Client REST API is designed to expose the capability to get the clients information.

 

Get Clients

The operation returns all Clients.

Request

Method Request URI HTTP Version
GET {eBHDomain}/client/api/v1/client HTTP/1.1

URI Parameters

The following table describes required and optional URI parameters.

Parameter Description
ProducerId Optional. The Id of the firm for which to return clients. If ProducerId not specified clients for all producer ids are returned.

Request Headers

The following table describes required and optional request headers.

Request header Description
ProducerId Required. Specifies the client on behalf of which the request is sent.
ProviderKey Required. Specifies the access token.
Username Optional. Specifies the user on behalf of which the request is sent. The value is used for reporting purposes only and defined by the caller.
Accept Optional. Specifies the expected response format. A list of valid values: application/json (default), */*. 

Response

The response includes an HTTP status code, a set of response headers and a response body, which contains an array of the clients.

Status Codes

A successful operation returns status code 200 (OK).

Status code Description
200 OK The request was created successfully. See the response body for details.
400 BAD REQUEST The request was incorrectly formatted, missing a required header or parameters were invalid.
401 UNAUTHORIZED The Provider Key is not authorized.
403 FORBIDDEN The requestor is not authorized to view the response.
406 NOT ACCEPTABLE Provided Accept HTTP Header is not supported.
500 INTERNAL SERVER ERROR Something went wrong.

Response Headers

Response header Description
OperationId The unique identifier associated with the request.

Response Body

A request was successfully processed:

The response represents an array of objects.

{
   "Clients":[
      {
         "ClientId": 5,
         "ClientName": "Phico Insurance Company",
         "IsActive": false,
         "VendorId": 2
      },
      {
         "ClientId": 33,
         "ClientName": "National City Bank",
         "IsActive": false,
         "VendorId": 15
      },
      {
         "ClientId": 6001,
         "ClientName": "Johnson & Johnson (LEDES98B)",
         "IsActive": true,
         "VendorId": 136
      }
   ]
}

An error occurred while processing a request:

{
   "Message": "An unexpected error occurred. Please, contact the support team."
}