API Conventions
This page defines conventions shared by all Geoportal API endpoints.
Requests
Section titled “Requests”- Base path:
https://www.lateral-robotics.com/api/v1 - Content type:
application/json; charset=utf-8 - Authentication: see Authentication
Responses
Section titled “Responses”- Success responses use
2xx. - Response bodies should be well-formed JSON.
- Timestamps use
ISO 8601 UTC.
Errors
Section titled “Errors”Error body shape:
{ "error": { "code": number, "message": string }, "requestId": string}| Status | Meaning |
|---|---|
400 | Invalid request |
401 | Not authenticated |
403 | Not authorized |
404 | Not found |
409 | Conflict |
429 | Rate limited |
5xx | Server error |
Example error response:
{ "error": { "code": 400, "message": "Invalid request" }, "requestId": "1234567890"}