Vehicle data model used in integration API

vehicle_type_idinteger | nullnullable

Vehicle type ID if present.

agent_idstring<uuid>

Agent ID (UUID) of the vehicle.

amortized_linear_cost_factorinteger | nullnullable

Linear part of cost coefficient of the vehicle added to overall vehicle cost.

amortized_quadratic_cost_factorinteger | nullnullable

Quadratic part of cost coefficient of the vehicle subtracted from overall vehicle cost.

bearingnumber<float>

Current bearing of the vehicle in degrees.

Default value: 0

capacity object

Represents capacity of the vehicle. Capacity name has to match booking capacity type for the vehicle to be considered for booking allocation.

property name*integer

characteristics object

Vehicle characteristics to match with relevant bookings requiring these characteristics.

property name* object

anyOf

number
Ranged characteristic
boolean

number

Value of the characteristic, for example:

{
    "manpower": 3
}

colorstring

Hexadecimal color code of the vehicle.

Default value: #000000

current_sim_tsstring,null<date-time>nullable

Current simulation timestamp.

driver_idinteger | nullnullable

Identifier of the driver assigned to this vehicle.

dynamic_break_avg_time_between_breaksnumber,null<float>nullable

Average time in seconds between breaks for multi-break mode.

dynamic_break_durationnumber,null<float>nullable

Duration of dynamic break for this vehicle (in seconds).

dynamic_break_end_timestring,null<date-time>nullable

Maximum time when a dynamic break can end.

dynamic_break_max_latencynumber,null<float>nullable

Maximum latency allowed for a dynamic break.

dynamic_break_min_path_durationnumber,null<float>nullable

Minimum path duration (in seconds) when a dynamic break should be added.

dynamic_break_start_timestring,null<date-time>nullable

Minimum time when a dynamic break can start.

efficiency vehicle_efficiency (object,null)

Efficiency settings for the vehicle.

constraints object[]

This feature enables efficiency constraints for vehicles, managing how much capacity they utilize. It works by defining a list of constraints for various demand types. These constraints focus on two optional checks during a vehicle's trip:

Minimum Load: Ensures the vehicle is loaded with at least a specified minimum capacity throughout the trip. This promotes efficient vehicle usage. Maximum Remaining Load: Ensures the vehicle's remaining load at the end of a trip doesn't exceed a specified maximum. This discourages returns to the depot with significant unused capacity. Each check can be either strict or weak:

Strict: These constraints must be met. Failing a strict constraint is unacceptable, even if it means no solution is found. Weak: These constraints are preferred but not mandatory. If a weak constraint is violated, a penalty is added to the overall objective value. The penalty for violating a weak constraint is calculated as the sum of two components:

Fixed Penalty: A pre-defined penalty value. Linear Penalty: Calculated by multiplying the cost of over/under capacity by the amount of over/under capacity.

Array [

demand_namestring

Demand name to apply the constraint. This demand type must be present in at least one full booking. If the demand set here is not present in any of the booking as a set demand type, the optimizer will fail the validation.

loaded_min_capacitynumber | nullnullable

Minimum capacity after a series of consecutive pickups before dropoffs. If check is not strict then penalty is added to cost if capacity is less than minimum. If check is strict then route with too small capacity is invalid.

loaded_min_capacity_percentagenumber | nullnullable

The same as loaded_min_capacity but represented as percentage.

loaded_undercapacity_penaltyinteger

Fixed penalty of undercapacity.

Default value: 0

loaded_undercapacity_costinteger

Cost of undercapacity. The additional penalty is calculated as the product of undercapacity_cost and the undercapacity value.

Default value: 0

loaded_undercapacity_check_strictboolean

Flag indicates that check of undercapacity must be strict.

Default value: false

unloaded_max_capacitynumber | nullnullable

Maximum capacity after a series of consecutive dropoffs before pickups. If check is not strict then penalty is added to cost if capacity is greater than maximum. If check is strict then route with too large capacity is invalid.

unloaded_max_capacity_percentagenumber | nullnullable

Same as unloaded_max_capacity but represented as percentage.

unloaded_overcapacity_penaltyinteger

Fixed penalty of overcapacity.

Default value: 0

unloaded_overcapacity_costinteger

Cost of overcapacity. The additional penalty is calculated as the product of overcapacity_cost and the overcapacity value.

Default value: 0

unloaded_overcapacity_check_strictboolean

Flag, indicates, that check for overcapacity must be strict.

Default value: false

]

end_timestring,null<date-time>nullable

Vehicle work end time.

end_time_node_indexinteger | nullnullable

Node index in path sequence for which end time constraint should be set.

geofence_idsinteger[]

List of geofence IDs where the vehicle is allowed to operate within the simulation. Empty means no restrictions.

in_usestring

Flag indicating if the vehicle should be used for optimization purposes.

Possible values: [enabled, disabled]

Default value: enabled

is_invalidatedboolean

Soft deletion flag for a vehicle.

Default value: false

h3string | nullnullable

H3 geospatial index of the vehicle's current location.

