PUT
/api/spaces/{id}
{
"color": "Red",
"make": "Toyota",
"model": "Corolla",
"manufacturingYear": 2022,
"licensePlate": "ABC-123"
}Parking Lot API Documentation
Base URL: Hosted on AWS ECS
This service exposes parking lot inventory, floor and section lookup, parking-space mutation, analytics, diagnostics, chat, contact, and integration endpoints.
The production deployment is hosted on AWS using ECS behind the public API URL configured for this environment.
Public writes are limited to parking-space updates, analytics events, contact messages, and chat. Lot, floor, and section creation is handled outside the public API.
Capacity limits are enforced in the domain: lots may have up to 6 floors, floors up to 10 sections, and sections up to 10 parking spaces.
GET
POST
PUT
DELETE
Parking Lots
Top-level parking lot lookup and nested floor details.
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/lots | Get all parking lots. |
| GET | /api/lots/{id} | Get a parking lot by ID. |
| GET | /api/lots/{lotId}/floors/{floorId}/details | Get floor details for a specific lot and floor. |
Floors
Floor-level data within a parking lot.
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/floors | Get all floors. |
| GET | /api/floors/{id} | Get a floor by ID. |
Sections
Sections group parking spaces on a floor.
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/sections | Get all sections. |
| GET | /api/sections/{id} | Get a section by ID. |
Parking Spaces
Parking-space lookup and occupancy updates.
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/spaces | Get all parking spaces. |
| GET | /api/spaces/{id} | Get a parking space by ID. |
| PUT | /api/spaces/{id} | Assign a car to an empty parking space. |
| DELETE | /api/spaces/{id} | Remove a car from an occupied parking space. |
Analytics
Record events and query aggregated analytics.
| Method | Endpoint | Description |
|---|---|---|
| POST | /api/analytics | Record an analytics event. |
| POST | /api/analytics/search | Query analytics with filters. |
Chat and Contact
User-facing support endpoints.
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/recent-interactions | Get recent chatbot interactions. |
| POST | /api/chat | Submit a chat question. |
| POST | /api/contact | Send a contact message. |
Diagnostics, Integrations, and Events
Operational visibility, deployment info, and SSE updates.
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/diagnostics/ping | Lightweight health ping. |
| GET | /api/diagnostics/api | API diagnostics including request and heap metrics. |
| GET | /api/diagnostics/database | Database diagnostics. |
| GET | /api/diagnostics/mongodb | MongoDB diagnostics. |
| GET | /api/integrations/bk | Buildkite build information. |
| GET | /api/integrations/deploy | Deployment information. |
| GET | /api/lots/{lotId}/floors/{floorId}/events | Subscribe to floor SSE updates. |
Sample JSON Request Bodies
Examples for the current write endpoints.
POST
/api/chat
{
"question": "How many floors are available?"
}
POST
/api/contact
{
"subject": "Support request",
"message": "I need help with a parking space update."
}