POST /api/v1/ratings

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.

Permissions

Request Body Parameters

Request Example

{
  "ratable_type": "gym",
  "ratable_id": 10,
  "score": 5
}

Response

201 Created

Returned when a new rating was created. Returns the created rating resource.

Example

{
  "rating": {
    "id": 123,
    "user_id": 42,
    "ratable_type": "App\\Models\\Gym",
    "ratable_id": 10,
    "score": 5
  }
}

For a full schema, see Rating Resource.

200 OK

Returned when the user already had a rating for this element and it was updated. Returns the updated rating resource.

Example

{
  "rating": {
    "id": 123,
    "user_id": 42,
    "ratable_type": "App\\Models\\Gym",
    "ratable_id": 10,
    "score": 4
  }
}

For a full schema, see Rating Resource.

Error Responses