Routes API

v1.0 • REST • JSON

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

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

Quick Reference

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

Get All Routes

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

Get Single Route

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

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

Route Not Found

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

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

Create Route

Registers a new route with the provided details. On success, returns the newly created route 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
origin string Required Origin
destination string Required Destination
distanceKm decimal Required Distance km
estimatedDurationMinutes integer Required Estimated duration minutes
transportMode string Required Transport mode
isActive boolean Required Is active
Body
Response: 201 Created
PUT /api/routes/{id} 200 OK

Update Route

Fully replaces an existing route'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
origin string Required Origin
destination string Required Destination
distanceKm decimal Required Distance km
estimatedDurationMinutes integer Required Estimated duration minutes
transportMode string Required Transport mode
isActive boolean Required Is active
Body
Response: 200 OK
DELETE /api/routes/{id} 204 No Content

Delete Route

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

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