Skip to main content

Resources

The base url of the Energy Coordination API is https://api.voluespark.com/energy-coordination/v1.

A resource is a physical or virtual object that can be controlled by the Energy Coordination API. Examples of resources are electric vehicles, batteries, heat pumps, and electric boilers.

Response and request type​

The base resource model looks like this:

{
    "id": "string",
    "metadata": {
        "resourceType": "Unknown",
        ...
    }
}

Metadata​

Resources can be of different types. The type is specified in the resourceType field of the metadata object. The following types are supported:

-Vehicle

The other fields in the metadata object are defined by the resourceType and can be found in the documentation for the specific resource type.

Vehicle​

"metadata": {
    "resourceType": "Vehicle",
    "brand": "string",
    "model": "string",
    "year": 0,
    "vin": "string"
  }