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.
Party API Resource Guide
Get user
Returns the UserResponse associated with the base 64 encoded username provided. An optional swaCode query param can be provided by contractors to see the associated workstreams available to them for a particular organisation.
Get workstream
GET /organisations/{organisationReference}/workstreams/{workstreamId}
Returns the WorkstreamResponse associated with the organisation and workstream provided.
Get workstreams
GET /organisations/{organisationReference}/workstreams
Returns all workstreams associated with the organisation provided.
Post workstreams
POST /organisations/{organisationReference}/workstreams
Creates a new workstream associated with the organisation provided.
Put workstream
PUT /organisations/{organisationReference}/workstreams/{workstreamPrefix}
Updates the workstream details associated with the organisation and workstream provided.
Get organisation
Returns a list of OrganisationSummaryResponses. Optionally these can be filtered using the query params type: Filter by organisation type. Available values include PROMOTER, HA and CONTRACTOR query: Filter by organisation name. This will perform a partial search on the organisations name.
GET /organisations/{organisationReference}
Returns the OrganisationResponse associated with the organisation provided.
Refresh tokens
Accepts the user’s Refresh JWT token and returns new ID and Access JWT tokens that are valid for 1 hour.
Logout
Accepts the user’s Access JWT token and invalidates all JWTs associated with a user.
Forgot Password
Accepts the user’s email address. An email will be sent to this address with a verification code, if a user with the address exists in Street Manager. This will only work if the user has activated their account by using the POST /set-password endpoint.
Reset Forgotten Password
Accepts the user’s email address, verification code and the new password. The verification code can be found in the email that was sent following a POST to /forgot-password.
Set password
POST /set-password
Accepts the user’s email address, new password and token (returned from the Work API /authenticate/initial endpoint). This will overwrite the temporary password received by email and activate the user’s account. The response will include the same authentication tokens returned from the Work API /authenticate endpoint.