API documentation

Note that this documentation is being trialled for use with the Street Manager Beta and is aimed towards authorised Beta participants. As Street Manager remains under active development, this documentation will continue to develop over time.

---

Overview

This page contains guidance for developers integrating their systems with the Street Manager API so they can submit and retrieve information about street works.

The page is split into two sections. The first contains specification documentation which describes the legally required API functions and interfaces which are due to be delivered in the coming weeks and months. The second section lists the versioned and dated releases, as the specified functionality is implemented and deployed into the service environments.

---

API Integration Guide

This guide details best practices and common patterns for integrating with Street Manager

---

Specification Documentation

Version 4 - Stable

• Version 4.15

This is the V4 baseline specification. There are no breaking changes planned to be introduced in upcoming releases; while new functionality may be introduced in future versions of the V4 specification, these changes will be purely additive in nature to prevent existing integrations from breaking. Note: The PBI Sample Inspection epic is code complete. However this is awaiting performance validation. Due to this, some further changes may be required.

Version 5

• Version 5.0

---

Releases

Current

• Version 5.19 - Released to Sandbox on 25/04/2024. Released to Production on 29/04/2024.
• Version 4.15.29 - Released to Sandbox on 28/03/2024. Released to Production on 03/04/2024.

Upcoming

• Version 5.20 - Due for release to Sandbox on 09/05/2024. Due for release to Production on 13/05/2024.
• Version 4.15.30 - Due for release to Sandbox on 09/05/2024. Due for release to Production on 13/05/2024.