Details of a plant

GET 
/plants/:uuid

Details of one plant.

Request

Path Parameters

uuid Uuidrequired

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

Responses

200

Successful Response

application/json

Schema

Schema

• Array [

project_name

object

Name of the plant.

anyOf

MOD1

string

street

object

Street address.

anyOf

MOD1

string

latitude

object

Latitude (WGS 84).

anyOf

MOD1

number

longitude

object

Longitude (WGS 84).

anyOf

MOD1

number

number_panels

object

Number of solar panels.

anyOf

MOD1

integer

• ]

Example (from schema)

[
  {
    "project_name": "string",
    "street": "string",
    "latitude": 0,
    "longitude": 0,
    "number_panels": 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"
}

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"
}

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...