Update Device - Flip Energy API

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

siteId

string

required

id

string

Id

required

Body Params application/json

attributes

object

optional

battery_capacity_wh

string

optional

battery_power_input_w

string

optional

battery_power_output_w

string

optional

configuration

object

optional

reserve_percentage

number

optional

Example

{
  "attributes": {
    "battery_capacity_wh": "string",
    "battery_power_input_w": "string",
    "battery_power_output_w": "string"
  },
  "configuration": {
    "reserve_percentage": 0
  }
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request PATCH 'https://mock.apidog.com/m1/479670-0-default/v1/site//device/' \
--header 'Content-Type: application/json' \
--data-raw ''

Responses

🟢200OK

application/json

Body

id

string

Id

required

site_id

string

required

manufacturer_name

string

Manufacturer Name

required

product_name

string

Product Name

required

serial_number

string

Serial Number

required

type

enum<string>

required

Allowed values:

BATTERYEV_CHARGER

attributes

object (DeviceBatteryAttributes)

required

Structure depends on type. They are not user-adjustable and should be configured during installation / commissioning.

battery_capacity_wh

integer

required

Nominal power capacity of the battery per manufacturer specification, in watt-hours

battery_power_input_w

integer

required

The rated power the battery can continuously discharge at per manufacturer specification, in watts.

battery_power_output_w

integer

required

The rated power the battery can continuously charge at per manufacturer specification, in watts.

configuration

object (DeviceBatteryConfig)

required

Structure depends on type

reserve_percentage

integer

required

User-configurable level that the battery should reserve as a minimum for all VPP events.

install_date

string <date-time> | null

read-onlyoptional

The date the device was installed at the customer's site, or the date it received permission to operate from the utility, if different.

created_at

string <date-time>

Created At

read-onlyrequired

updated_at

string <date-time>

Updated At

read-onlyrequired

Example

{
  "id": "string",
  "site_id": "string",
  "manufacturer_name": "string",
  "product_name": "string",
  "serial_number": "string",
  "type": "BATTERY",
  "attributes": {
    "battery_capacity_wh": 0,
    "battery_power_input_w": 0,
    "battery_power_output_w": 0
  },
  "configuration": {
    "reserve_percentage": 0
  },
  "install_date": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

🟠400Invalid input

🟠404Record not found