Overview
The Dealer Integration Type OData API provides a way to retrieve active integration types from a particular Aimbase. With multiple filter and expand options, this API can tell you anything from a list of active integrations in an Aimbase instance, to required key (username, password etc) fields needed to pass leads to the correct dealer. This document will go over how you can use the Dealer Integration Type OData for your specific needs.
This is an OData endpoint, and it will support the OData query language. More information about this can be found at odata.org.
Possible Response Codes
- 200 (OK). This request was successful and information will be returned.
- 401 (Unauthorized). The token is missing or invalid.
- 404 (Not Found). The dealer was not able to be found.
- 500 (Internal Server Error). The request was malformed, the dealer given in the request did not exist, or some other unspecified error occurred when attempting to retrieve dealer integration type information.
Authentication
The Dealer Integration Type API requires authentication. The GET request will require a valid Authenticate message header with an API token. See the Aimbase Authentication Web Service Specification for more details on how to retrieve a valid API token.
Authenticate message header example:
Authenticate: Avala-Api {username}:{token}Query Information
Endpoint
GET https://{baseurl}/odata/V2/DealerIntegrationTypesDealer Integration Type OData Data Schema
The information below will be returned in a GET. All fields listed below can be applied as a filter. For filter formatting in OData, please reference this page and navigate to section 4.5. Filter System Query Option to see operators and examples.
Name |
Editable | Values |
Description |
| Id | Integer | The Aimbase id of the Integration Type | |
| Code | String | The code for the integration type. | |
| Name | UID | The name of the integration type. | |
| Description | Integer | The description of the integration type. | |
| IsActive | Integer | If the integration type is active or not. | |
| CreatedDate | YYYY-MM-dd ±hh:mm |
The date the integration type was entered. |
|
| UpdateDate | YYYY-MM-dd ±hh:mm | The date the integration type was updated. | |
| CreateAccountId | Integer | The id of the account that created the lead | |
| UpdateAccountId | Integer | The id of the account that created the lead |
|
| IsKeyRequired | Boolean | The integration's requirement to pass a key value when sending leads. | |
| IsUsernameRequired | Boolean |
The integration's requirement to pass a username value when sending leads. |
|
| IsPasswordRequired | Boolean |
The integration's requirement to pass a password value when sending leads. |
|
| IsClientIdRequired | Boolean |
The integration's requirement to pass a ClientId value when sending leads. |
|
| IsClientSecretRequired | Boolean |
The integration's requirement to pass a ClientSecret value when sending leads. |
|
| IsSendingDealerIntegrationOnReassign | Boolean | If the OEM is using the lead reroute feature, and the lead is reassigned, the lead can still send to the reassigned dealer's CRM or not. |
Sample Queries
ALL
GET https://{baseurl}/Odata/V2/DealerIntegrationTypesGet By ID
GET https://{baseurl}/Odata/V2/DealerIntegrationTypes(1)Filter
GET https://{baseurl}/Odata/V2/DealerIntegrationTypes?$filter=Code eq '3 Clix HTTP/1.1Example Response
"value": [
{
"Id": 1,
"Code": "(provider code)",
"Name": "(provider name)",
"Description": "(provider name) is a Dealer CRM",
"IsActive": true,
"CreateDate": "2015-06-15T18:28:52.273+05:30",
"UpdateDate": "2015-08-31T17:25:04.19+05:30",
"CreateAccountId": 0,
"UpdateAccountId": 4,
"IsKeyRequired": true,
"IsUsernameRequired": false,
"IsPasswordRequired": false,
"IsClientIdRequired": false,
"IsClientSecretRequired": false,
"IsSendingDealerIntegrationOnReassign": false
},