Digital Traffic Regulation Orders (3.4.1)

Download OpenAPI specification:

Department for Transport: d-tro@dft.gov.uk License: Crown copyright Terms of Service

This page provides the API documentation for the Digital Traffic Regulation Orders (D-TRO) service.

Auth

Get auth token

Exchange client ID and secret using HTTP basic authentication. This returns an access token to use in all subsequent requests.

Request Body schema: application/x-www-form-urlencoded
required

Token grant request parameters

grant_type

required

string

Default: "client_credentials"

Value: "client_credentials"

Responses

Response samples

200

Content type

application/json

{"refresh_token_expires_in": "0",
"api_product_list": "[int-publisher]",
"api_product_list_json": ["int-publisher"
],
"organization_name": "dft-dtro-int",
"developer.email": "user@example.com",
"token_type": "BearerToken",
"issued_at": "1751369026823",
"client_id": "GXvLpQeYzWmKjRuTnAoXcVbNqLzHdFgTyUiOpAsDfGhJkLzXcVbNmQwErTyUiOpAs",
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
"application_name": "c646ba58-a094-4b33-bfb5-41494dd749ec",
"scope": "dsp",
"expires_in": "1799",
"refresh_count": "0",
"status": "approved"
}

D-TROs

Create D-TRO from body

Create a D-TRO record by submitting a JSON payload in the request body.

Authorizations:

oAuth

Request Body schema: application/json
required

Object containing D-TRO details

schemaVersion required	string (SchemaVersion) Version of the schema to submit the D-TRO payload against
	object (DTROData) Object describing the D-TRO content

Responses

Request samples

Payload

Content type

application/json

{"schemaVersion": "3.4.0",
"data": {"source": {"actionType": "new",
"currentTraOwner": 1,
"provision": [{"actionType": "new",
"orderReportingPoint": "permanentNoticeOfMaking",
"provisionDescription": "Example",
"reference": "A3448229-1DFA-48CD-A785-376ACB9F7C56",
"regulatedPlace": [{"description": "Example",
"type": "regulationLocation",
"linearGeometry": {"direction": "bidirectional",
"lateralPosition": "onKerb",
"linestring": "SRID=27700;LINESTRING(444284 333253, 444284 333253)",
"representation": "linear",
"version": 1
}
}
],
"regulation": [{"isDynamic": false,
"timeZone": "Europe/London",
"condition": [{"timeValidity": {"start": null
}
}
]
}
]
}
],
"reference": "B2787FE2-AD74-432A-BB32-76FDB065F3E8",
"section": "Example",
"traAffected": [1
],
"traCreator": 1,
"troName": "Example"
}
}
}

Response samples

201

Content type

application/json

{"id": "0bead96d-1c15-4cab-91f3-d25e243601b5"
}

Create D-TRO from file

Create a D-TRO record by uploading a JSON file containing the D-TRO content.

Authorizations:

oAuth

Request Body schema: multipart/form-data
required

file

required

string <binary>

JSON file contaning the D-TRO content

Responses

Response samples

201

Content type

application/json

{"id": "0bead96d-1c15-4cab-91f3-d25e243601b5"
}

Update D-TRO from body

Update an existing D-TRO by submitting a JSON payload in the request body.

Authorizations:

oAuth

path Parameters

dtroId

required

string <uuid>

ID of the D-TRO to update

Request Body schema: application/json

Object describing the D-TRO

schemaVersion required	string (SchemaVersion) Version of the schema to submit the D-TRO payload against
	object (DTROData) Object describing the D-TRO content

Responses

Request samples

Payload

Content type

application/json

{"schemaVersion": "3.4.0",
"data": {"source": {"actionType": "new",
"currentTraOwner": 1,
"provision": [{"actionType": "new",
"orderReportingPoint": "permanentNoticeOfMaking",
"provisionDescription": "Example",
"reference": "A3448229-1DFA-48CD-A785-376ACB9F7C56",
"regulatedPlace": [{"description": "Example",
"type": "regulationLocation",
"linearGeometry": {"direction": "bidirectional",
"lateralPosition": "onKerb",
"linestring": "SRID=27700;LINESTRING(444284 333253, 444284 333253)",
"representation": "linear",
"version": 1
}
}
],
"regulation": [{"isDynamic": false,
"timeZone": "Europe/London",
"condition": [{"timeValidity": {"start": null
}
}
]
}
]
}
],
"reference": "B2787FE2-AD74-432A-BB32-76FDB065F3E8",
"section": "Example",
"traAffected": [1
],
"traCreator": 1,
"troName": "Example"
}
}
}

