Locations API

v1.0 • REST • JSON

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

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

Quick Reference

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

Get All Locations

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

Get Single Location

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

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

Location Not Found

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

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

Create Location

Registers a new location with the provided details. On success, returns the newly created location 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
state string Required State
country string Required Country
postalCode string Required Postal code
latitude decimal Required Latitude
longitude decimal Required Longitude
Body
Response: 201 Created
PUT /api/locations/{id} 200 OK

Update Location

Fully replaces an existing location'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
state string Required State
country string Required Country
postalCode string Required Postal code
latitude decimal Required Latitude
longitude decimal Required Longitude
Body
Response: 200 OK
DELETE /api/locations/{id} 204 No Content

Delete Location

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

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