Reviews API

v1.0 • REST • JSON

Full CRUD management for review accounts. Create, retrieve, update, and delete review records with built-in pagination and role-based access control support.

GET POST PUT DELETE 5 Endpoints
Base URL https://bogusapi.com/api/reviews

Quick Reference

GET
/api/reviews List all reviews (paginated)
200 GET
/api/reviews/{id} Get one review by ID
200 POST
/api/reviews Create a new review
201 PUT
/api/reviews/{id} Replace review data
204 DEL
/api/reviews/{id} Remove a review
204 GET
/api/reviews/{id} Review not found example
404
GET /api/reviews 200 OK

Get All Reviews

Retrieves a paginated list of all reviews in the system. Use the page and limit query parameters to navigate large result sets. The response envelope includes total count and page metadata.

Query Parameters
ParameterTypeDefaultDescription
page integer 1 Page number, 1-based index
limit integer 10 Number of records per page
Response: 200 OK
GET /api/reviews/{id} 200 OK

Get Single Review

Fetch the full profile for a specific review using their numeric ID. Returns all review fields including assigned role names and account metadata.

Path Parameters
ParameterTypeRequiredDescription
id integer Required Unique review identifier
Response: 200 OK
GET /api/reviews/{id} 404 Not Found

Review Not Found

Returned when the requested review ID does not exist in the system. Use this example to test error-handling logic and build graceful fallback UI for missing review resources.

Response: 404 Not Found
POST /api/reviews 201 Created

Create Review

Registers a new review with the provided details. On success, returns the newly created review object including the auto-generated ID, timestamp, and resolved role names.

Request Body
Field Type Required Description
name string Required Name
description string Optional Description
subjectName string Required Subject name
reviewerName string Required Reviewer name
rating integer Required Rating
reviewDate datetime Required Review date
source string Required Source
isVerified boolean Required Is verified
Body
Response: 201 Created
PUT /api/reviews/{id} 200 OK

Update Review

Fully replaces an existing review's data with the values in the request body. A successful update returns 200 OK with response body.

Request Body
Field Type Required Description
name string Required Name
description string Optional Description
subjectName string Required Subject name
reviewerName string Required Reviewer name
rating integer Required Rating
reviewDate datetime Required Review date
source string Required Source
isVerified boolean Required Is verified
Body
Response: 200 OK
DELETE /api/reviews/{id} 204 No Content

Delete Review

Permanently removes a review from the system by their ID. This action is irreversible once deleted, the review record and all associated data cannot be recovered through the API.

Path Parameters
ParameterTypeRequiredDescription
id integer Required ID of the review to delete
Response: 204 No Content