# DER Connect API by Elia Group

## Docs

- [List all Charge Sessions for an Entity](https://docs.der-connect.dev/api-reference/endpoint/charge-sessions-api/list-charging-records-1.md): Returns the list of Charging Records for the Entity for the defined time frame.
- [Cancel a Command](https://docs.der-connect.dev/api-reference/endpoint/commands-api/cancel-a-command.md): Cancels a specific Commmand and returns that Command with the updated status.
- [List all Commands for an Entity](https://docs.der-connect.dev/api-reference/endpoint/commands-api/list-commands.md): Returns a page with a list of Commands in a given time frame. If no time frame is given, it will return all available Commands.
- [Retrieve a Command](https://docs.der-connect.dev/api-reference/endpoint/commands-api/retrieve-a-specific-command-by-its-id.md): Retrieves a specific Command by its id and returns that Command.
- [Schedule Commands for VPP](https://docs.der-connect.dev/api-reference/endpoint/commands-api/trigger-schedule/schedule-for-VPP.md): Schedules a list of Commands for execution in the future and returns that list of Commands.
- [Schedule Commands for Entity](https://docs.der-connect.dev/api-reference/endpoint/commands-api/trigger-schedule/schedule-for-entity.md): Schedules a list of Commands for execution in the future and returns that list of Commands.
- [Trigger a Command for VPP](https://docs.der-connect.dev/api-reference/endpoint/commands-api/trigger-schedule/trigger-for-VPP.md): Sends a new Command for immediate execution and returns the new Command.
- [Trigger a Command for Entity](https://docs.der-connect.dev/api-reference/endpoint/commands-api/trigger-schedule/trigger-for-entity.md): Sends a new Command for immediate execution and returns the new Command.
- [Add a member to a Collective](https://docs.der-connect.dev/api-reference/endpoint/core-resources/collective-members/add-a-member-to-a-collective.md): Adds a member to a Collective and returns that Collective with a list of members associated with it
- [List all members of a Collective](https://docs.der-connect.dev/api-reference/endpoint/core-resources/collective-members/list-members-by-collective.md): Returns a page listing the members in a Collective
- [Remove a member from a Collective](https://docs.der-connect.dev/api-reference/endpoint/core-resources/collective-members/remove-a-member-from-a-collective.md): Removes a member from a Collective and returns that Collective with a list of members associated with it
- [Add an Entity to a Collective](https://docs.der-connect.dev/api-reference/endpoint/core-resources/collectives/add-an-entity-to-a-collective.md): Adds an Entity to a Collective and returns that Collective with a list of Entities, including the newly added Entity
- [The Collective object](https://docs.der-connect.dev/api-reference/endpoint/core-resources/collectives/collective-object.md): A Collective represents a group of users and clients (members) who collectively can be granted permissions on one or more Entities.
- [List all Collectives](https://docs.der-connect.dev/api-reference/endpoint/core-resources/collectives/list-collectives.md): Returns a list of Collectives accessible to the authenticated user
- [List all Entities by Collective](https://docs.der-connect.dev/api-reference/endpoint/core-resources/collectives/list-entities-by-collective.md)
- [Remove an Entity from a Collective](https://docs.der-connect.dev/api-reference/endpoint/core-resources/collectives/remove-an-entity-from-a-collective.md): Removes an Entity from a Collective and returns that Collective with a list of Entities associated with it
- [Retrieve a Collective](https://docs.der-connect.dev/api-reference/endpoint/core-resources/collectives/retrieve-a-collective.md): Returns a specific Collective by id
- [Update a Collective](https://docs.der-connect.dev/api-reference/endpoint/core-resources/collectives/update-a-collective.md): Updates a Collective and returns the updated Collective
- [The Entity object](https://docs.der-connect.dev/api-reference/endpoint/core-resources/entities/entity-object.md): An Entity represents a connected device, like a PV inverter, home battery, or an electric vehicle.
- [List all Entities](https://docs.der-connect.dev/api-reference/endpoint/core-resources/entities/list-entities.md): Returns a page of Entities of the given type (if provided) and active feature (if provided)
- [Retrieve an Entity](https://docs.der-connect.dev/api-reference/endpoint/core-resources/entities/retrieve-an-entity.md): Returns Entity data for an Entity with a given id
- [Add permissions for an Entity](https://docs.der-connect.dev/api-reference/endpoint/core-resources/entity-permissions/add-permissions-to-an-entity.md): Add permissions to an Entity
- [List permissions for an Entity](https://docs.der-connect.dev/api-reference/endpoint/core-resources/entity-permissions/list-permissions-by-entity.md): Returns a page listing the permissions associated with this Entity
- [Managing permissions](https://docs.der-connect.dev/api-reference/endpoint/core-resources/entity-permissions/managing-permissions.md)
- [Remove permissions for an Entity](https://docs.der-connect.dev/api-reference/endpoint/core-resources/entity-permissions/remove-permissions-from-an-entity.md): Remove permission from an Entity
- [Delete the battery capacity of an Entity](https://docs.der-connect.dev/api-reference/endpoint/entity-settings/battery-capacity/delete-the-battery-capacity-of-an-entity.md): Deletes the battery capacity from the Entity
- [Retrieve the battery capacity of an Entity](https://docs.der-connect.dev/api-reference/endpoint/entity-settings/battery-capacity/retrieve-the-battery-capacity-of-an-entity.md): Returns the battery capacity of the Entity
- [Update the battery capacity of an Entity](https://docs.der-connect.dev/api-reference/endpoint/entity-settings/battery-capacity/update-the-battery-capacity-of-an-entity.md): Set the battery capacity of an Entity and returns the updated battery capacity of that Entity
- [Update the custom properties of an Entity](https://docs.der-connect.dev/api-reference/endpoint/entity-settings/custom-properties/update-the-custom-properties-of-an-entity.md): Set the custom properties of an Entity and returns the updated custom properties of that Entity
- [Add a disaggregator for an Entity](https://docs.der-connect.dev/api-reference/endpoint/entity-settings/disaggregators/add-a-disaggregator-to-an-entity.md): Returns the updated list of disaggregators that are set up for the Entity
- [Remove a disaggregator for an Entity](https://docs.der-connect.dev/api-reference/endpoint/entity-settings/disaggregators/delete-a-disaggregator-of-an-entity.md): Removes the disaggregator from the collection of disaggregators that are set up for the Entity
- [List all disaggregators for an Entity](https://docs.der-connect.dev/api-reference/endpoint/entity-settings/disaggregators/list-the-disaggregators-of-an-entity.md): Returns the set of disaggregators that are set up for the Entity
- [Activate or deactivate a feature for an Entity](https://docs.der-connect.dev/api-reference/endpoint/entity-settings/features/activate-or-deactivate-an-entity-feature.md): Activates or deactivates a feature for an Entity. The platform offers some capabilities (ex: CDRs) that have to be explicitly enabled on an Entity to become available
- [List all features for an Entity](https://docs.der-connect.dev/api-reference/endpoint/entity-settings/features/list-entity-features.md): Returns all the Entity features and their activation status
- [Delete the heated area of an Entity](https://docs.der-connect.dev/api-reference/endpoint/entity-settings/heated-area/delete-the-heated-area-of-an-entity.md): Deletes the heated area from the Entity
- [Retrieve the heated area of an Entity](https://docs.der-connect.dev/api-reference/endpoint/entity-settings/heated-area/retrieve-the-heated-area-of-an-entity.md): Returns the heated area of the Entity
- [Update the heated area of an Entity](https://docs.der-connect.dev/api-reference/endpoint/entity-settings/heated-area/update-the-heated-area-of-an-entity.md): Set the heated area of an Entity and returns the updated heated area of that Entity
- [Create a Location for an Entity](https://docs.der-connect.dev/api-reference/endpoint/entity-settings/locations/create-a-location-for-an-entity.md): Set up a Location for a given Entity by providing an address or its coordinates
- [Delete a Location for an Entity](https://docs.der-connect.dev/api-reference/endpoint/entity-settings/locations/delete-a-location-for-an-entity.md): Delete a Location for a given Entity
- [List all Locations of an Entity](https://docs.der-connect.dev/api-reference/endpoint/entity-settings/locations/list-all-locations-of-an-entity.md): List all Locations for a given Entity
- [Retrieve a Location for an Entity](https://docs.der-connect.dev/api-reference/endpoint/entity-settings/locations/retrieve-a-location-for-an-entity.md): Retrieve the details of a single Location for a given Entity
- [Update a Location for an Entity](https://docs.der-connect.dev/api-reference/endpoint/entity-settings/locations/update-a-location-for-an-entity.md): Update just the label or all details of a Location for a given Entity
- [Delete the nominal power of an Entity](https://docs.der-connect.dev/api-reference/endpoint/entity-settings/nominal-power/delete-the-nominal-power-of-an-entity.md): Deletes the nominal power from the Entity
- [Retrieve the nominal power of an Entity](https://docs.der-connect.dev/api-reference/endpoint/entity-settings/nominal-power/retrieve-the-nominal-power-of-an-entity.md): Returns the nominal power setting of the Entity
- [Update the nominal power of an Entity](https://docs.der-connect.dev/api-reference/endpoint/entity-settings/nominal-power/update-the-nominal-power-of-an-entity.md): Set the nominal power of an Entity and returns the updated nominal power of that Entity
- [Cancel an Entity Offboarding Request](https://docs.der-connect.dev/api-reference/endpoint/offboarding-api/offboard-entities/cancel-an-offboarding-request.md): Cancels an Offboarding Request and returns the cancelled Offboarding Request. Only Offboarding Requests in 'Pending' status can be cancelled.
- [Create an Entity Offboarding Request](https://docs.der-connect.dev/api-reference/endpoint/offboarding-api/offboard-entities/create-an-offboarding-request.md): Creates an Offboarding Request and returns the created Offboarding Request. If there is already a pending Offboarding Request for the specified Entity, the existing Offboarding Request must be cancelled first.
- [List all Entity Offboarding Requests](https://docs.der-connect.dev/api-reference/endpoint/offboarding-api/offboard-entities/list-offboarding-requests.md): Returns a list of all Offboarding Requests available to the authenticated user
- [Retrieve an Entity Offboarding Request](https://docs.der-connect.dev/api-reference/endpoint/offboarding-api/offboard-entities/retrieve-an-offboarding-request.md): Returns a specific Offboarding Request
- [Cancel an Entity Onboarding Request](https://docs.der-connect.dev/api-reference/endpoint/onboarding-api/onboard-entities/cancel-an-entity-onboarding-request.md): Cancels the specified Entity Onboarding Request and returns that Entity Onboarding Request with updated status.
- [Create an Entity Onboarding Request](https://docs.der-connect.dev/api-reference/endpoint/onboarding-api/onboard-entities/create-an-entity-onboarding-request.md): Creates an Entity Onboarding Request and returns the created Entity Onboarding Request.
- [Retrieve an Entity Onboarding Request](https://docs.der-connect.dev/api-reference/endpoint/onboarding-api/onboard-entities/retrieve-an-entity-onboarding-request.md): Returns the Entity Onboarding Request with specified id.
- [List all available brands and Entity types](https://docs.der-connect.dev/api-reference/endpoint/onboarding-api/onboard-entities/retrieve-available-entity-brands-and-types.md): Returns a list with the available Entity types and the possible brand for each type.
- [List all Entity Onboarding Requests](https://docs.der-connect.dev/api-reference/endpoint/onboarding-api/onboard-entities/retrieve-entity-onboarding-requests.md): Returns a page of Entity Onboarding Requests for a specific brand and type, optionally with additional filters.
- [Generate aggregations for an Entity](https://docs.der-connect.dev/api-reference/endpoint/readings-api/aggregations/retrieve-aggregations.md): Returns a page of raw data Aggregations, statistically averaged over a specified resolution and time period, with optional filtering
- [Generate a total aggregation for an Entity](https://docs.der-connect.dev/api-reference/endpoint/readings-api/aggregations/retrieve-the-total-aggregation.md): Returns a single total Aggregation for an Entity between specific dates
- [The Reading object](https://docs.der-connect.dev/api-reference/endpoint/readings-api/readings/reading-object.md): A Reading represents a single snapshot of the state of an Entity.
- [Retrieve the last Reading for an Entity](https://docs.der-connect.dev/api-reference/endpoint/readings-api/readings/retrieve-the-last-reading.md): Returns the most recent normalized Reading for an Entity
- [List all Readings for an Entity](https://docs.der-connect.dev/api-reference/endpoint/readings-api/readings/retrieves-readings.md): Returns a page of normalized Readings for a specific Entity, optionally with additional filters
- [Retrieve a temporary access token](https://docs.der-connect.dev/guides/authenticate.md): Use your application credentials to retrieve a temporary bearer access token.
- [Charge Sessions API](https://docs.der-connect.dev/guides/charge-sessions.md): See when and where a vehicle charged and how much energy it consumed.
- [Commands API](https://docs.der-connect.dev/guides/commands.md): Use the Commands API to schedule or directly send instructions to Entities.
- [Command scheduler](https://docs.der-connect.dev/guides/commands-scheduler.md): Schedule commands with precise trigger times.
- [Connect to an electric vehicle](https://docs.der-connect.dev/guides/connect/electric-vehicles.md): Get access to vehicle readings, control charging, and list charge sessions.
- [Connect to a Huawei PV system](https://docs.der-connect.dev/guides/connect/huawei-pv-systems.md): Connect and control solar plants remotely.
- [Connect to an SMA PV system](https://docs.der-connect.dev/guides/connect/sma-pv-systems.md): Connect and control solar plants remotely.
- [Entity statistics](https://docs.der-connect.dev/guides/entity-statistics.md): Use our new statstics endpoint to analyse and aggregate Entity Readings.
- [Location matching](https://docs.der-connect.dev/guides/location-matching.md): Match pre-defined locations to Readings and Charge Sessions.
- [Onboarding devices and vehicles as Entities](https://docs.der-connect.dev/guides/onboarding-requests.md): To connect with a new device, start by creating an Entity Onboarding Request.
- [Readings API](https://docs.der-connect.dev/guides/readings.md): Observe the state of an Entity over time.
- [Sharing access](https://docs.der-connect.dev/guides/sharing-access.md): Learn how to share Entities with other Applications.
- [Virtual power plants](https://docs.der-connect.dev/guides/virtual-power-plants.md): Use our Commands API alongside VPPs to dispatch bulk instructions across entities.
- [Quickstart](https://docs.der-connect.dev/quickstart.md)

## OpenAPI Specs

- [swagger](https://prd.der-connect.eliagroup.eu/swagger/principals/v1/swagger.json)