📘

Note

The location information is retrieved in bulk. Eco-Movement recommends that you retrieve the entire dataset once a day.

Request

See locations and locations/{id} to know more about the parameters that are used with the two versions of the locations endpoint.

Response

The following is a sample response for the locations endpoint:

{
    data: [ 
    
        { location 1 
            [
                { EVSE 1 
                    [{ connnector 1 },{ connector 2 }]},
                { EVSE 2 
                    [{...},{...}]}
            ]
        },
        
        { location 2 [{...}]},
        
    ], 
}

📘

Note

Use the "Try It!" button in locations and locations/{id} to view an actual response from our API.

The following table describes the main objects in the response of the locations endpoint:

🚧

Caution

Eco-Movement always upholds the API contract, but we may send new attributes in our JSON response when:

• we add an OCPI mandatory attribute to the JSON response to be OCPI compliant
• we improve your licensing module with new features

Hence, we strongly recommend that you handle or ignore unknown JSON fields.

Response Definitions

The main objects consist of several OCPI and Eco-Movement custom attributes.

Standard OCPI Attributes

The following are the standard attributes of OCPI 2.1.1:

Eco-Movement Attributes

The following attributes were additionally created by Eco-Movement. They are not standard in the OCPI protocol. These attributes can be included in the request.

📘

Note

For the predicted_occupancy, roaming, and derived_opening_times attributes, you must use a location's id parameter behind the locations endpoint in a GET request. Use the "Try It!" button in locations/{id} to use the locations endpoint with a location's id and view an actual response from our API.

If you are interested in receiving these attributes with the bulk request, please contact us. Please note that only 500 results are returned instead of 1000 results with this feature.