Location management

In Spirii's platform, the Location serves as the core entity that integrates all functionalities related to EV chargers.

The location is the container for one or more charge boxes on the site, and holds information about the geolocation, address, operator & site owner, type, availability, facilities nearby, etc.

In addition, a location links to multiple other entities including:

• Tariffs (for pricing management)
• Vouchers and Charge Key Groups (for access management and discounts)
• Service Level Agreements (for operational management)
• Financial agreements (for billing purposes)

Retrieving location details and charger status

You can retrieve the details about one or more existing locations using the GET Locations endpoint.

Each location is identified by a unique ID, which serves as a query parameter. If you do not have the ID, you can find it through the Spirii Connect platform.

If chargers are installed on the location, you can view the details in this in the array of evse's.

Chargers on the Spirii platform are structured in the following hierarchical setup:

• Location (the full site)
  • Charge Box (the individual physical charge box)
    • EVSE (the part of a charge box that can serve electricity to one EV at a time)
      • Connector (the socket/cable available for the EV to use)
        
        

Each EVSE contain a unique EVSE ID and a charging status (e.g. "Charging", "Available", etc.).

In the Connectors array, you will also find metadata on the plug type (e.g. "CCS"), powertype (e.g. "DC"), and maximum available power (e.g., "150 kW").

Each EVSE links to the tariff id assigned, which controls the charging price.

Creating and updating locations

You can add more locations to the Spirii platform by using the POST Location endpoint.

The API reference contains information of the required fields, data examples, and valid options. It is crucial to provide a valid name, address, and geolocation to ensure the location is discoverable in charging applications.

The owner id refers to the Customer who owns the location (e.g. if the chargers are set up in a parking lot, it might be the parking lot operator who owns the location)

The tariff id refers to a Tariff, which controls the price and conditions of charging on the location.

Upon creation, the location will have an operational status of pending until at least one charge box is created, installed, and connected to the platform.

You can update location data later using the PATCH Location endpoint.

Deleting locations

You can remove locations from your portfolio by using the DELETE Location endpoint. This action performs a soft delete, and the location can only be restored by contacting Spirii support.

Please note that you must first remove all charge boxes associated with the location before you can delete it.