Skip to main content
Get Visit Orders

Authorizations

Authorization
string
header
required

Enter your Bearer token. It's required to authenticate API requests.

Query Parameters

VisitDate
string<date-time>

The date for which the visit orders are requested.

MachineId
integer<int64>

The unique identifier of the machine associated with the visit order.

DriverId
string<uuid>

The unique identifier of the driver associated with the visit order.

RouteId
integer<int64>

The unique identifier of the route associated with the visit order.

ActorId
integer<int64>

The unique identifier of the actor associated with the visit order.

Response

200 - application/json

A list of visit orders that match the specified criteria.

MachineVisitOrderId
integer<int64>

The unique identifier for the visit order associated with a specific machine.

VisitDate
string<date-time>

The date and time when the visit is scheduled to occur.

DriverId
string<uuid> | null

The unique identifier of the driver assigned to the visit. This field is nullable if no driver is assigned.

Machines
object[] | null

A list of machines included in the visit order, each with details about the machine's ID, route, and order in the visit sequence.