Skip to main content
GET
/
v3
/
street-manager
/
permits
/
{permit_id}
cURL
curl --request GET \
  --url https://api.ctrl-hub.com/v3/street-manager/permits/{permit_id} \
  --header 'X-Session-Token: <api-key>'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "<string>",
    "attributes": {
      "activated": true,
      "usrn": 123,
      "permit_reference_number": "<string>",
      "permit_reference_number_iteration": 123,
      "work_reference_number": "<string>",
      "status": "submitted",
      "work_status_ref": "completed",
      "start_date": "2023-11-07T05:31:56Z",
      "end_date": "2023-11-07T05:31:56Z"
    },
    "meta": {
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "relationships": {
      "latest_version": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      },
      "versions": {
        "data": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        ]
      }
    }
  },
  "jsonapi": {
    "version": "<string>"
  },
  "included": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "attributes": {
        "permit_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "work_reference_number": "<string>",
        "permit_reference_number": "<string>",
        "promoter_swa_code": "<string>",
        "promoter_organisation": "<string>",
        "highway_authority": "<string>",
        "works_location_coordinates": {},
        "street_name": "<string>",
        "area_name": "<string>",
        "work_category": "minor",
        "traffic_management_type": "road_closure",
        "proposed_start_date": "2023-11-07T05:31:56Z",
        "proposed_end_date": "2023-11-07T05:31:56Z",
        "proposed_start_time": "2023-11-07T05:31:56Z",
        "proposed_end_time": "2023-11-07T05:31:56Z",
        "actual_start_date_time": "2023-11-07T05:31:56Z",
        "actual_end_date_time": "2023-11-07T05:31:56Z",
        "work_status": "planned",
        "usrn": 123,
        "highway_authority_swa_code": "<string>",
        "work_category_ref": "<string>",
        "traffic_management_type_ref": "<string>",
        "work_status_ref": "<string>",
        "activity_type": "Highway improvement works",
        "is_ttro_required": "yes",
        "is_covid_19_response": true,
        "works_location_type": [
          "Carriageway"
        ],
        "permit_conditions": [
          "<string>"
        ],
        "road_category": 5,
        "is_traffic_sensitive": true,
        "is_deemed": true,
        "permit_status": "submitted",
        "town": "<string>",
        "collaborative_working": true,
        "collaboration_type": "trench_sharing_primary_promoter",
        "collaboration_type_ref": "<string>",
        "close_footway": "yes_provide_pedestrian_walkway",
        "close_footway_ref": "<string>",
        "current_traffic_management_type": "road_closure",
        "current_traffic_management_type_ref": "<string>",
        "current_traffic_management_update_date": "2023-11-07T05:31:56Z"
      },
      "meta": {
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "relationships": {
        "permit": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        }
      }
    }
  ]
}

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Path Parameters

permit_id
string<uuid>
required

The unique identifier for the street manager permit.

Query Parameters

include
enum<string>[]

A comma separated list of related resources to include.

Available options:
versions,
latest_version

Response

Get a single permit by ID.

JSON API response object

data
object
required

A street manager permit

jsonapi
object
required
included
object[]