Flights API

v1.0 • REST • JSON

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

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

Quick Reference

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

Get All Flights

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

Get Single Flight

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

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

Flight Not Found

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

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

Create Flight

Registers a new flight with the provided details. On success, returns the newly created flight 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
flightNumber string Required Flight number
airline string Required Airline
origin string Required Origin
destination string Required Destination
departureTime datetime Required Departure time
arrivalTime datetime Required Arrival time
status string Required Status
Body
Response: 201 Created
PUT /api/flights/{id} 200 OK

Update Flight

Fully replaces an existing flight'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
flightNumber string Required Flight number
airline string Required Airline
origin string Required Origin
destination string Required Destination
departureTime datetime Required Departure time
arrivalTime datetime Required Arrival time
status string Required Status
Body
Response: 200 OK
DELETE /api/flights/{id} 204 No Content

Delete Flight

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

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