Overview
The Dealer Radius Assign API provides third-party websites a way to assign radius to dealers. Radius is used to determine the size of the dealer's lead routing area. This assigned dealer radius overrides the default radius for your Aimbase instance for the dealer/brand combination specified in the post.
Possible Response Codes
- 200 (OK). This request was successful. The radius was assigned to the dealer or the radius was already assigned to a dealer.
- 404 (Not Found). The dealer in the URL 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 information.
Authentication
The Dealer Radius API requires authentication. The HTTP POST 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}
Post Information
HTTP Endpoint
https://{baseurl}/odata/V2/Dealers{id}/AimbaseOData.DealerMethods.SetDealerRadius
Dealer Radius Assign Data Schema
Field Name |
Required |
Format |
Description |
Radius |
|
Max Length: 50 |
Number Value. |
BrandId |
|
Max Length: 50 |
A valid Brand Id in the system. |
XML Example Post
POST https://traversebikes.aimbase.com/odata/V2/Dealers(1)/AimbaseOData.DealerMethods.SetDealerRadius
Authenticate: Avala-Api {your authentication token}
Content-Type: application/xml
<?xml version="1.0" encoding="UTF-8" ?>
<root>
<BrandId>1</BrandId>
<Radius>10</Radius>
</root>JSON Example Post
POST https://traversebikes.aimbase.com/odata/V2/Dealers(1)/AimbaseOData.DealerMethods.SetDealerRadius
Authenticate: Avala-Api {your authentication token}
Content-Type: application/json
{
"BrandId": 1,
"Radius": 10
}