Reinstatements
Create a Reinstatement
API Documentation
Governance
- Organisations
- Schemes
- Work Orders
- Permits
- Operations
- Properties
- Streets
Data Capture
- Forms
- Form Categories
- Submissions
- Submission Versions
Operations
Assets
- Vehicles
Admin
- IAM
Reinstatements
Create a Reinstatement
Create a reinstatement for an organisation
POST
/
v3
/
orgs
/
{orgId}
/
operations
/
reinstatements
curl --request POST \
--url https://api.ctrl-hub.com/v3/orgs/{orgId}/operations/reinstatements \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"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
}
}
}'
{
"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
}
}
}
Authorizations
To understand how to authenticate, see the auth docs
Path Parameters
The ID of the organisation
Example:
"cc9746e0-9286-4575-ae0b-ac1b0fe873a6"
Body
application/json
Response
200
application/json
The response is of type object
.
curl --request POST \
--url https://api.ctrl-hub.com/v3/orgs/{orgId}/operations/reinstatements \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"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
}
}
}'
{
"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
}
}
}