API Documentation
Governance
- Organisations
- Schemes
- Work Orders
- Permits
- Operations
- Properties
- Streets
Data Capture
- Forms
- Form Categories
- Submissions
- Submission Versions
Operations
Assets
- Vehicles
Admin
- IAM
Get Reinstatements
Returns all reinstatements for an organisation
curl --request GET \
--url https://api.ctrl-hub.com/v3/orgs/{orgId}/operations/reinstatements \
--header 'Authorization: Bearer <token>'{
"data": [
{
"type": "reinstatements",
"id": "d15d856d-ad88-489d-a263-24fb2427395b",
"attributes": {
"status": "interim",
"date_opened": "2024-06-13T07:15:23.000Z",
"date_closed": "2024-06-13T07:15:23.000Z",
"type": "private",
"usrn": 28317107,
"uprn": 10022999531,
"property_psr": true,
"surface_position": "footpath",
"surface_location": "outside",
"surface_material": "concrete",
"opened_length": 8.2,
"opened_width": 2.3,
"opened_depth": 80,
"reinstated_length": 8.2,
"reinstated_width": 2.3,
"reinstated_depth": 80
}
}
],
"meta": {
"counts": {
"limit": 10
},
"page": {
"limit": 10,
"offset": {
"current": 20,
"next": 30,
"previous": 10
}
}
}
}Authorizations
To understand how to authenticate, see the auth docs
Path Parameters
The ID of the organisation
Query Parameters
Limit the number of resources returned by the API
Offset for resources returned by the API
A field in the resource to sort results with. Not all attributes are supported, please see the Object Model for sortable fields.
Response
The type of resource
reinstatements The reinstatement ID
The status of the reinstatement
open, interim, permanent, complete The type of property the resintatement is for
private, public The Unique Street Reference Number
The Unique Property Reference Number
Whether the property is on the PSR or not
The surface position of the reinstatement
footway, carriageway, verge, footpath, pavement, road, cycleway, garden, drive, field The surface location of the reinstatement
outside, side_of, opposite, junction_of, rear_of, behind_gate The surface material of the reinstatement
6mm_dbm, 6mm_dbm_red, 10mm_dbm, 10mm_sma, 14mm_sma, hra_red, 10mm_dbm_red, 10mm_sma_red, 14mm_sma_red, concrete, mastic, mastic_red, sandcarpet, specialist_surface, resin_footway, asp_slab, modular_paving, block_paving, tactile_paving, york_stone, granite_setts, topsoil_and_seed, turf, unmade, slabs, reinforced_concrete, hra The length of the reinstatement when opened (in meters)
The width of the reinstatement when opened (in meters)
The depth of the reinstatement when opened (in millimeters)
The length of the reinstatement when closed (in meters)
The width of the reinstatement when closed (in meters)
The depth of the reinstatement when closed (in millimeters)
curl --request GET \
--url https://api.ctrl-hub.com/v3/orgs/{orgId}/operations/reinstatements \
--header 'Authorization: Bearer <token>'{
"data": [
{
"type": "reinstatements",
"id": "d15d856d-ad88-489d-a263-24fb2427395b",
"attributes": {
"status": "interim",
"date_opened": "2024-06-13T07:15:23.000Z",
"date_closed": "2024-06-13T07:15:23.000Z",
"type": "private",
"usrn": 28317107,
"uprn": 10022999531,
"property_psr": true,
"surface_position": "footpath",
"surface_location": "outside",
"surface_material": "concrete",
"opened_length": 8.2,
"opened_width": 2.3,
"opened_depth": 80,
"reinstated_length": 8.2,
"reinstated_width": 2.3,
"reinstated_depth": 80
}
}
],
"meta": {
"counts": {
"limit": 10
},
"page": {
"limit": 10,
"offset": {
"current": 20,
"next": 30,
"previous": 10
}
}
}
}