The Vendor REST API is designed to expose the capability to get the vendors information.
The operation returns all Vendors.
| Method | Request URI | HTTP Version |
|---|---|---|
| GET | {eBHDomain}/vendors/api/v1/vendor | HTTP/1.1 |
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), */*. |
The response includes an HTTP status code, a set of response headers and a response body, which contains an array of vendors.
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 header | Description |
|---|---|
| OperationId | The unique identifier associated with the request. |
A request was successfully processed:
The response represents an array of objects.
{
"Vendors":[
{
"Id":5,
"Name":"Phico Insurance Company",
"IsAutoSubmit": false
},
{
"Id":33,
"Name":"National City Bank",
"IsAutoSubmit": true
},
{
"Id":6001,
"Name":"Johnson & Johnson (LEDES98B)",
"IsAutoSubmit": true
}
]
}An error occurred while processing a request:
{
"Message": "An unexpected error occurred. Please, contact the support team."
}