Dealer Employees Collection
This is a dealer-oriented API that can be used to retrieve a list of internet and sales department employees at a given dealer. The API only supports the GET verb (fetching data). Note that the results of this API are cached on the DealerRater servers for optimization purposes (as such, new and/or updated employees might not be available through this API for a short while). The returned list is sorted by the total number of reviews the employees are tagged on in descending order (so the employee with the most reviews is first, and the one with the least is last). Matching review counts are ordered (secondarily) by the employee's name.
/Dealers/[dealerId]/ConnectionsEmployees
Attribute | Description |
dealerId |
Set this to the ID of the dealer to fetch employees for. |
For example, the URL for the employees collection for dealer ID 47 is
/Dealers/47/ConnectionsEmployees.
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 employee information for a given dealer.
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 the employees for the given dealer. 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 |
ConnectionsEmployee | Defines a single internet or sales employee 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.