Dealers Collection
Use this API to retrieve information about one more dealerships in the DealerRater system. The API only supports the GET verb (fetching data).
/Dealers
Common Request Parameters
All APIs support the following request parameters, in addition to any API specific parameters.
| Parameter | Description | Example |
| t |
json or xml. Identifies if you want to communicate in JSON or XML format. |
t=xml |
| s |
Your DealerRater supplied security token. This must be sent with every request. |
s=00000000-0000-0000-0000-000000000000 |
| method |
GET, INSERT, UPDATE or DELETE. Identifies the REST verb. |
method=GET |
GET
Use the GET verb to retrieve dealership metadata.
Request Parameters (by ID)
Use these request parameters to retrieve dealer metadata by a DealerRater assigned ID.
| Parameter | Description | Example | Default |
| dealerIds |
The ID(s) of the dealerships to fetch in a comma separated format. |
dealerIds=1,2,3,4 |
N/A |
| includeAggregates |
If true, the API will return extra data on each dealer (hours, amenities, manufacturers, etc). There is a slight performance penalty for enabling this, use only if the data is required. |
includeAggregates=true |
false |
Request Parameters (Geo Location Search)
Use these request parameters to find dealers near a given latitude and longitude, and within a given radius.
| Parameter | Description | Example | Default |
| latitude |
The latitude to search around, specified in radians. To get radians from degrees, multiply by PI/180.0. |
latitude=0.73333471255777700 |
N/A |
| longitude |
The longitude to search around, specified in radians. To get radians from degrees, multiply by PI/180.0. |
longitude=-1.24305654980639000 |
N/A |
| radius |
The radius to search for dealers around the provided latitude and longitude, specified in km. The max allowable radius is currently 30km. |
radius=30 |
N/A |
| includeAggregates |
If true, the API will return extra data on each dealer (hours, amenities, manufacturers, etc). There is a slight performance penalty for enabling this, use only if the data is required. |
includeAggregates=true |
false |
Request Parameters (Metadata Search)
Use this search to find dealers by some piece of metadata. You must send all parameters with the request, even if they do not contain a value (for
example, if you are searching for phoneNumber=111-111-1111 you must also supply name=&postalCode=&). The API will return the top 100 matches
found in our system.
| Parameter | Description | Example | Default |
| name |
The name of the dealership to search on. If given, it must be two characters in length and you must also supply a postal code. |
name=Boston+Toyota or name= |
N/A |
| postalCode |
The postalCode is only required if you supply a name or an address to filter on; if given, it must be at least 5 characters in length. The postalCode
filter is only valid in the context of a dealer name search (supplying the name parameter with a value) or the address search.
|
postalCode=02451 or postalCode= |
N/A |
| phoneNumber |
The phone number to search on. Leave blank to search on other attributes. |
phoneNumber=543 or phoneNumber= |
N/A |
| address |
The address to search on. To be used with postalCode parameter. Leave blank to search by name or phoneNumber. |
address=730 Sea St |
N/A |
| includeAggregates |
If true, the API will return extra data on each dealer (hours, amenities, manufacturers, etc). There is a slight performance penalty for enabling this, use only if the data is required. |
includeAggregates=true |
false |
Request Parameters (Manfuacturer Search)
Use these request parameters to find dealers that have been flagged as OEM retailers of a given manufacturer. To find the ID of the manufacturer to
utilize with this API, please refer to the
Manufacturers Collection API.
Using this API, you can easily find all of our Mazda dealers, Toyota dealers, Honda dealers, etc.
| Parameter | Description | Example | Default |
| manufacturerId |
The ID of the manufacturer to filter our dealers on. |
manufacturerId=1 |
N/A |
| includeAggregates |
If true, the API will return extra data on each dealer (hours, amenities, manufacturers, etc). There is a slight performance penalty for enabling this, use only if the data is required. |
includeAggregates=true |
false |
| startItem |
Used to identify the first dealer in the paged collection to be returned. If you set this to 20, then the response will start at dealer #20. Use this parameter in conjunction with itemsPerPage to keep the API response sizes to a manageable level. |
startItem=20 |
0 |
| itemsPerPage |
The maximum number of dealers to return for this call. Use this parameter in conjunction with startItem to keep the API response sizes to a manageable level. |
itemsPerPage=10 |
MAX_INT |
Request XML/JSON
This API does not accept XML or JSON data in the request.
Response
The API will respond with an XML or JSON document with dealers matching the request criteria. A sample XML response is indicated in the code block below, with a downloadable sample mock provided in either
XML or
JSON format. Note that the response document will include references to the following object types:
| Entity | Description |
| Status | API call status. |
| Dealer | Defines a single Dealer in the system. |
INSERT
This API does not support the INSERT verb.
UPDATE
This API does not support the UPDATE verb.
DELETE
This API does not support the DELETE verb.