Total yearly yield

GET 
/performance/total/:uuid/:year

Production of a plant over a year, summed from its monthly values.

Request

Path Parameters

uuid Uuidrequired

Unique identifier (UUID) of the plant, as listed by /plants.

year Yearrequired

Year of the data.

Responses

200

Successful Response

application/json

Schema

Schema

year Year (integer)required

p_yield

object

Sum of the year's monthly yields, in kWh.

anyOf

MOD1

number

p_yield_estimated

object

Sum of the same months' estimates, in kWh.

anyOf

MOD1

number

Example (from schema)

{
  "year": 0,
  "p_yield": 0,
  "p_yield_estimated": 0
}

401

MISSING_API_KEY: no x-api-key header.

application/json

Schema

Schema

code Code (string)required

Stable error code to branch on, e.g. ACCESS_DENIED.

message Message (string)required

Human-readable explanation.

error

object

Same text as message, on 401 and 403 only (older clients).

anyOf

MOD1

string

Example (from schema)

{
  "code": "string",
  "message": "string",
  "error": "string"
}

402

INVALID_PARAMETER, INVALID_DATE, DATA_NOT_AVAILABLE (year out of range or month still running) or INVALID_INTERVAL.

application/json

Schema

Schema

code Code (string)required

Stable error code to branch on, e.g. ACCESS_DENIED.

message Message (string)required

Human-readable explanation.

error

object

Same text as message, on 401 and 403 only (older clients).

anyOf

MOD1

string

Example (from schema)

{
  "code": "string",
  "message": "string",
  "error": "string"
}

403

UNKNOWN_API_KEY or ACCESS_DENIED: the key's access does not cover this route, plant or date.

application/json

Schema

Schema

code Code (string)required

Stable error code to branch on, e.g. ACCESS_DENIED.

message Message (string)required

Human-readable explanation.

error

object

Same text as message, on 401 and 403 only (older clients).

anyOf

MOD1

string

Example (from schema)

{
  "code": "string",
  "message": "string",
  "error": "string"
}

404

NO_DATA: no performance data for this period.

application/json

Schema

Schema

code Code (string)required

Stable error code to branch on, e.g. ACCESS_DENIED.

message Message (string)required

Human-readable explanation.

error

object

Same text as message, on 401 and 403 only (older clients).

anyOf

MOD1

string

Example (from schema)

{
  "code": "string",
  "message": "string",
  "error": "string"
}

500

INTERNAL_ERROR.

application/json

Schema

Schema

code Code (string)required

Stable error code to branch on, e.g. ACCESS_DENIED.

message Message (string)required

Human-readable explanation.

error

object

Same text as message, on 401 and 403 only (older clients).

anyOf

MOD1

string

Example (from schema)

{
  "code": "string",
  "message": "string",
  "error": "string"
}

Loading...