Hotels API

v1.0 • REST • JSON

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

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

Quick Reference

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

Get All Hotels

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

Get Single Hotel

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

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

Hotel Not Found

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

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

Create Hotel

Registers a new hotel with the provided details. On success, returns the newly created hotel 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
city string Required City
country string Required Country
starRating integer Required Star rating
nightlyRate decimal Required Nightly rate
availableRooms integer Required Available rooms
amenities string Required Amenities
Body
Response: 201 Created
PUT /api/hotels/{id} 200 OK

Update Hotel

Fully replaces an existing hotel'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
city string Required City
country string Required Country
starRating integer Required Star rating
nightlyRate decimal Required Nightly rate
availableRooms integer Required Available rooms
amenities string Required Amenities
Body
Response: 200 OK
DELETE /api/hotels/{id} 204 No Content

Delete Hotel

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

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