labelsstring[]

List of vehicle labels. Used to select appropriate bookings for assignments.

latnumber<float>

Last known latitude of the vehicle.

Default value: 0

lonnumber<float>

Last known longitude of the vehicle.

Default value: 0

lifo_order_checkboolean

Flag to enable Last-In-First-Out order check for vehicle operations.

Default value: false

max_dropoff_locationsinteger | nullnullable

Maximum drop-off locations allowed for a vehicle on a single trip.

max_physical_stopsinteger | nullnullable

Max number of physical stops, excluding first and last depot.

max_pickup_locationsinteger | nullnullable

Maximum pickup locations allowed for a vehicle on a single trip.

max_trip_durationnumber,null<float>nullable

Maximum allowed trip duration for a vehicle in minutes.

max_trip_lengthnumber,null<float>nullable

Maximum allowed trip length for a vehicle in kilometers.

number_of_tripsinteger | nullnullable

Maximum number of times vehicle can return to depot(s).

project_idinteger | nullnullable

Project identifier for the vehicle. If absent, would be taken from task.project_id.

registration_numberstring | nullnullable

Registration plate number of the vehicle.

routing_engine_settings object

Routing engine specific settings for the vehicle.

routing_engine_namestringrequired

Name of the engine to be used.

Possible values: [euclidian, euclidian_geo, asteria, graphhopper, mapbox, valhalla, osrm, osrme, google, here, spheroid, spheriodtd, tomtom]

Default value: asteria

road_networkstringrequired

Road network to be used by the routing engine (routing profile)

Default value: osrme

keystringrequired

API key for the mapping service

Default value: null

urlstringrequired

URL of the routing engine to request the data from

Default value: http://mapbox-osrm-proxy

curbboolean

Sets approacch values in the resuts to unrestricted with false, and curb with true value. The approaches are set only for the first and the last stop in the trip

Default value: null

intermediate_curbboolean

Sets approacch values in the resuts to unrestricted with false, and curb with true value. The approaches are set for all waypoints in a trip except for the first and the last stop

Default value: null

continue_straightboolean

Applies continue_straight flag to the routing request. WHen set to null default map setting is applied.

Default value: null

speednumber | nullnullable

Speed value used by the routing engine if fiexed speed is enabled with use_speed_in_routing flga

Default value: 0

time_factornumber

Can be used to manually adjust the time needed to move between waypoints compared to what the routing engine provides based on the vehicle profile.

Default value: 1

make_depot_zeroboolean

Default value: true

batch_matrix_sizeinteger

Defines size of the matix to request from the routing engine with a single request for optimization purposes

Default value: 250

osrme_timestamp_modestring

Defines default timestamp type to be used for requesting the route

Default value: start_time

use_speed_in_routingboolean

If enabled, forces the routing engine to use fixed speed and disregard speeds from the map

Default value: false

server_tsstring<date-time>

Current (last updated) server timestamp.

statusstring

Current vehicle status.

Possible values: [idle, driving, servicing, waiting, selecting_next_node]

Default value: idle

service_numberstring

Vehicle service number.

should_wait_untilstring,null<date-time>nullable

Should wait (stay on the same location) until this timestamp (during node servicing).

sim_enable_gps_noiseboolean

Enable GPS noise for research simulations only.

Default value: false

sim_gps_noise_distancenumber<float>

Distance of GPS noise for simulation.

Default value: 0

simulation_idinteger | nullnullable

Identifier of the simulation this vehicle belongs to.

simulation_step_pauseinteger

Simulation step pause for this agent (research simulations only).

Default value: 1

simulation_time_speedup_factornumber<float>

Simulation time speedup factor.

Default value: 1

speednumber<float>

Current speed of the vehicle.

Default value: 0

current_routeobject

Current route assigned to the vehicle.

Default value: {}

start_timestring,null<date-time>nullable

Vehicle work start time.

start_time_node_indexinteger | nullnullable

Index of the node the vehicle should be starting from.

vehicle_costinteger | nullnullable

Cost associated with the vehicle.

zero_cost_if_only_partial_routesboolean | nullnullable

Applies zero cost to a vehicle if it has only partial routes assigned.

assigned_nodes_protection_intervalnumber,null<float>nullable

Interval for protecting assigned nodes.

assigned_nodes_protection_max_locationsinteger | nullnullable

Maximum locations for assigned nodes protection.

simulation_template_idinteger | nullnullable

Identifier of the simulation template.

simulation_template_namestring | nullnullable

Name of the simulation template.

simulation_start_datestring,null<date>nullable

Simulation start date, assuming project's timezone.

driver_user_usernamestring | nullnullable

Username of the driver's login.

start_location_latnumber,null<float>nullable

Start location latitude of the vehicle.

start_location_lonnumber,null<float>nullable

Start location longitude of the vehicle.

start_location_namestring

Location name of the vehicle's start point.

start_location_display_namestring

Display name of the vehicle's start point.

end_location_latnumber,null<float>nullable

End location latitude of the vehicle.

end_location_lonnumber,null<float>nullable

