Genres API

v1.0 • REST • JSON

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

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

Quick Reference

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

Get All Genres

Retrieves a paginated list of all genres 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/genres/{id} 200 OK

Get Single Genre

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

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

Genre Not Found

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

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

Create Genre

Registers a new genre with the provided details. On success, returns the newly created genre 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
categoryGroup string Required Category group
audienceRating string Required Audience rating
typicalRuntimeMinutes integer Required Typical runtime minutes
isFamilyFriendly boolean Required Is family friendly
Body
Response: 201 Created
PUT /api/genres/{id} 200 OK

Update Genre

Fully replaces an existing genre'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
categoryGroup string Required Category group
audienceRating string Required Audience rating
typicalRuntimeMinutes integer Required Typical runtime minutes
isFamilyFriendly boolean Required Is family friendly
Body
Response: 200 OK
DELETE /api/genres/{id} 204 No Content

Delete Genre

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

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