Create a new module component

post

https://api.portal.scanifly.com/api/v1/component/module

Query Params

companyId

string

Optional admin override: create the component under this company instead of the authenticated user's company

Body Params

model

string

required

length ≤ 100

Model type

manufacturer

string

required

length ≤ 100

Manufacturer

source

string

enum

required

Source of where this module was created

Allowed:

sourceMetadata

Metadata on module. Required for adminImport and cec; ignored for userCreated.

maxPowerOutput

number

required

≥ 0

Maximum output

maxPowerVoltage

number

required

≥ 0

Maximum Power Voltage (Vmp/V)

maxPowerCurrent

number

required

≥ 0

Maximum Power Current (Imp/A)

openCircuitVoltage

number

required

≥ 0

Open circuit voltage. Unit is volts (V)

shortCircuitCurrent

number

required

≥ 0

Short circuit current. Unit is amps (A)

efficiency

number

0 to 100

Efficiency percentage

dimensions

object

required

Physical dimensions of the module (in millimeters)

weight

number

≥ 0

Weight in kilograms

bifaciality

number

0 to 100

The amount of additional power gain from the rear side of the module. Only applies to bifacial modules.

bipvId

string

Only applies to BIPV modules. Reference to BIPV system object.

cellQuantity

number

required

≥ 0

Quantity of cells

tempCoefficientMaxPower

number

required

Temperature Coefficient of maxPower (%/℃)

tempCoefficientOpenCircuit

number

required

Temperature Coefficient of openCircuitVoltage (%/℃)

tempCoefficientShortCircuit

number

required

Temperature Coefficient of shortCircuitCurrent (%/℃)

cellType

string

enum

required

Type of cell

Allowed:

description

string

Description

defaultTexture

string

enum

required

Default texture image

metadata

object

Optional metadata to store on the auto-created library entry.

Responses

401

403

404

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201