VRt.Monitor [MT] (6.20.2289)
Veeroute Monitor API.
Read trip
Getting trip information by key.
Authorizations:
ApiKeyAuth
path Parameters
| essence_key required | string or null (basic_essence_key) [ 1 .. 1024 ] characters Default: null Example: key01 Key, unique identifier. |
Responses
Response Schema: application/json
required | object (trip) A trip is a sequence of states assigned to the specified performer driving the specified transport. |
required | object (trip_statistics) Statistics for a specific trip. |
object (table_trip_fields) Trip\stops fields for table. | |
Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences. |
Response samples
- 200
- 400
- 401
- 402
- 403
- 404
- 429
- 500
Content type
application/json
{- "trip": {
- "key": "631988f0-9e27-11ed-a8fc-0242ac120002",
- "name": "1-ABC",
- "performer": {
- "performer_key": "performer0001",
- "shift_key": "performer0001_shift01",
- "shift_time": {
- "from": "2024-02-21T09:30:00+03:00",
- "to": "2024-02-21T19:45:00Z"
}
}, - "transport": {
- "transport_key": "transport001",
- "shift_key": "performer01",
- "shift_time": {
- "from": "2024-02-21T09:30:00+03:00",
- "to": "2024-02-21T19:45:00Z"
}
}, - "states": [
- {
- "time": "2024-02-21T09:30:00+03:00",
- "order_key": "order01",
- "demand_key": "demand01.1",
- "event_key": "event01",
- "location_key": "location01",
- "flags": [ ],
- "cargo_placements": [ ],
- "attributes": [ ]
}
], - "waitlist": [
- "order02"
], - "attributes": [ ]
}, - "trip_statistics": {
- "trip_key": "trip01",
- "statistics": {
- "cost": 1231.1,
- "reward": 2343.3,
- "measurements": {
- "driving_time": "P1Y1M1DT2H12M34.3S",
- "waiting_time": "P1Y1M1DT2H12M34.3S",
- "break_time": "P1Y1M1DT2H12M34.3S",
- "working_time": "P1Y1M1DT2H12M34.3S",
- "arriving_time": "P1Y1M1DT2H12M34.3S",
- "departure_time": "P1Y1M1DT2H12M34.3S",
- "total_time": "P1Y1M1DT2H12M34.3S",
- "distance": 5200,
- "time_window": {
- "from": "2024-02-21T09:30:00+03:00",
- "to": "2024-02-21T19:45:00Z"
}
}, - "trips_count": 250,
- "performers_count": 157,
- "orders_count": 1700,
- "plan_orders_count": 1003,
- "waitlist_orders_count": 697,
- "cargo_capacity_ratio": {
- "mass": 10,
- "volume": 2,
- "capacity_a": 1,
- "capacity_b": 2,
- "capacity_c": 3
}, - "max_transport_load": {
- "mass": 10,
- "volume": 2,
- "capacity_a": 1,
- "capacity_b": 2,
- "capacity_c": 3
}, - "quality": {
- "soft_time_window_violations": {
- "before": {
- "keys": [
- "obj1"
], - "count": 1700
}, - "after": {
- "keys": [
- "obj1"
], - "count": 1700
}
}, - "hard_time_window_violations": {
- "before": {
- "keys": [
- "obj1"
], - "count": 1700
}, - "after": {
- "keys": [
- "obj1"
], - "count": 1700
}
}
}
}, - "stop_statistics": [
- {
- "location_key": "location01",
- "demand_ids": [
- "demand01"
], - "stop_time_window": {
- "from": "2024-02-21T09:30:00+03:00",
- "to": "2024-02-21T19:45:00Z"
}, - "measurements": {
- "driving_time": "P1Y1M1DT2H12M34.3S",
- "waiting_time": "P1Y1M1DT2H12M34.3S",
- "break_time": "P1Y1M1DT2H12M34.3S",
- "working_time": "P1Y1M1DT2H12M34.3S",
- "arriving_time": "P1Y1M1DT2H12M34.3S",
- "departure_time": "P1Y1M1DT2H12M34.3S",
- "total_time": "P1Y1M1DT2H12M34.3S",
- "distance": 5200,
- "time_window": {
- "from": "2024-02-21T09:30:00+03:00",
- "to": "2024-02-21T19:45:00Z"
}
}, - "upload": {
- "count": 1460,
- "capacity": {
- "mass": 10,
- "volume": 2,
- "capacity_a": 1,
- "capacity_b": 2,
- "capacity_c": 3
}
}, - "download": {
- "count": 1460,
- "capacity": {
- "mass": 10,
- "volume": 2,
- "capacity_a": 1,
- "capacity_b": 2,
- "capacity_c": 3
}
}, - "max_load": {
- "count": 1460,
- "capacity": {
- "mass": 10,
- "volume": 2,
- "capacity_a": 1,
- "capacity_b": 2,
- "capacity_c": 3
}
}, - "arrival_load": {
- "count": 1460,
- "capacity": {
- "mass": 10,
- "volume": 2,
- "capacity_a": 1,
- "capacity_b": 2,
- "capacity_c": 3
}
}, - "departure_load": {
- "count": 1460,
- "capacity": {
- "mass": 10,
- "volume": 2,
- "capacity_a": 1,
- "capacity_b": 2,
- "capacity_c": 3
}
}
}
], - "total_load": {
- "count": 1460,
- "capacity": {
- "mass": 10,
- "volume": 2,
- "capacity_a": 1,
- "capacity_b": 2,
- "capacity_c": 3
}
}, - "max_load": {
- "count": 1460,
- "capacity": {
- "mass": 10,
- "volume": 2,
- "capacity_a": 1,
- "capacity_b": 2,
- "capacity_c": 3
}
}, - "max_transfer_load": {
- "count": 1460,
- "capacity": {
- "mass": 10,
- "volume": 2,
- "capacity_a": 1,
- "capacity_b": 2,
- "capacity_c": 3
}
}
}, - "fields": {
- "essence_key": "key01",
- "essence_type": "TRIP",
- "enabled": false,
- "pristine": false,
- "trip_name": "1-ABC",
- "attributes": "key1:value1, key2:value2",
- "cost": 1231.1,
- "reward": 2343.3,
- "driving_time": "P1Y1M1DT2H12M34.3S",
- "waiting_time": "P1Y1M1DT2H12M34.3S",
- "break_time": "P1Y1M1DT2H12M34.3S",
- "working_time": "P1Y1M1DT2H12M34.3S",
- "arriving_time": "P1Y1M1DT2H12M34.3S",
- "departure_time": "P1Y1M1DT2H12M34.3S",
- "total_time": "P1Y1M1DT2H12M34.3S",
- "distance": 5200,
- "time_window": {
- "from": "2024-02-21T08:45:00+03:00",
- "to": "2024-02-21T19:45:00+03:00"
}, - "orders_count": 1700,
- "plan_orders_count": 1003,
- "waitlist_orders_count": 697,
- "stops_count": 87,
- "locations_count": 45,
- "cargo_capacity_ratio_mass": 10,
- "cargo_capacity_ratio_volume": 2,
- "cargo_capacity_ratio_capacity_a": 1,
- "cargo_capacity_ratio_capacity_b": 2,
- "cargo_capacity_ratio_capacity_c": 3,
- "max_transport_load_mass": 0.1,
- "max_transport_load_volume": 0.1,
- "max_transport_load_capacity_a": 0.1,
- "max_transport_load_capacity_b": 0.1,
- "max_transport_load_capacity_c": 0.1
}, - "linked_essences": [
- {
- "essence_key": "key01",
- "essence_type": "LOCATION"
}
]
}Getting the service version
Getting the service version.
Responses
Response Schema: application/json
| major required | integer<int32> [ 1 .. 100 ] Product version. Within a single version, compatibility of common data structures between services is guaranteed. A version change indicates changes that are incompatible with previous versions of the product (and all services). |
| minor required | integer<int32> [ 0 .. 111 ] Minor version of the service. A version change indicates new functionality. The update is backward compatible with the major version of the service. |
| build required | string [ 1 .. 64 ] characters Build version. |
Response samples
- 200
- 404
- 429
- 500
Content type
application/json
{- "major": 4,
- "minor": 4,
- "build": "1754RC"
}Getting the documentation
Getting the file with this service documentation.
path Parameters
| filename required | string [ 6 .. 128 ] characters Example: file_en.html File name. |
Responses
Response Schema:
string (file_html)
File with data in HTML format.
Response samples
- 404
- 429
- 500
Content type
application/json
{- "resource_id": "resource_id",
- "detail": {
- "tracedata": {
- "code": "11111111-2222-3333-4444-555555555555",
- "client": "company_|_username",
- "server": "server_name",
- "service": "UNIVERSAL",
- "operation": "run_plan_calculation",
- "time": "2024-02-21T09:30:00+03:00"
}
}
}