Response samples

200

Content type

application/json

{"id": "0bead96d-1c15-4cab-91f3-d25e243601b5"
}

Update D-TRO from file

Authorizations:

oAuth

path Parameters

dtroId

required

string <uuid>

ID of the D-TRO to update

Request Body schema: multipart/form-data
required

file

required

string <binary>

JSON file contaning the D-TRO content

Responses

Response samples

200

Content type

application/json

{"id": "0bead96d-1c15-4cab-91f3-d25e243601b5"
}

Get D-TRO by ID

Retrieves a published D-TRO by its ID.

Authorizations:

oAuth

path Parameters

id

required

string <uuid>

ID of the D-TRO to retrieve

Responses

Response samples

200

Content type

application/json

{"id": "77be1c43-cf55-4aa8-b0e7-5af77f2dcc71",
"schemaVersion": "3.4.0",
"data": {"source": {"actionType": "new",
"currentTraOwner": 1,
"provision": [{"actionType": "new",
"orderReportingPoint": "permanentNoticeOfMaking",
"provisionDescription": "Example",
"reference": "A3448229-1DFA-48CD-A785-376ACB9F7C56",
"regulatedPlace": [{"description": "Example",
"type": "regulationLocation",
"linearGeometry": {"direction": "bidirectional",
"lateralPosition": "onKerb",
"linestring": "SRID=27700;LINESTRING(444284 333253, 444284 333253)",
"representation": "linear",
"version": 1
}
}
],
"regulation": [{"isDynamic": false,
"timeZone": "Europe/London",
"condition": [{"timeValidity": {"start": null
}
}
]
}
]
}
],
"reference": "B2787FE2-AD74-432A-BB32-76FDB065F3E8",
"section": "Example",
"traAffected": [1
],
"traCreator": 1,
"troName": "Example"
}
},
"traName": "Some TRA"
}

Get all D-TROs

Generate a signed URL to download a data extract of all published D-TROs.

Authorizations:

oAuth

Responses

Response samples

200

Content type

application/json

{"url": "https://storage.googleapis.com/my-bucket-name/my-file.txt?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=my-service-account%40my-project.iam.gserviceaccount.com%2F20250701%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20250701T142000Z&X-Goog-Expires=3600&X-Goog-SignedHeaders=host&X-Goog-Signature=abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890"
}

Delete D-TRO

Deletes a D-TRO from the service. Note this is a soft-delete, and marks the D-TRO as deleted rather than physically removing the record.

Authorizations:

oAuth

path Parameters

dtroId

required

string <uuid>

ID of the D-TRO to delete

Responses

Events

Retrieve D-TRO event history

Retrieve a list of D-TRO events (e.g. creations, updates, deletes) that match a given search criteria.

Authorizations:

oAuth

Request Body schema: application/json

A search query object

pageSize required	integer Number of D-TROs to retrieve per page
page required	integer Page number to retrieve
since required	string <date-time> Return events where D-TRO creation is is on or after this datetime
to required	string <date-time> Return events where D-TRO creation time is up to and including this datetime
deletionTime	string <date-time> Deprecated Datetime the D-TRO was deleted. Deprecated - use `deletedFrom` and `deletedTo`
deletedFrom	string <date-time> Datetime the D-TRO was deleted on, or after
deletedTo	string <date-time> Datetime the D-TRO was deleted on, or before
modificationTime	string <date-time> Deprecated Datetime the D-TRO was modified. Deprectaed - use `modifiedFrom` and `modifiedTo`
modifiedFrom	string <date-time> Datetime the D-TRO was last modified on, or after
modifiedTo	string <date-time> Datetime the D-TRO was last modified on, or before
traCreator	integer D-TRO TRA creator
currentTraOwner	integer D-TRO current TRA owner
troName	string Name of the TRO
regulationType	string The D-TRO regulation type
regulatedPlaceType	string The D-TRO regulated place type
vehicleType	string The D-TRO vehicle type
orderReportingPoint	string The D-TRO order reporting point
regulationStart	string <date-time> Return events where D-TRO regulation date is on or after this datetime
regulationEnd	string <date-time> Return events where D-TRO regulation date is up to and including this datetime
eventType	string Enum: "create" "update" "delete" The D-TRO event type

Responses

Request samples

Payload

Content type

application/json

