Full integration

Overview

A parking session secures the parking rights that allows a vehicle to occupy an on-street or controlled environment parking zone for a period of time. These APIs provide a standard interface to access parking rates, create sessions, and collect payments, which can be used to build applications that create authorized parking sessions. Parking enforcement will be able to see active sessions and the corresponding information tied to those parking rights, such as space or license plate number (LPN) and duration of session.

Additional information, such as estimated parking availability, is provided at some locations.

How to park

A session must be created with all required components for parking rights to be granted to the user. Each session requires a zone, LPN or space information, a geographic location, duration, and access to funds to provide to the city. Space numbers are required in certain zones that may or may not also require LPN information. This metadata, plus certain city-specific requirements, needs to be passed to downstream services, such as the operator’s enforcement provider or back-office management tools.

The following steps are typical for creating a parking session. Other operations, such as retrieving a user’s session history, are available as well but may or may not be required for your use case.

On-street parking

On-street zones are identified with a session_type of space or vehicle.

  1. Identify the zone the user is attempting to park in, either through user input or location.

  2. Look up parking rates and restrictions; this will ensure that parking is allowed and provide pricing information.

  3. Generate a quote for a selected period of time, which provides a price for the session.

  4. Start a parking session. This may require providing payment information to Passport, depending on your payment preferences. Once successful, the user is granted the right to park for the quoted time period.

  5. Retrieve active session information as required. Parking sessions do not require explicit “end” events and will implicitly end once the specified duration has passed unless an extension is requested beforehand.

Other operations, such as retrieving a user’s session history, are available as well but may or may not be required for your use case.