Sign in

v1

latestSwagger 2.02026-07-1384122135.6 KB
Road

Gets the specified roads with the status aggregated over the date range specified, or now until the end of today if no dates are passed.

get/Road/{ids}/Status

Path parameters

idsstring[] required

Comma-separated list of road identifiers e.g. "A406, A2" or use "all" to ignore id filter (a full list of supported road identifiers can be found at the /Road/ endpoint)

Query parameters

dateRangeNullable.startDatestring date-time
dateRangeNullable.endDatestring date-time

Response

OK

idstring

The Id of the Corridor e.g. "A406"

displayNamestring

The display name of the Corridor e.g. "North Circular (A406)". This may be identical to the Id.

groupstring

The group name of the Corridor e.g. "Central London". Most corridors are not grouped, in which case this field can be null.

statusSeveritystring

Standard multi-mode status severity code

statusSeverityDescriptionstring

Description of the status severity as applied to RoadCorridors

boundsstring

The Bounds of the Corridor, given by the south-east followed by the north-west co-ordinate pair in geoJSON format e.g. "[[-1.241531,51.242151],[1.641223,53.765721]]"

envelopestring

The Envelope of the Corridor, given by the corner co-ordinates of a rectangular (four-point) polygon in geoJSON format e.g. "[[-1.241531,51.242151],[-1.241531,53.765721],[1.641223,53.765721],[1.641223,51.242151]]"

statusAggregationStartDatestring date-time

The start of the period over which status has been aggregated, or null if this is the current corridor status.

statusAggregationEndDatestring date-time

The end of the period over which status has been aggregated, or null if this is the current corridor status.

urlstring

URL to retrieve this Corridor.