Skip to main content
POST
/
ShadeScene
/
ConvertPVCtoPVJ
Convert PVC file to PVJ shade scene format
curl --request POST \
  --url https://api.plantpredict.terabase.energy/ShadeScene/ConvertPVCtoPVJ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file'
{
  "id": 123,
  "name": "<string>",
  "createdDateUTC": "<string>",
  "createdById": 123,
  "sceneSurfaceArea": 123,
  "dcFieldSurfaceArea": 123,
  "collectorCount": 123,
  "objectCount": 123,
  "orientationTargetDCField": 123,
  "calculationSettingsTargetDCField": 123,
  "siteTableCount": 123,
  "rotation": 123,
  "fractionalShadingPercentage": 123,
  "numberOfModuleFractions": 123
}

Authorizations

Authorization
string
header
required

Pass Authorization: Bearer <token> on every request. See the Authentication section of the API description for how to fetch a token.

Query Parameters

Latitude
number
required
Longitude
number
required
RotateShadingResult
boolean
default:false

Body

multipart/form-data
file
file

Response

Converted shade scene

id
integer
name
string
createdDateUTC
string

ISO-8601 datetime as returned by the PlantPredict API. May or may not include a timezone offset; treat as server-local when no offset is present.

createdById
integer
sceneSurfaceArea
number
dcFieldSurfaceArea
number
collectorCount
integer
objectCount
integer
orientationTargetDCField
integer
calculationSettingsTargetDCField
integer
siteTableCount
integer
rotation
number
binType
enum<integer>

ShadeSceneBinTypes

Available options:
0,
1,
2
collectorType
enum<integer>

CollectorType

Available options:
0,
1,
2
trackerRotationModel
enum<integer>

TrackerRotationModel

Available options:
0,
1,
2
shadingModel
enum<integer>

Shading3DModel

Available options:
0,
1
fractionalShadingPercentage
number
numberOfModuleFractions
integer
shadeObjectType
enum<integer>

ShadeObjectType

Available options:
0,
1