The chat responses are generated using Generative AI technology for intuitive search and may not be entirely accurate. They are not intended as professional advice. For full details, including our use rights, privacy practices and potential export control restrictions, please refer to our Generative AI Service Terms of Use and Generative AI Service Privacy Information. As this is a test version, please let us know if something irritating comes up. Like you get recommended a chocolate fudge ice cream instead of an energy managing application. If that occurs, please use the feedback button in our contact form!
Skip to content
DepotFinity

DepotFinity is a cloud-based software service that is used to monitor, report, schedule and manage the charging operations of chargers within a depot.

Remote Command API¶

The Remote Command API allows you send commands to a remote charger and perform the following functions.

  • Control charging activity
  • Modify charger settings and configurations

API Usage¶

See Token Management API for more information on how to create and use the access token.

Remote Command¶

Prepare Request Body¶

Set the following path parameters to prepare the request body.

  1. Charger ID to chargerId.
  2. Remote Command Type to remoteCommandType.
  3. Additional body parameter for sending the payload. Refer the schema RemoteCommandBody for the additional body parameter details. For more information, see Remote Command API Reference.

Example Request¶

Note

Use the server URL applicable to your region. See API Reference for available server URLs applicable to your region.

export ACCESS_TOKEN = <YOUR_ACCESS_TOKEN>

export CHARGER_ID = <YOUR_CHARGER_ID>
export REMOTE_COMMAND_TYPE = <YOUR_REMOTE_COMMAND_TYPE>
export CONNECTOR_ID = <YOUR_CONNECTOR_ID>
export ID_TAG = <YOUR_ID_TAG>

curl --location --request POST 'https://api.eu.depot.emobility.io/v1/chargerControl/chargers/$CHARGER_ID/remoteCommands/$REMOTE_COMMAND_TYPE'
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer $ACCESS_TOKEN' \
--data '{
  "connectorId": $CONNECTOR_ID,
  "idTag": $ID_TAG
}'

Response Body¶

Successful response returns 200 HTTP status code with response body as RemoteCommandResponse schema. For more information, see Remote Command API Reference.

Example Response¶

{
  "commandType": "startChargingSession",
  "response": {
    "status": "Accepted",
    "message": "Operation successful: Start charging request has been accepted."
  }
}

Example Responses¶

Http CodeStatusMessage
200AcceptedOperation successful: Start charging request has been accepted.
200AcceptedOperation successful: Stop charging request has been accepted.
400RejectedOperation denied: Rejected by the charger.
400Operation denied: Invalid Payload.
404Operation denied: Charger is offline.
404Operation denied: Charger ID not found.
404Operation denied: Connector ID not found.
404Operation denied: No ongoing charging.
401Operation denied: Unauthorized IDTag.
500Operation failed: Internal server error.
408Operation failed: Timeout.