Skip to main content
Delta pull behavior, inlined tariffs, pagination rules, and relaxed field validations for Roam OCPI locations.

Locations module adjustments

Tariff inlined in locations object

The relevant tariffs are inlined on the connector, via the location module. Using delta pulls (date_from/date_to) will return locations where the location data or the tariff data has changed. The response has the tariff object inlined for each connector. You can do delta pulls up to once per minute. Example:

PUSH of Locations / EVSEs / connectors not supported

Plugsurfing does not support pushing updates of charging stations. The amount of updates that Plugsurfing receives from CPOs would lead to a massive amount of data being sent through to all partners if it would be shared unfiltered. Instead, you can do delta pulls which will give you the necessary location updates without unnecessary traffic.

Pagination

For performance reasons Plugsurfing doesn’t use deep pagination, instead a hash to the next page is provided as part of the Link header (The header will contain an additional query param named smart_paging). If your OCPI implementation already follows the Link header, no changes are needed. The maximum page size returned is 250 locations. Parallel pulling of locations is not supported, since smart pagination is used. Example getting page 1 Request:
Response header (if another page exist):
Example getting page 2 Request:
Response header (if another page exist):

Location field validations

Plugsurfing is a bit more lenient than the OCPI specification for a set of properties when receiving Locations from CPOs. This means outgoing Locations from Plugsurfing will also not fully comply with the OCPI specification for these fields.

EVSE capabilities

The following capabilities are not supported, and they will be stripped from the EVSEs returned via the API:
  • CHARGING_PROFILE_CAPABLE
  • CHARGING_PREFERENCES_CAPABLE
  • RESERVABLE
  • TOKEN_GROUP_CAPABLE
  • UNLOCK_CAPABLE

Removed locations

Locations that have previously been available to you can be removed for different reasons.
  • A CPO has removed a location
  • A CPO is no longer part of the network
  • You have updated your country filtering and removed a previously supported country
  • You have requested to block a CPO with network filtering configured on the Plugsurfing Power Platform
When a location is no longer available, it will no longer be returned when pulling locations. Based on the absence of a location in a full PULL, you should delete it in your system. A full PULL is recommended on a nightly basis in order to keep the available locations synchronised.

Routing headers

Plugsurfing supports OCPI routing headers on the Locations pull endpoint. For the general OCPI message routing model, refer to the OCPI 2.2.1 specification. When OCPI-to-country-code and OCPI-to-party-id are provided, Plugsurfing uses the routed party as a location filter within the requesting EMP’s accessible charging network. The request returns locations only for that routed CPO, provided that the party can be resolved and is available to the requesting EMP. If the routed party cannot be resolved, is not available through the requesting EMP’s network, or the OCPI-to-* routing headers are incomplete, Plugsurfing returns an OCPI response with status_code 2001 and an empty data array. The routing target DE*8PS requests the full Plugsurfing CPO network available to the requesting EMP; it does not apply a single-CPO location filter. If the request includes complete OCPI-from-* and OCPI-to-* headers, Plugsurfing still returns the corresponding OCPI response routing headers. Plugsurfing offers a generous Fair Usage Policy, but routing headers are not intended for extensive parallelization of location pulls. You may pull up to five routed country-code and party-id combinations in parallel. The calling client is expected to track this limit. Plugsurfing may introduce rate limiting if usage affects platform stability or other customers.