A Route represents an ordered list of stops that a specific vehicle, operated by a specific driver, will visit. Each route is tied to exactly one vehicle and one driver, and contains a defined sequence of stops. The order of these stops is intentional and dictates the exact visitation order followed by the vehicle.
Properties
| Property | Type | Description |
|---|---|---|
id | string | The UUID for the route. $filter operators: equals in not in |
created_date | Date | When the route was first seen by Edlink. |
updated_date | Date | When the route was last changed in Edlink. $filter operators: equals gt lt gte lte |
properties | object | Non-standard properties that may be of interest to the developer. |
code | string | The unique code assigned to the route. |
description | string | A description of the route. |
state | RouteState[] | The state of the route. |
mileage | number | The total mileage of the route. |
flags | RouteFlag[] | The flags for the route. All, some, or none of the possible flags may be included. |
route_stops | RouteStop[] | The sequence of stops that a vehicle will visit in a particular order. |
identifiers | Identifier[] | Additional IDs associated with the object. |
stop_ids | string[] | An array of UUIDs of the associated Stops. |
vehicle_id | string | The UUID of the associated Vehicle. |
driver_id | string | The UUID of the associated Driver. |
JSON Example
{
"id": "00000000-0000-0000-0000-000000000000",
"created_date": "2021-07-13T17:45:27.570Z",
"updated_date": "2021-07-13T17:45:27.570Z",
"properties": {},
"code": "ROUTE001",
"description": "A daily route for school transportation.",
"state": "active",
"mileage": 20,
"flags": [],
"stop_ids": ["22222222-2222-2222-2222-222222222222", "33333333-3333-3333-3333-333333333333", "44444444-4444-4444-4444-444444444444", "55555555-5555-5555-5555-555555555555"],
"vehicle_id": "00000000-0000-0000-0000-000000000000",
"driver_id": "00000000-0000-0000-0000-000000000000",
"rider_ids": ["66666666-6666-6666-6666-666666666666", "77777777-7777-7777-7777-777777777777"],
"identifiers": [
{
"type": "sis_id",
"value": "EXT-ROUTE-12345"
}
],
}