End location longitude of the vehicle.

end_location_namestring

Location name of the vehicle's end point.

end_location_display_namestring

Display name of the vehicle's end point.

start_location_transitstop_idinteger | nullnullable

Start location ID from masstransit.

end_location_transitstop_idinteger | nullnullable

End location ID from masstransit.

start_location_operations_location_idinteger | nullnullable

Start location ID from operations locations.

end_location_operations_location_idinteger | nullnullable

End location ID from operations locations.

start_location_finalization_typefinalization_type (string)

Finalization type for the vehicle's start location node.

Possible values: [min, max]

start_location_max_slackinteger | nullnullable

Maximum slack time in seconds for the vehicle's start location node.

Default value: 300

end_location_finalization_typefinalization_type (string)

Finalization type for the vehicle's end location node.

Possible values: [min, max]

end_location_max_slackinteger | nullnullable

Maximum slack time in seconds for the vehicle's end location node.

Default value: 300

start_location_operations_location_external_idstring | nullnullable

External ID for the vehicle's start location from operations locations.

end_location_operations_location_external_idstring | nullnullable

External ID for the vehicle's end location from operations locations.

created_atstring<date-time>

Creation timestamp of an object

id object

Identifier of the object

anyOf

integer
uuid

integer

Can be integer

modified_atstring<date-time>

Last modification timestampo of the object

resource_uristring<uri-reference>

URI of the object instance

Vehicle data model used in integration API
{
  "vehicle_type_id": 0,
  "agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "amortized_linear_cost_factor": 0,
  "amortized_quadratic_cost_factor": 0,
  "bearing": 0,
  "capacity": {},
  "characteristics": {},
  "color": "#000000",
  "current_sim_ts": "2024-07-29T15:51:28.071Z",
  "driver_id": 0,
  "dynamic_break_avg_time_between_breaks": 0,
  "dynamic_break_duration": 0,
  "dynamic_break_end_time": "2024-07-29T15:51:28.071Z",
  "dynamic_break_max_latency": 0,
  "dynamic_break_min_path_duration": 0,
  "dynamic_break_start_time": "2024-07-29T15:51:28.071Z",
  "efficiency": "Unknown Type: object,null",
  "end_time": "2024-07-29T15:51:28.071Z",
  "end_time_node_index": 0,
  "geofence_ids": [
    0
  ],
  "in_use": "enabled",
  "is_invalidated": false,
  "h3": "string",
  "labels": [
    "string"
  ],
  "lat": 0,
  "lon": 0,
  "lifo_order_check": false,
  "max_dropoff_locations": 0,
  "max_physical_stops": 0,
  "max_pickup_locations": 0,
  "max_trip_duration": 0,
  "max_trip_length": 0,
  "number_of_trips": 0,
  "project_id": 0,
  "registration_number": "string",
  "routing_engine_settings": {
    "routing_engine_name": "asteria",
    "road_network": "osrme",
    "key": null,
    "url": "http://mapbox-osrm-proxy",
    "curb": null,
    "intermediate_curb": null,
    "continue_straight": null,
    "speed": 0,
    "time_factor": 1,
    "make_depot_zero": true,
    "batch_matrix_size": 250,
    "osrme_timestamp_mode": "start_time",
    "use_speed_in_routing": false
  },
  "server_ts": "2024-07-29T15:51:28.071Z",
  "status": "idle",
  "service_number": "string",
  "should_wait_until": "2024-07-29T15:51:28.071Z",
  "sim_enable_gps_noise": false,
  "sim_gps_noise_distance": 0,
  "simulation_id": 0,
  "simulation_step_pause": 1,
  "simulation_time_speedup_factor": 1,
  "speed": 0,
  "current_route": {},
  "start_time": "2024-07-29T15:51:28.071Z",
  "start_time_node_index": 0,
  "vehicle_cost": 0,
  "zero_cost_if_only_partial_routes": true,
  "assigned_nodes_protection_interval": 0,
  "assigned_nodes_protection_max_locations": 0,
  "simulation_template_id": 0,
  "simulation_template_name": "string",
  "simulation_start_date": "2024-07-29",
  "driver_user_username": "string",
  "start_location_lat": 0,
  "start_location_lon": 0,
  "start_location_name": "string",
  "start_location_display_name": "string",
  "end_location_lat": 0,
  "end_location_lon": 0,
  "end_location_name": "string",
  "end_location_display_name": "string",
  "start_location_transitstop_id": 0,
  "end_location_transitstop_id": 0,
  "start_location_operations_location_id": 0,
  "end_location_operations_location_id": 0,
  "start_location_finalization_type": "min",
  "start_location_max_slack": 300,
  "end_location_finalization_type": "min",
  "end_location_max_slack": 300,
  "start_location_operations_location_external_id": "string",
  "end_location_operations_location_external_id": "string",
  "created_at": "2024-07-29T15:51:28.071Z",
  "id": 0,
  "modified_at": "2024-07-29T15:51:28.071Z",
  "resource_uri": "string"
}