Loading…
Sets the authenticated user's rating for a specified element (gym or training service). If the user has not rated the element yet, a new rating is created. If they have already rated it, the existing rating is updated with the new score.
| Permission | Description |
|---|---|
| view (ratable) | Must have view permission on the ratable |
ratings.create | Rate an element |
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
| ratable_type | string |
| Yes |
Type of the element (gym or training_service) |
| "gym" |
| ratable_id | int | Yes | ID of the element to rate | 10 |
| score | int | Yes | Score between 1 and 5 | 5 |
{
"ratable_type": "gym",
"ratable_id": 10,
"score": 5
}
Returned when a new rating was created. Returns the created rating resource.
{
"data": {
"id": 123,
"user_id": 42,
"ratable_type": "App\\Models\\Gym",
"ratable_id": 10,
"score": 5
}
}
Returned when the user already had a rating and it was updated. Returns the updated rating resource.
{
"data": {
"id": 123,
"user_id": 42,
"ratable_type": "App\\Models\\Gym",
"ratable_id": 10,
"score": 4
}
}
For a full schema, see Rating Resource.
| Status | Description | Reference |
|---|---|---|
| 422 | Validation error | Validation error |
| 401 | Unauthorized | Authentication error |
| 403 | Forbidden (no permission) | Permission error |