Dealer Reviews Collection

This is a consumer-oriented API that can be used to fetch or create reviews on our server for a given dealer.

/Dealers/[dealerId]/Reviews

Attribute	Description
dealerId	Set this to the ID of the dealer to fetch reviews for.

For example, the URL for the reviews collection for dealer ID 47 is /Dealers/47/Reviews.

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

This API is used to retrieve a paginated list of reviews for a given dealer. A variety of mechanisms are available to filter the returned data as well. Note that the results of this API are cached on the DealerRater servers for optimization purposes (as such, new reviews posted to dealers might not be available through this API for a short while). The results are always returned with the latest reviews first, with older reviews following in descending chronological order.

Request Parameters

Parameter	Description	Example	Default
startItem	Used to identify the first item in the paged collection to be returned. If you set this to 20, then the response will include reviews starting at review #20.	startItem=20	0
itemsPerPage	Identifies the number of items to be returned with each page of results.	itemsPerPage=20	MAX_INT
filterReviewType	Applies a filter on the type of review. ALL_REVIEWS returns all the reviews; ONLY_POSITIVE returns only positive reviews; ONLY_NEGATIVE returns only negative reviews; ONLY_SALES returns all new and used sales reviews; and ONLY_SERVICE returns only service reviews.	filterReviewType=ONLY_POSITIVE	ALL_REVIEWS

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 reviews matching the given 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.
PagingContext	Paging criteria.
Review	Defines a single Review in the system.
ReviewPageUrl	The URL in DealerRater's system that is home to all of the reviews for this dealer.

<DealerReviewsGetCollectionResponse>
  <Status>...</Status>
  <PagingContext>...</PagingContext>
  <ReviewPageUrl>http://www.dealerrater.com/dealer/Bozard-Ford-Lincoln-review-2259/</ReviewPageUrl>
  <Reviews>
    <Review>...</Review>
    <Review>...</Review>
    <Review>...</Review>
  </Reviews>
</DealerReviewsGetCollectionResponse>

INSERT

Creation of new reviews via Insert API is no longer supported.

UPDATE

This API does not support the UPDATE verb.

DELETE

This API does not support the DELETE verb.