TV Shows API
v1.0 • REST • JSON
Full CRUD management for tv show accounts. Create, retrieve, update, and delete tv show records with built-in pagination and role-based access control support.
Quick Reference
/api/tv-shows
200 OK
Get All TV Shows
Retrieves a paginated list of all tvshows in the system. Use the page
and limit query parameters to navigate large result sets.
The response envelope includes total count and page metadata.
| Parameter | Type | Default | Description |
|---|---|---|---|
page |
integer | 1 |
Page number, 1-based index |
limit |
integer | 10 |
Number of records per page |
/api/tv-shows/{id}
200 OK
Get Single TV Show
Fetch the full profile for a specific tv show using their numeric ID. Returns all tv show fields including assigned role names and account metadata.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
integer | Required | Unique tv show identifier |
/api/tv-shows/{id}
404 Not Found
TV Show Not Found
Returned when the requested tv show ID does not exist in the system. Use this example to test error-handling logic and build graceful fallback UI for missing tv show resources.
/api/tv-shows
201 Created
Create TV Show
Registers a new tv show with the provided details. On success, returns the newly created tv show object including the auto-generated ID, timestamp, and resolved role names.
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | Required | Name |
description |
string | Optional | Description |
network |
string | Required | Network |
genreName |
string | Required | Genre name |
firstAirDate |
datetime | Required | First air date |
seasons |
integer | Required | Seasons |
episodes |
integer | Required | Episodes |
imdbRating |
decimal | Required | Imdb rating |
isOngoing |
boolean | Required | Is ongoing |
/api/tv-shows/{id}
200 OK
Update TV Show
Fully replaces an existing tv show's data with the values in the request body. A successful update returns 200 OK with response body.
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | Required | Name |
description |
string | Optional | Description |
network |
string | Required | Network |
genreName |
string | Required | Genre name |
firstAirDate |
datetime | Required | First air date |
seasons |
integer | Required | Seasons |
episodes |
integer | Required | Episodes |
imdbRating |
decimal | Required | Imdb rating |
isOngoing |
boolean | Required | Is ongoing |
/api/tv-shows/{id}
204 No Content
Delete TV Show
Permanently removes a tv show from the system by their ID. This action is irreversible once deleted, the tv show record and all associated data cannot be recovered through the API.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
integer | Required | ID of the tv show to delete |