DealerRater for Developers

Review Entity

The review entity contains information about a single dealer review posted by a DealerRater user. The review may be positive or negative, it includes individual category ratings, dealer employees may by optionally tagged, etc. Find below a sample review entity in XML format (they may also be returned in JSON format, but the translation should be straightforward). Each attribute of the review is also detailed below.

Sample Review XML

Review Attributes

Attribute Type Description R/W1 Validation
Id int The review's primary key. Used to uniquely identify a review in the system. R N/A
DealerId int The primary key of the dealer to which this review was posted on. R N/A
UserId int The primary key of the DealerRater user that posted the review. R N/A
UserName string The DealerRater user name for the user that wrote the review (the user name associated with the given UserId). R N/A
UserEmailAddress string When creating a new review, you must provide the email address of the user that originally authored the content. We use this email address to register a new user in our system that "owns" or is considered the "reviewer" of the review being created. If the given email address is already associated with a user in our system, the new review will be associated with the pre-existing account. W+ No more than 255 characters.
UserIpAddress string The IP address of the user that authored the review. This is used for internal auditing only. W+ Must be a valid IP address.
Department Enumeration Defines the department the review was written against. Valid values include SALES2, SALES_NEW, SALES_USED, SERVICE, LEASE_NEW and LEASE_USED. RW+ Must be a valid department for this dealer.3
ManufacturerId 3 int The ID of the manufacturer the review was written for (Ford, Honda, etc). RW+ Must be a valid manufacturer for this dealer.3
Messages Array This attribute contains an array of Messages that have been posted on the review. Messages are the principal means of correspondence (outside the review content itself) between the dealer, the reviewer and the review readers on our site. While private messages have the possibility of being added in the future, for now this array will contain only the public messages from the dealer to the consumer. R N/A
EmployeeNames String A free-form field in which the reviewer entered a list of employee names that they worked with. This can be done in addition to tagging employees on reviews. RW No more than 255 characters.
Employees Array This attribute contains an array of Employees that have been tagged on the review. If you are creating a review and wish to tag existing employees on that review, use the TaggedEmployees element instead. R N/A
TaggedEmployees Array When creating new reviews in the system, use this element (you can nest several TaggedEmployee values in the container) to specify tagged employees. The review will be created with the given Employees pre-tagged with optional rating values. You can find out what employees can be tagged on reviews by calling the Dealer Employees Collection API. W N/A
ReviewTitle String A title for the review, entered by the reviewer. Typically a one-sentence synopsis, much shorter than the content. RW+ No more than 60 characters.
ReviewContent String The actual review content the user entered. RW+ Must contain at least 25 words. No more than 4000 characters.
RecommendDealer Boolean Whether or not the reviewer recommends the dealer. Note that this value is distinct from the individual ratings. RW+ N/A
Rating/Average double A precomputed average of the entered ratings (saves clients the need to do it). If a reviewer did not enter a value for a given category, that value is not included in the average. R N/A
Rating/CustomerService int The customer service rating (from 1 to 5). If the element is empty or 0, the reviewer did not enter a value and it should be ignored as not applicable. RW+ 4 N/A
Rating/Friendliness int The friendliness rating (from 1 to 5). If the element is empty or 0, the reviewer did not enter a value and it should be ignored as not applicable. RW+ 4 N/A
Rating/Price int The price rating (from 1 to 5). If the element is empty or 0, the reviewer did not enter a value and it should be ignored as not applicable. RW+ 4 N/A
Rating/QualityOfWork int The quality of work rating (from 1 to 5). If the element is empty or 0, the reviewer did not enter a value and it should be ignored as not applicable. RW+ 4 N/A
Rating/OverallExperience int The overall experience rating (from 1 to 5). If the element is empty or 0, the reviewer did not enter a value and it should be ignored as not applicable. RW+ 4 N/A
DateEntered 5 DateTime (ISO-8601) When the review was originally written. R N/A
DateActive 5 DateTime (ISO-8601) When the review was posted to the website. R N/A
DateLastModified DateTime (ISO-8601) When the review was last updated by the reviewer. The reviewer can update their reviews at any time and this will let you know the most recent update date. R N/A
1: Denotes whether the attribute is read, write (optional) or write (required). If the attribute is denoted with an "R", it indicates the attribute may be read from the server by invoking GET calls. If the attribute is denoted with a "W", the attribute may be sent with INSERT or UPDATE calls, but it is not required. A W+ indicates the attribute may be written, and it is required. Any posts with W+ attributes missing entirely or empty will result in validation failures.
2: Note that the SALES value is deprecated and was used before sales reviews were split between new and used automobiles. New reviews cannot be created using this value, but retrieval of older reviews in the system might still use it. As such, you should ensure that, as a consumer, you can handle it for rendering purposes.
3: You can determine what the manufacturer ID refers to (Ford, Acura, etc) by making a call to our Manufacturers Collection API. The valid combinations of Department and ManufacturerId can be obtained for any given dealer by calling the Dealer Department Manufactuers Collection API.
4: Although all five Rating fields are denoted as being required for write (W+), you must submit only a single value to pass our validation. Said another way, you may supply any number of ratings you wish, so long as you supply at least one.
5: In most cases, DateActive and DateEntered will be the same. Occasionally, they might be different (in the case of a first-time reviewer or certain negative reviews). For the purposes of displaying when a review was posted to our website, you should always display DateActive and ignore DateEntered.