Yard State API Docs¶

Purpose¶

Yard State documentation covers the interface used to exchange vehicle and depot yard-state information. It is the reference for physical location, vehicle presence, bay or parking position, operational status, and depot-floor context used by dispatch and depot operations.

The Yard State interface exposes the live or recently observed state of a depot yard so operators and downstream systems can read and update parking-space occupancy and vehicle context. It is deliberately focused on yard spaces and the vehicle state attached to those spaces, rather than broader dispatch planning or charger control.

What This Covers¶

Depot-scoped state: operations are anchored by depotId.
Parking-space state: list spaces, fetch one space, update one space, or apply bulk space updates.
Vehicle context: which vehicle is associated with a space and what operational state was observed.
Freshness: observed_at timestamps record when the state was seen or supplied.
Error handling: missing depots or spaces map to domain errors and HTTP 404 responses.
API shape: FastAPI validates payloads against the OpenAPI contract and delegates state changes to a yard-state handler.
Deployment boundary: authentication and authorization are expected to be handled by upstream gateway or mesh infrastructure.

BetterFleet Interpretation¶

Use Yard State when the question is about physical depot reality: where vehicles are parked, which spaces are occupied, and what the depot-floor state says right now. It supports dispatch reliability and depot operations by giving product workflows a structured view of yard position and vehicle context.

The generated docs are the right place for endpoint and payload details. BFDev docs should explain which product workflows consume yard state, how depot simulation or digital-twin services use it, and how yard reality affects dispatch decisions.

Published Documentation¶

Public docs: https://vemo-yard-interface-c63737.gitlab.io/
Support microsite public wrapper: bf-support-microsite/public/docs/yard.html
Source path: integrations/vemo-yard-interface

bf-manage-core
bf-digital-twin
bf-depot-sim
Operations and dispatch
Depot and integration
Fleet and vehicle management

Chatbot Retrieval Terms¶

Yard State, yard interface, vehicle location, depot, parking bay, block, vehicle presence, depot floor, operations, dispatch, fleet state, yard walk, vehicle movement, integration state.

Notes¶

Use the public generated docs for interface-level payload and package details.
Use BetterFleet product docs for the user-facing dispatch and yard-state workflows that consume this data.