Get example OCPP charging profile

Get an example OCPP charging profile.

Returns a pre-filled SetChargingProfileRequest object that can be used as a reference for the expected format and structure of OCPP charging profiles.

GET /examples/ocpp-charging-profile

Get Example Ocpp Charging Profile

cURL

curl --request GET \
  --url https://api-sandbox.axle.energy/examples/ocpp-charging-profile \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api-sandbox.axle.energy/examples/ocpp-charging-profile"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api-sandbox.axle.energy/examples/ocpp-charging-profile', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.axle.energy/examples/ocpp-charging-profile",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.axle.energy/examples/ocpp-charging-profile"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api-sandbox.axle.energy/examples/ocpp-charging-profile")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.axle.energy/examples/ocpp-charging-profile")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "connectorId": 123,
  "csChargingProfiles": {
    "chargingProfileId": 123,
    "stackLevel": 123,
    "chargingSchedule": {
      "chargingSchedulePeriod": [
        {
          "startPeriod": 123,
          "limit": 123,
          "numberPhases": 123
        }
      ],
      "duration": 123,
      "startSchedule": "2023-11-07T05:31:56Z",
      "minChargingRate": 123
    },
    "transactionId": 123,
    "validFrom": "2023-11-07T05:31:56Z",
    "validTo": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Response

200

application/json

Example OCPP charging profile

A SetChargingProfileRequest object, as defined in section 6.43 of the OCPP 1.6 documentation at https://openchargealliance.org/protocols/open-charge-point-protocol/#OCPP1.6

This is used by the central system to send charging profiles to an EV charger.

connectorId · integer · required

The connector to which the charging profile applies. If connectorId = 0, the message contains an overall limit for the Charge Point.

csChargingProfiles · Cschargingprofiles · object · required

The charging profile to be set at the Charge Point.

Show child attributes