Send tariff

Send notification of a tariff update for an asset.

The off_peak_times field must comply with the OSM opening hours standard (https://wiki.openstreetmap.org/wiki/Key:opening_hours) and have a valid timezone, or a 400 error will be returned.

The same off-peak times apply every day, day-of-week selectors are not supported. Use , to separate multiple time ranges. Common examples:

• Same-day off-peak (e.g. midnight to 7am): 00:00-07:00
• Overnight off-peak (e.g. 11:30pm to 5:30am): 00:00-05:30, 23:30-24:00

POST /entities/asset/{asset_id}/event/tariff-update

Asset Tariff Update Event

cURL

curl --request POST \
  --url https://api-sandbox.axle.energy/entities/asset/{asset_id}/event/tariff-update \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tariff": {
    "off_peak_times": "<string>",
    "timezone": "<string>"
  }
}
'

import requests

url = "https://api-sandbox.axle.energy/entities/asset/{asset_id}/event/tariff-update"

payload = { "tariff": {
        "off_peak_times": "<string>",
        "timezone": "<string>"
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({tariff: {off_peak_times: '<string>', timezone: '<string>'}})
};

fetch('https://api-sandbox.axle.energy/entities/asset/{asset_id}/event/tariff-update', 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/entities/asset/{asset_id}/event/tariff-update",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'tariff' => [
        'off_peak_times' => '<string>',
        'timezone' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api-sandbox.axle.energy/entities/asset/{asset_id}/event/tariff-update"

	payload := strings.NewReader("{\n  \"tariff\": {\n    \"off_peak_times\": \"<string>\",\n    \"timezone\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-sandbox.axle.energy/entities/asset/{asset_id}/event/tariff-update")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"tariff\": {\n    \"off_peak_times\": \"<string>\",\n    \"timezone\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.axle.energy/entities/asset/{asset_id}/event/tariff-update")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"tariff\": {\n    \"off_peak_times\": \"<string>\",\n    \"timezone\": \"<string>\"\n  }\n}"

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

422

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Path Parameters

asset_id · string<uuid> · required

Body

application/json

Request model for a user's tariff update.

tariff · Tariff · object · required

Updated tariff information.

Show child attributes

Response

200

application/json

Tariff update event successfully processed