Sign in

v1

latestOpenAPI 3.0.02026-07-241010520.6 KB
Components

Retrieve Module

Retrieve details on a module

get/tenants/{tenant_id}/components/modules/{module_id}

Path parameters

tenant_idstring uuid required

The ID of the tenant to get a module for.

module_idstring uuid required

The ID of the module to retrieve.

Response

Module successfully retrieved.

idstring uuid

The ID of the module.

namestring

The name of the module.

manufacturerstring

The manufacturer of the module.

rating_stcnumber nullable

The module's STC rating in watts.

weightnumber nullable

The weight of the module in kilograms.

spec_sheet_urlstring nullable

A URL to the module's specification sheet.

Example response

{
  "name": "Aurora Sample Module",
  "manufacturer": "Aurora Solar",
  "rating_stc": 350,
  "dimensions": {
    "length": 1,
    "width": 1,
    "height": 0.05
  },
  "weight": 20,
  "spec_sheet_url": "https://www.example.com/module-spec-sheet"
}