Get Always-On
get
/apis/disaggregation-v1/utilities/{utilityCode}/customers/{customerId}/consumption/alwayson
Returns the always-on value for the given utility, customer uuid, utilityAccountId, and asOf date.
Always-on usage is defined as energy consumed by devices that never turn off and by the stand-by load of devices that are still powered when not in-use.
The response contains the kWh value and decimal ratio value based on the total electricity use.
Request
Path Parameters
-
customerId(required): integer
Utility customer ID.
-
utilityCode(required): string
A 3- or 4-character representation of the client code. Valid examples - "UTIL" and "util".
Query Parameters
-
asOf: string(date-time)
Date in YYYY-MM-DD format (example 2001-12-31). If not specified, the current date is used.
-
utilityAccountId(required): string
Utility customer account ID.
Response
200 Response
Returns always-on usage.
Example Response (application/json)
{
"response":{
"ratio":0.02,
"value":15,
"startDate":"2019-02-01T00:00:00.00Z",
"endDate":"2019-03-01T00:00:00.00Z"
}
}401 Response
Authorization failure.
Nested Schema : ExternalError
Type:
Show Source
object-
errorMessage:
string
Failure explanation.
-
httpStatus:
integer
Example Response (application/json)
{
"error":{
"httpStatus":401,
"errorMessage":"Credentials are required to access this resource"
}
}404 Response
Customer account not found, has no AMI or always-on usage.
Nested Schema : ExternalError
Type:
Show Source
object-
errorMessage:
string
Failure explanation.
-
httpStatus:
integer
Example Response (application/json)
{
"error":{
"httpStatus":404,
"errorMessage":"Account 00000000 not found. (917aab1d-b12a-4df9-b85d-968cc017a96e) "
}
}500 Response
Something unexpected happened while processing your request or an upstream request failed.
Nested Schema : ExternalError
Type:
Show Source
object-
errorMessage:
string
Failure explanation.
-
httpStatus:
integer
Example Response (application/json)
{
"error":{
"httpStatus":500,
"errorMessage":"Unexpected error"
}
}