Sign in

v1

latestSwagger 2.02026-07-1384122135.6 KB
Road

Get active disruptions, filtered by road ids

get/Road/{ids}/Disruption

Path parameters

idsstring[] required

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

Query parameters

stripContentboolean

Optional, defaults to false. When true, removes every property/node except for id, point, severity, severityDescription, startDate, endDate, corridor details, location, comments and streets

severitiesstring[]

an optional list of Severity names to filter on (a valid list of severities can be obtained from the /Road/Meta/severities endpoint)

categoriesstring[]

an optional list of category names to filter on (a valid list of categories can be obtained from the /Road/Meta/categories endpoint)

closuresboolean

Optional, defaults to true. When true, always includes disruptions that have road closures, regardless of the severity filter. When false, the severity filter works as normal.

Response

OK

idstring

Unique identifier for the road disruption

urlstring

URL to retrieve this road disruption

pointstring

Latitude and longitude (WGS84) of the centroid of the disruption, stored in a geoJSON-formatted string.

severitystring

A description of the severity of the disruption.

ordinalinteger

An ordinal of the disruption based on severity, level of interest and corridor.

categorystring

Describes the nature of disruption e.g. Traffic Incidents, Works

subCategorystring

Describes the sub-category of disruption e.g. Collapsed Manhole, Abnormal Load

commentsstring

Full text of comments describing the disruption, including details of any road closures and diversions, where appropriate.

currentUpdatestring

Text of the most recent update from the LSTCC on the state of the disruption, including the current traffic impact and any advice to road users.

currentUpdateDateTimestring date-time

The time when the last CurrentUpdate description was recorded, or null if no CurrentUpdate has been applied.

corridorIdsstring[]

The Ids of affected corridors, if any.

startDateTimestring date-time

The date and time which the disruption started. For a planned disruption (i.e. planned road works) this date will be in the future. For unplanned disruptions, this will default to the date on which the disruption was first recorded, but may be adjusted by the operator.

endDateTimestring date-time

The date and time on which the disruption ended. For planned disruptions, this date will have a valid value. For unplanned disruptions in progress, this field will be omitted.

lastModifiedTimestring date-time

The date and time on which the disruption was last modified in the system. This information can reliably be used by a developer to quickly compare two instances of the same disruption to determine if it has been changed.

levelOfIntereststring

This describes the level of potential impact on traffic operations of the disruption. High = e.g. a one-off disruption on a major or high profile route which will require a high level of operational attention Medium = This is the default value Low = e.g. a frequently occurring disruption which is well known

locationstring

Main road name / number (borough) or preset area name where the disruption is located. This might be useful for a map popup where space is limited.

statusstring

This describes the status of the disruption.
Active = currently in progress Active Long Term = currently in progress and long term Scheduled = scheduled to start within the next 180 days Recurring Works = planned maintenance works that follow a regular routine or pattern and whose next occurrence is to start within the next 180 days. Recently Cleared = recently cleared in the last 24 hours Note that the status of Scheduled or Recurring Works disruptions will change to Active when they start, and will change status again when they end.

isProvisionalboolean

True if the disruption is planned on a future date that is open to change

hasClosuresboolean

True if any of the affected Streets have a "Full Closure" status, false otherwise. A RoadDisruption that has HasClosures is considered a Severe or Serious disruption for severity filtering purposes.

linkTextstring

The text of any associated link

linkUrlstring

The url of any associated link

publishStartDatestring date-time

TDM Additional properties

publishEndDatestring date-time
timeFramestring