Skip to content
aimrack

Vehicle Position

The vehicle position resource.

Base/vehiclePosition
GET/vehiclePosition

List vehicle positions

Retrieve a paginated list of vehicle positions. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GET/vehiclePosition
curl --request GET \
  --url '<your-host>/vehiclePosition?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "vehicleId": "xyz789",
    "recordedAt": "2026-01-01T00:00:00Z",
    "latitude": 0,
    "longitude": 0,
    "source": "string",
    "createdAt": "2026-01-01T00:00:00Z"
  }
]
GET/vehiclePosition

Retrieve a vehicle position

Fetch a single vehicle position by filtering on `id`.

Query parameters

idstring

Match on the vehicle position's `id`, e.g. `eq.{id}`.

GET/vehiclePosition
curl --request GET \
  --url '<your-host>/vehiclePosition?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "vehicleId": "xyz789",
  "recordedAt": "2026-01-01T00:00:00Z",
  "latitude": 0,
  "longitude": 0,
  "source": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}
POST/vehiclePosition

Create a vehicle position

Create a new vehicle position.

Body parameters

companyIdstringrequired

References company.id

vehicleIdstringrequired
routePlanIdstring

References routePlan.id

recordedAttimestamprequired
latitudenumberrequired
longitudenumberrequired
headingDegreesnumber
speedMilesPerHournumber
ignitionboolean
odometerMilesnumber
horizontalDilutionOfPrecisionnumber
sourcestringrequired
POST/vehiclePosition
curl --request POST \
  --url <your-host>/vehiclePosition \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"companyId":"xyz789","vehicleId":"xyz789","recordedAt":"2026-01-01T00:00:00Z","latitude":0,"longitude":0,"source":"string"}'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "vehicleId": "xyz789",
  "recordedAt": "2026-01-01T00:00:00Z",
  "latitude": 0,
  "longitude": 0,
  "source": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}
PATCH/vehiclePosition

Update a vehicle position

Update an existing vehicle position, matched on `id`.

Body parameters

companyIdstringrequired

References company.id

vehicleIdstringrequired
routePlanIdstring

References routePlan.id

recordedAttimestamprequired
latitudenumberrequired
longitudenumberrequired
headingDegreesnumber
speedMilesPerHournumber
ignitionboolean
odometerMilesnumber
horizontalDilutionOfPrecisionnumber
sourcestringrequired
PATCH/vehiclePosition
curl --request PATCH \
  --url '<your-host>/vehiclePosition?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"companyId":"xyz789"}'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "vehicleId": "xyz789",
  "recordedAt": "2026-01-01T00:00:00Z",
  "latitude": 0,
  "longitude": 0,
  "source": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}
DELETE/vehiclePosition

Delete a vehicle position

Delete a vehicle position, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the vehicle position to delete, e.g. `eq.{id}`.

DELETE/vehiclePosition
curl --request DELETE \
  --url '<your-host>/vehiclePosition?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
204 No Content