Reviews

The Reviews API allows you to create, retrieve, update, and delete reviews for event occurrences. Reviews provide feedback from users about their experience.

Authentication

All requests to the Reviews API must be authenticated using the ONLIVE.SITE authentication scheme. Please refer to the Authentication Guide for detailed instructions.

Base URL

https://openapi.onlive.site/api/v1/reviews

Endpoints

• Create Review
• Get Review
• Update Review
• Search Reviews
• Delete Review

---

Create Review

Creates a new review for an event occurrence.

HTTP Request

POST /api/v1/reviews

Request Body

Field	Type	Required	Description
occurrenceId	string (uuid)	Yes	The ID of the event occurrence being reviewed
userId	string (uuid)	Yes	The ID of the user who is creating the review
rating	number	Yes	The rating given in the review (1-5 scale)
comment	string	No	The comment text for the review

Example Request Body

{
  "occurrenceId": "550e8400-e29b-41d4-a716-446655440000",
  "userId": "550e8400-e29b-41d4-a716-446655440002",
  "rating": 5,
  "comment": "Great event, very informative!"
}

Response

Returns the created Review object.

Example Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "550e8400-e29b-41d4-a716-446655440003",
  "occurrenceId": "550e8400-e29b-41d4-a716-446655440000",
  "userId": "550e8400-e29b-41d4-a716-446655440002",
  "rating": 5,
  "comment": "Great event, very informative!",
  "createdAt": "2025-10-21T12:00:00.000Z",
  "updatedAt": "2025-10-21T12:00:00.000Z"
}

---

Get Review

Retrieves a specific review by its ID.

HTTP Request

GET /api/v1/reviews/{id}

Path Parameters

Parameter	Type	Required	Description
id	string (uuid)	Yes	The unique identifier of the review

Query Parameters

Parameter	Type	Required	Description
withTrashed	boolean	No	Include trashed reviews

Response

Returns the Review object.

Example Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "550e8400-e29b-41d4-a716-446655440003",
  "occurrenceId": "550e8400-e29b-41d4-a716-446655440000",
  "userId": "550e8400-e29b-41d4-a716-446655440002",
  "rating": 5,
  "comment": "Great event, very informative!",
  "createdAt": "2025-10-21T12:00:00.000Z",
  "updatedAt": "2025-10-21T12:00:00.000Z"
}

---

Update Review

Updates an existing review.

HTTP Request

PUT /api/v1/reviews/{id}

Path Parameters

Parameter	Type	Required	Description
id	string (uuid)	Yes	The unique identifier of the review to update

Request Body

All fields are optional. Only the fields you want to update need to be included.

Field	Type	Required	Description
rating	number	No	The rating given in the review (1-5 scale)
comment	string	No	The comment text for the review

Example Request Body

{
  "rating": 4,
  "comment": "Updated comment about the event"
}

Response

Returns the updated Review object.

Example Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "550e8400-e29b-41d4-a716-446655440003",
  "occurrenceId": "550e8400-e29b-41d4-a716-446655440000",
  "userId": "550e8400-e29b-41d4-a716-446655440002",
  "rating": 4,
  "comment": "Updated comment about the event",
  "createdAt": "2025-10-21T12:00:00.000Z",
  "updatedAt": "2025-10-21T14:00:00.000Z"
}

---

Search Reviews

Returns a paginated list of reviews with optional filtering and sorting.

HTTP Request

GET /api/v1/reviews

Query Parameters

Parameter	Type	Required	Description
limit	number	No	Maximum number of items to return (default: 10, min: 1)
page	number	No	Page number (starts at 1, default: 1, min: 1)
sort	string	No	Field name and direction to sort results by (default: "createdAt DESC", example: "createdAt DESC")
occurrenceId	string (uuid)	No	Filter by event occurrence ID
userId	string (uuid)	No	Filter by user ID
withTrashed	boolean	No	Include soft-deleted reviews in the results

Example Request

GET /api/v1/reviews?limit=20&page=1&sort=rating DESC&occurrenceId=550e8400-e29b-41d4-a716-446655440000

Response

Returns a paginated list of Review objects.

Example Response

{
  "count": 1,
  "total": 1,
  "currentPage": 1,
  "totalPages": 1,
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "organizationId": "550e8400-e29b-41d4-a716-446655440003",
      "occurrenceId": "550e8400-e29b-41d4-a716-446655440000",
      "userId": "550e8400-e29b-41d4-a716-446655440002",
      "rating": 5,
      "comment": "Great event, very informative!",
      "createdAt": "2025-10-21T12:00:00.000Z",
      "updatedAt": "2025-10-21T12:00:00.000Z"
    }
  ]
}

---

Delete Review

Deletes a review.

HTTP Request

DELETE /api/v1/reviews/{id}

Path Parameters

Parameter	Type	Required	Description
id	string (uuid)	Yes	The unique identifier of the review to delete

Query Parameters

Parameter	Type	Required	Description
withTrashed	boolean	No	Include trashed reviews

Response

Returns the deleted Review object.

Example Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "550e8400-e29b-41d4-a716-446655440003",
  "occurrenceId": "550e8400-e29b-41d4-a716-446655440000",
  "userId": "550e8400-e29b-41d4-a716-446655440002",
  "rating": 5,
  "comment": "Great event, very informative!",
  "createdAt": "2025-10-21T12:00:00.000Z",
  "updatedAt": "2025-10-21T12:00:00.000Z"
}

---

Review Object

The Review object represents a user review for an event occurrence.

Properties

Property	Type	Description
id	string (uuid)	The unique identifier of the review
organizationId	string (uuid)	The ID of the organization the review belongs to
occurrenceId	string (uuid)	The ID of the event occurrence being reviewed
userId	string (uuid)	The ID of the user who created the review
rating	number	The rating given in the review (1-5 scale)
comment	string | null	The comment text for the review
organization	object	The organization associated with the review
createdAt	string (date-time)	The date and time when the review was created
updatedAt	string (date-time)	The date and time when the review was last updated
deletedAt	string (date-time)	The deletion date of the review (if deleted)

Example

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "550e8400-e29b-41d4-a716-446655440003",
  "occurrenceId": "550e8400-e29b-41d4-a716-446655440000",
  "userId": "550e8400-e29b-41d4-a716-446655440002",
  "rating": 5,
  "comment": "Great event, very informative!",
  "createdAt": "2025-10-21T12:00:00.000Z",
  "updatedAt": "2025-10-21T12:00:00.000Z"
}