Update a charging period

cURL

curl -X PATCH "$EXSITED_BASE_URL/api/v4/settings/charging_periods/cp_171b2c3d4e5f4a6b8c7d9e0f1a2b3c4d" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "charging_period": {
      "display_name": "Monthly charge (AU)",
      "description": "Charges once a month"
    }
  }'

from exsited import build_client

client = build_client()

response = client.charging_periods.update_settings_charging_period(
    "cp_171b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
    {
        "charging_period": {
            "display_name": "Monthly charge (AU)",
            "description": "Charges once a month",
        }
    },
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.chargingPeriods.updateSettingsChargingPeriod('cp_171b2c3d4e5f4a6b8c7d9e0f1a2b3c4d', {
    charging_period: {display_name: 'Monthly charge (AU)', description: 'Charges once a month'},
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->chargingPeriods->updateSettingsChargingPeriod(
    'cp_171b2c3d4e5f4a6b8c7d9e0f1a2b3c4d',
    [
        'charging_period' => [
            'display_name' => 'Monthly charge (AU)',
            'description' => 'Charges once a month',
        ],
    ],
);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.charging_periods.charging_periods_dto.ChargingPeriodsDto.SettingsChargingPeriod;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<SettingsChargingPeriod> response = client.chargingPeriods().updateSettingsChargingPeriod(
        "cp_171b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
        Map.of(
                "charging_period", Map.of(
                        "display_name", "Monthly charge (AU)",
                        "description", "Charges once a month")));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.ChargingPeriods.UpdateSettingsChargingPeriodAsync(
    "cp_171b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
    new Dictionary<string, object?>
    {
        ["charging_period"] = new Dictionary<string, object?>
        {
            ["display_name"] = "Monthly charge (AU)",
            ["description"] = "Charges once a month",
        },
    });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.chargingPeriods.updateSettingsChargingPeriod(
  'cp_171b2c3d4e5f4a6b8c7d9e0f1a2b3c4d',
  {
    'charging_period': {
      'display_name': 'Monthly charge (AU)',
      'description': 'Charges once a month',
    },
  },
);
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.ChargingPeriods().UpdateSettingsChargingPeriod(context.Background(), "cp_171b2c3d4e5f4a6b8c7d9e0f1a2b3c4d", map[string]any{
	"charging_period": map[string]any{
		"display_name": "Monthly charge (AU)",
		"description":  "Charges once a month",
	},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "charging_period": {
    "created_by": "<unknown>",
    "created_on": "<string>",
    "description": "<string>",
    "display_name": "<string>",
    "href": "<string>",
    "id": "<string>",
    "last_updated_by": "<unknown>",
    "last_updated_on": "<string>",
    "name": "<string>",
    "object": "<string>",
    "status": "<string>",
    "time_period": {
      "object": "<string>",
      "id": "<string>",
      "name": "<string>",
      "href": "<string>"
    }
  }
}

PATCH

settings

charging_periods

{charging_period_id}

cURL

curl -X PATCH "$EXSITED_BASE_URL/api/v4/settings/charging_periods/cp_171b2c3d4e5f4a6b8c7d9e0f1a2b3c4d" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "charging_period": {
      "display_name": "Monthly charge (AU)",
      "description": "Charges once a month"
    }
  }'

from exsited import build_client

client = build_client()

response = client.charging_periods.update_settings_charging_period(
    "cp_171b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
    {
        "charging_period": {
            "display_name": "Monthly charge (AU)",
            "description": "Charges once a month",
        }
    },
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.chargingPeriods.updateSettingsChargingPeriod('cp_171b2c3d4e5f4a6b8c7d9e0f1a2b3c4d', {
    charging_period: {display_name: 'Monthly charge (AU)', description: 'Charges once a month'},
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->chargingPeriods->updateSettingsChargingPeriod(
    'cp_171b2c3d4e5f4a6b8c7d9e0f1a2b3c4d',
    [
        'charging_period' => [
            'display_name' => 'Monthly charge (AU)',
            'description' => 'Charges once a month',
        ],
    ],
);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.charging_periods.charging_periods_dto.ChargingPeriodsDto.SettingsChargingPeriod;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<SettingsChargingPeriod> response = client.chargingPeriods().updateSettingsChargingPeriod(
        "cp_171b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
        Map.of(
                "charging_period", Map.of(
                        "display_name", "Monthly charge (AU)",
                        "description", "Charges once a month")));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.ChargingPeriods.UpdateSettingsChargingPeriodAsync(
    "cp_171b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
    new Dictionary<string, object?>
    {
        ["charging_period"] = new Dictionary<string, object?>
        {
            ["display_name"] = "Monthly charge (AU)",
            ["description"] = "Charges once a month",
        },
    });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.chargingPeriods.updateSettingsChargingPeriod(
  'cp_171b2c3d4e5f4a6b8c7d9e0f1a2b3c4d',
  {
    'charging_period': {
      'display_name': 'Monthly charge (AU)',
      'description': 'Charges once a month',
    },
  },
);
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.ChargingPeriods().UpdateSettingsChargingPeriod(context.Background(), "cp_171b2c3d4e5f4a6b8c7d9e0f1a2b3c4d", map[string]any{
	"charging_period": map[string]any{
		"display_name": "Monthly charge (AU)",
		"description":  "Charges once a month",
	},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "charging_period": {
    "created_by": "<unknown>",
    "created_on": "<string>",
    "description": "<string>",
    "display_name": "<string>",
    "href": "<string>",
    "id": "<string>",
    "last_updated_by": "<unknown>",
    "last_updated_on": "<string>",
    "name": "<string>",
    "object": "<string>",
    "status": "<string>",
    "time_period": {
      "object": "<string>",
      "id": "<string>",
      "name": "<string>",
      "href": "<string>"
    }
  }
}

Send the fields to change under charging_period. You can change its fields or its status.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token. To send a raw JSON body instead of filling in fields, copy the cURL sample and edit its -d payload.

Authorizations

Authorization

string

header

required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Path Parameters

charging_period_id

string

required

The charging period's cp_ id, as a listing or a create returns it.

Body

application/json

charging_period

object

required

Show child attributes

Response

200 - application/json

The updated charging period, under charging_period.

charging_period

object

Show child attributes

Guides

API reference

Authorizations

Path Parameters

Body

Response