Read Device
GET/v1/site/{siteId}/device/{id}Request
Path Params
siteId
string
required
id
string
Id
Request samples
Responses
Successful Response(200)
Successful Response
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
id
string
Id
site_id
string
required
manufacturer_name
string
Manufacturer Name
product_name
string
Product Name
serial_number
string
Serial Number
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
Use-configurable level that the battery should reserve as a minimum.
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
updated_at
string <date-time>
Updated At
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:22.123Z",
"created_at": "2019-08-24T14:15:22.123Z",
"updated_at": "2019-08-24T14:15:22.123Z"
}Last modified: 8 months ago