For Developers

Get Route

GET https://ed.link/api/v2/graph/routes/:route_id

Retrieve information about a specific Route.

Request Parameters

ParameterTypeDescription
route_idstringThe UUID of the desired Route.

Sample Request

axios.get('https://ed.link/api/v2/graph/routes/00000000-0000-0000-0000-000000000000', {
    headers: {
        authorization: `Bearer ${integration_access_token}`
    }
});

Sample Response

{
    "$request": "00000000-0000-0000-0000-000000000000",
    "$data": {
        "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"
            }
        ]
    }
}