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.
Data Export API Resource Guide
Generate Section 58s CSV
Generates a CSV list of Section 58s which, if logged in as a Highway Authority, are associated with the authenticated user’s organisation. Otherwise, all Section 58s will be returned.
A csv_id is returned in the Response body. This csv_id can be used with the GET /csv/{csvId} endpoint to retrieve the CSV after generation.
Generate Section 74s CSV
Generates a CSV list of Section 74s which are associated with the authenticated user’s organisation.
A csv_id is returned in the Response body. This csv_id can be used with the GET /csv/{csvId} endpoint to retrieve the CSV after generation.
Generate Section 81s CSV
Generates a CSV list of Section 81s which are associated with the authenticated user’s organisation.
A csv_id is returned in the Response body. This csv_id can be used with the GET /csv/{csvId} endpoint to retrieve the CSV after generation.
Generate Reinstatements CSV
Generates a CSV list of reinstatements which are associated with the authenticated user’s organisation.
A csv_id is returned in the Response body. This csv_id can be used with the GET /csv/{csvId} endpoint to retrieve the CSV after generation.
Generate Expiring Interim Reinstatements CSV
POST /reinstatements/expiring-interims/csv
Generates a CSV list of expiring interim reinstatements which are associated with the authenticated user’s organisation.
A csv_id is returned in the Response body. This csv_id can be used with the GET /csv/{csvId} endpoint to retrieve the CSV after generation.
Generate FPNs CSV
POST /fixed-penalty-notices/csv
Generates a CSV list of FPNs which are associated with the authenticated user’s organisation.
A csv_id is returned in the Response body. This csv_id can be used with the GET /csv/{csvId} endpoint to retrieve the CSV after generation.
Generate Fees CSV
Generates a CSV list of fees which are associated with the authenticated user’s organisation.
A csv_id is returned in the Response body. This csv_id can be used with the GET /csv/{csvId} endpoint to retrieve the CSV after generation.
Chargeable activities include:
- Granting of a permit application
- PAA progressed to PA - note, this occurs when a PA is received, not when it’s granted
- Granting of a change request
- Change in work category
Contractors are required to provide optional swa_code parameter in order to state which promoter they are working on behalf of.
Users can also provide the parameters fee_report_format and swa_code_filter to get a fee report for a specific organisation. Setting fee_report_format to single_org_one_csv and providing the organisation reference in the swa_code_filter will generate a single fees CSV for a specific organisation. Setting fee_report-format to all_orgs_multiple_csvs will generate a ZIP file containing a CSV for each of the organisations contained in the report.
Generate Permits CSV
Generates a CSV list of permits which are associated with the authenticated user’s organisation.
A csv_id is returned in the Response body. This csv_id can be used with the GET /csv/{csvId} endpoint to retrieve the CSV after generation.
Generate Inspections CSV
Generates a CSV list of inspections which are associated with the authenticated user’s organisation.
A csv_id is returned in the Response body. This csv_id can be used with the GET /csv/{csvId} endpoint to retrieve the CSV after generation.
Generate Forward Plans CSV
Generates a CSV list of forward plans which are associated with the authenticated user’s organisation.
A csv_id is returned in the Response body. This csv_id can be used with the GET /csv/{csvId} endpoint to retrieve the CSV after generation.
Generate Alterations CSV
Generates a CSV list of alterations which are associated with the authenticated user’s organisation.
A csv_id is returned in the Response body. This csv_id can be used with the GET /csv/{csvId} endpoint to retrieve the CSV after generation.
Generate Comments CSV
Generates a CSV list of comments which are associated with the authenticated user’s organisation.
A csv_id is returned in the Response body. This csv_id can be used with the GET /csv/{csvId} endpoint to retrieve the CSV after generation.
Generate PBI Sample Inspections Due CSV
POST /pbi-sample-inspections-due/csv
Generates a CSV list of PBI sample inspections due which are associated with the authenticated user’s organisation.
A csv_id is returned in the Response body. This csv_id can be used with the GET /csv/{csvId} endpoint to retrieve the CSV after generation.
Generate Reinspections CSV
Generates a CSV list of reinspections that are associated with the authenticated user’s organisation.
A csv_id is returned in the Response body. This csv_id can be used with the GET /csv/{csvId} endpoint to retrieve the CSV after generation.
Generate Private Street Notices CSV
POST /private-street-notices/csv
Generates a CSV list of private street notices that are associated with the authenticated user’s organisation.
A csv_id is returned in the Response body. This csv_id can be used with the GET /csv/{csvId} endpoint to retrieve the CSV after generation.
Generate Non-compliances CSV
Generates a CSV list of non-compliances that are associated with the authenticated user’s organisation.
A csv_id is returned in the Response body. This csv_id can be used with the GET /csv/{csvId} endpoint to retrieve the CSV after generation.
Generate Permits Reinstatements Due CSV
POST /permits/reinstatements-due/csv
Generates a CSV list of permits with reinstatements due. This is only available to Highway Authority users.
A csv_id is returned in the Response body. This csv_id can be used with the GET /csv/{csvId} endpoint to retrieve the CSV after generation.
Generate Material Classifications CSV
POST /material-classifications/csv
Generates a CSV list of material classifications. This is only available to Highway Authority users.
A csv_id is returned in the Response body. This csv_id can be used with the GET /csv/{csvId} endpoint to retrieve the CSV after generation.
Generate PBI Sample Inspection Targets CSV
POST /pbi-sample-inspection-targets/csv
Generates a CSV list of Performance Based Inspections (PBI) sample inspection targets. This is only available to Highway Authority users.
A csv_id is returned in the Response body. This csv_id can be used with the GET /csv/{csvId} endpoint to retrieve the CSV after generation.
Generate Interested Party Permits CSV
POST /interested-party-permits/csv
Generates a CSV list of interested party permits that are associated with the authenticated user’s organisation. If the authenticated user’s organisation has Highway Authority or Streetworks Authority role, this returns all interested party permits.
A csv_id is returned in the Response body. This csv_id can be used with the GET /csv/{csvId} endpoint to retrieve the CSV after generation.
Generate change requests (new style) CSV
Generates a CSV list of new style change requests.
A csv_id is returned in the Response body. This csv_id can be used with the GET /csv/{csvId} endpoint to retrieve the CSV after generation.
Get Generated CSV
Returns a CSV generated by one of the POST /{entity}/csv endpoints listed above.
Any values within the CSV which could potentially contain formulas will have been prepended with a single quote character '. This includes values beginning with = + - @ \t \r or including a comma , or semi-colon ; followed by any of = + - @ \t \r.