API specification
Version 6.0
This document details all the functions for integrating with Street Manager via the latest version of the API. See the ‘Versions and Changes’ section for more details on previous versions. The documentation for the stable version of the API is available here.
Worklist API
Get permits about to deem
This endpoint will be used by HA users to retrieve information on permits that are due to deem ‘today’. The response will be an array of objects containing the following properties:
- work_reference_number – The work reference number associated with the permit
- permit_reference_number – The permit reference number of the permit
- works_location – The street name the permit was raised against
- promoter – The name of the organisation associated with the permit
- deem_date – The deem date of the permit
- application_submission_date – The date the permit was created
- works_category – The work category of the permit
- highest_traffic_management_type – The highest known traffic management type associated with the permit
- start_date – The date the permit works were intended to start
- end_date – The date the permit works were intended to finish
Get work stops due
This endpoint will be used by promoter and contractor users to retrieve information on works that have been started. It will only return works that have not net been stopped where the proposed end date is ‘yesterday’, ‘today’, or ‘tomorrow’ The response will be an array of objects containing the following properties:
- work_reference_number – The work reference number of the permit
- permit_reference_number – The permit reference number of the permit
- works_location – The street name the permit was raised against
- highway_authority – The name of the organisation associated with the permit
- start_date – The start date of the permit
- proposed_end_date – The proposed end date of the permit
- reasonable_period_end_date – The reasonable period end date of the permit set by the Highway Authority
- workstream_id – The workstream id that was used to create the permit