Get Reinstatements

cURL

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
      }
    }
  }
}

GET

orgs

{orgId}

operations

reinstatements

cURL

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

Authorization

string

header

required

To understand how to authenticate, see the auth docs

Path Parameters

orgId

string

required

The ID of the organisation

Example:

"cc9746e0-9286-4575-ae0b-ac1b0fe873a6"

Query Parameters

limit

integer

default:10

Limit the number of resources returned by the API

offset

integer

default:0

Offset for resources returned by the API

sort

string

default:created_at

A field in the resource to sort results with. Not all attributes are supported, please see the Object Model for sortable fields.

Response

data

object[]

Show child attributes

data.type

enum<string>

The type of resource

Available options:

reinstatements

Example:

"reinstatements"

data.id

string<uuid>

The reinstatement ID

Example:

"d15d856d-ad88-489d-a263-24fb2427395b"

data.attributes

object

Show child attributes

data.attributes.status

enum<string>

The status of the reinstatement

Available options:

open,

interim,

permanent,

complete

Example:

"interim"

data.attributes.date_opened

string

The date the reinstatement was opened (RFC 3339)

Example:

"2024-06-13T07:15:23.000Z"

data.attributes.date_closed

string

The date the reinstatement was closed (RFC 3339)

Example:

"2024-06-13T07:15:23.000Z"

data.attributes.type

enum<string>

The type of property the resintatement is for

Available options:

private,

public

Example:

"private"

data.attributes.usrn

number

The Unique Street Reference Number

Example:

28317107

data.attributes.uprn

number

The Unique Property Reference Number

Example:

10022999531

data.attributes.property_psr

boolean

Whether the property is on the PSR or not

Example:

true

data.attributes.surface_position

enum<string>

The surface position of the reinstatement

Available options:

footway,

carriageway,

verge,

footpath,

pavement,

road,

cycleway,

garden,

drive,

field

Example:

"footpath"

data.attributes.surface_location

enum<string>

The surface location of the reinstatement

Available options:

outside,

side_of,

opposite,

junction_of,

rear_of,

behind_gate

Example:

"outside"

data.attributes.surface_material

enum<string>

The surface material of the reinstatement

Available options:

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

Example:

"concrete"

data.attributes.opened_length

number

The length of the reinstatement when opened (in meters)

Example:

8.2

data.attributes.opened_width

number

The width of the reinstatement when opened (in meters)

Example:

2.3

data.attributes.opened_depth

number

The depth of the reinstatement when opened (in millimeters)

Example:

80

data.attributes.reinstated_length

number

The length of the reinstatement when closed (in meters)

Example:

8.2

data.attributes.reinstated_width

number

The width of the reinstatement when closed (in meters)

Example:

2.3

data.attributes.reinstated_depth

number

The depth of the reinstatement when closed (in millimeters)

Example:

80

API Documentation

Governance

Data Capture

Operations

Assets

Admin

Get Reinstatements

Authorizations

Path Parameters

Query Parameters

Response