{"pageSize": 5,
"page": 1,
"since": "2025-01-01T09:00:00",
"to": "2025-01-01T09:00:00",
"deletionTime": "2025-01-01T09:00:00",
"deletedFrom": "2025-01-01T09:00:00",
"deletedTo": "2025-01-01T09:00:00",
"modificationTime": "2025-01-01T09:00:00",
"modifiedFrom": "2025-01-01T09:00:00",
"modifiedTo": "2025-01-01T09:00:00",
"traCreator": 1,
"currentTraOwner": 1,
"troName": "Example",
"regulationType": "string",
"regulatedPlaceType": "regulationLocation",
"vehicleType": "car",
"orderReportingPoint": "permanentNoticeOfMaking",
"regulationStart": "2025-01-01T09:00:00",
"regulationEnd": "2025-01-01T09:00:00",
"eventType": "start"
}

Response samples

200
404

Content type

application/json

{"events": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"publicationTime": "2019-08-24T14:15:22Z",
"traCreator": 0,
"currentTraOwner": 0,
"troName": "string",
"regulationType": ["string"
],
"vehicleType": ["string"
],
"regulatedPlaceType": ["string"
],
"orderReportingPoint": ["string"
],
"regulationStart": ["2019-08-24T14:15:22Z"
],
"regulationEnd": ["2019-08-24T14:15:22Z"
],
"eventType": "create",
"eventTime": "2019-08-24T14:15:22Z",
"_links": {"self": "string"
}
}
],
"page": 0,
"pageSize": 0,
"totalCount": 0
}

Schemas

Get all schema versions

Retrieve all schema versions known to the D-TRO system

Authorizations:

oAuth

Responses

Get schema templates.

Authorizations:

oAuth

Responses

Get schema template by its schema version

Authorizations:

oAuth

path Parameters

version

required

string

Schema version by which schema template to retrieve.

Responses

Search

Finds existing D-TROs that match the required criteria.

Authorizations:

oAuth

Request Body schema: application/json

A D-TRO object search criteria.

	Array of objects or null (DfT.DTRO.Models.Filtering.SearchQuery) non-empty
page required	integer <int32> [ 1 .. 2147483647 ]
pageSize required	integer <int32> [ 1 .. 50 ]

Responses

Request samples

Payload

Content type

application/json

{"queries": [{"publicationTime": "2019-08-24T14:15:22Z",
"modificationTime": "2019-08-24T14:15:22Z",
"deletionTime": "2019-08-24T14:15:22Z",
"traCreator": 0,
"currentTraOwner": 0,
"troName": "string",
"regulationType": "string",
"vehicleType": "string",
"orderReportingPoint": "string",
"regulatedPlaceType": "string",
"regulationStart": {"operator": "=",
"value": "2019-08-24T14:15:22Z"
},
"regulationEnd": {"operator": "=",
"value": "2019-08-24T14:15:22Z"
}
}
],
"page": 1,
"pageSize": 1
}

Response samples

200

Content type

application/json

{"results": [{"troName": "string",
"publicationTime": "2019-08-24T14:15:22Z",
"trafficAuthorityCreatorId": 0,
"trafficAuthorityOwnerId": 0,
"regulationType": ["string"
],
"vehicleType": ["string"
],
"orderReportingPoint": ["string"
],
"regulatedPlaceTypes": ["string"
],
"regulationStart": ["2019-08-24T14:15:22Z"
],
"regulationEnd": ["2019-08-24T14:15:22Z"
],
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"page": 0,
"pageSize": 0,
"totalCount": 0
}

Digital Traffic Regulation Orders (3.4.1)

Auth

Get auth token

Request Body schema: application/x-www-form-urlencodedrequired

Responses

Response samples

D-TROs

Create D-TRO from body

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Create D-TRO from file

Authorizations:

Request Body schema: multipart/form-datarequired

Responses

Response samples

Update D-TRO from body

Authorizations:

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Update D-TRO from file

Authorizations:

path Parameters

Request Body schema: multipart/form-datarequired

Responses

Response samples

Get D-TRO by ID

Authorizations:

path Parameters

Responses

Response samples

Get all D-TROs

Authorizations:

Responses

Response samples

Delete D-TRO

Authorizations:

path Parameters

Responses

Events

Retrieve D-TRO event history

Authorizations:

Request Body schema: application/json

Responses

Request samples

Response samples

Schemas

Get all schema versions

Authorizations:

Responses

Get schema templates.

Authorizations:

Responses

Get schema template by its schema version

Authorizations:

path Parameters

Responses

Search

Finds existing D-TROs that match the required criteria.

Authorizations:

Request Body schema: application/json

Responses

Request samples

Response samples

Request Body schema: application/x-www-form-urlencoded
required

Request Body schema: application/json
required

Request Body schema: multipart/form-data
required

Request Body schema: multipart/form-data
required