Overview
Use the Dealer Contact OData to create, retrieve and update dealer contact information. This API supports multiple filter and expand options, allowing you to retrieve a list of contacts or just (1).
If you are looking to POST or create a lead, you should visit the Lead API documentation.
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.
- 204 (No Content). The patch was successful.
- 400 (Bad Request). The request is invalid.
- 401 (Unauthorized). The token is missing, invalid, or expired.
- 404 (Not Found). The lead was not able to be found.
- 500 (Internal Server Error). The request was malformed, the lead given in the request did not exist, or some other unspecified error occurred when attempting to retrieve lead information.
Authentication
The Dealer Contact OData requires authentication. The GET (many), GET (one), POST and PATCH request will require a valid Authenticate message header with an API token. See the Aimbase Authentication API for more information on how to authenticate your request.
Authenticate message header example:
Authenticate message header example:
Authenticate: Avala-Api {username}:{token}Query Information
Endpoint
GET https://{baseurl}/odata/V2/DealerIntegrationTypes
Dealer Contact 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.
Add list here.
| Name | Editable | Values | Description | ||
| Id |
|
Integer | The Aimbase id of the Integration Type | ||
| ContactUid |
|
String | The code for the integration type. | ||
| FirstName |
|
UID | The name of the integration type. | ||
| LastName |
|
Integer | The description of the integration type. | ||
| IsActive |
|
Integer | If the integration type is active or not. | ||
| IsAvailable | |||||
| LastLeadAssignedDate | |||||
| 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. | ||
| Title |
|
Integer | The id of the account that created the lead | ||
| PrimaryPhone |
|
Integer |
The id of the account that created the lead
|
||
| SecondaryPhone |
|
Boolean | The integration's requirement to pass a key value when sending leads. | ||
| Fax |
|
Boolean
|
The integration's requirement to pass a username value when sending leads.
|
||
| CountryCode |
|
Boolean
|
|
||
| DealerId |
|
Boolean
|
The integration's requirement to pass a ClientId 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