Sign in

v1

latestOpenAPI 3.0.12026-07-26181265484.9 KB
Scheduling

Get Route Machines

Retrieves a list of machines assigned to a specific route, identified by RouteId, and optionally filtered by MachineId.

get/v1/Scheduling/route-machines

Query parameters

RouteIdinteger

The unique identifier of the route associated with the machines.

MachineIdinteger

The unique identifier of the machine to filter the results.

Response

A list of machines assigned to the specified route.

MachineTypeLutIdinteger nullable

The identifier for the machine type from the lookup table.

MachineIdinteger

The unique identifier of the machine.

MachineNamestring nullable

The name of the machine.

MachineNumberstring nullable

The unique number assigned to the machine.

CountryIdinteger nullable

The identifier for the country where the machine is located.

Citystring nullable

The city where the machine is located.

Addressstring nullable

The address where the machine is located.

StreetNumberstring nullable

The street number where the machine is located.

Longitudestring nullable

The longitude coordinate of the machine's location.

Latitudestring nullable

The latitude coordinate of the machine's location.

InstituteIdinteger nullable

The unique identifier of the institute associated with the machine.

InstituteNamestring nullable

The name of the institute associated with the machine.

LocationIdinteger nullable

The unique identifier of the location where the machine is installed.

LocationNamestring nullable

The name of the location where the machine is installed.

CustomerIdinteger nullable

The unique identifier of the customer associated with the machine.

CustomerNamestring nullable

The name of the customer associated with the machine.

CustomerLocationIdinteger nullable

The unique identifier of the customer's location associated with the machine.

CustomerLocationNamestring nullable

The name of the customer's location associated with the machine.

StatusIdinteger nullable

The status identifier of the machine, indicating its current status.

DriverIdstring uuid nullable

The unique identifier of the driver assigned to the machine.

RouteIdinteger

The unique identifier of the route to which the machine is assigned.

UserIdinteger nullable

The unique identifier of the user who last interacted with the machine.

CreatedByinteger

The unique identifier of the user who created the route-machine association.

CreatedDtstring date-time

The date and time when the route-machine association was created.