L. Ratings
The Ratings API provides access to Objects’ Ratings. This is only accessible when mimicking a user via a token authentication. The average rating of an object an be found in each object type’s data by looking in the for rating under the item data.
| Action | Method | URI |
|---|---|---|
| List Ratings | GET | /rating/api |
| Create or Update a Rating | POST | /rating/api |
| Delete a Rating | DELETE | /rating/api |
Rating Object Association
Ratings are associated with an object. You must include both the following parameters for every request to the Ratings API.
| Parameter | Example | Details |
|---|---|---|
| type | exhibitor | Required, One of exhibitor, user, feature, event, map |
| id | 50 | Required, Associated object’s ID |
Listing Ratings
These query parameters are available for listing Ratings.
| Parameter | Details | Default |
|---|---|---|
| page | Page number of records | 1 |
| limit | Number of records to return | 20 |
Rating Value
Every rating has a rating value. This value must be an integer 1 through 5.
| Parameter | Example | Details |
|---|---|---|
| rating | 3 | The integer rating value |
JSON Response Example
{
"item_id": 25,
"user_id": 1,
"rating": 4,
"about_type": "map",
"about_id": 1,
"type": "rating"
}
XML Response Example
<?xml version="1.0" encoding="UTF-8"?> <rating> <item-id type="integer">25</item-id> <user-id type="integer">1</user-id> <rating type="integer">4</rating> <about-type>map</about-type> <about-id type="integer">1</about-id> </rating>
Leave a Comment
