Plan Set Integratations

Plan Sets

The process to export Plan Sets is similar. Scanifly's design process generates several files that may or may not be needed to render the design in the Racking Provider's tool. This integration will

  1. Follow above steps 1-6 above.
  2. You have the project and design ids. Make a Get designs by design id (link to call overview) call to find the location of the files needed to render designs in your tool. Depending on your process you may rely on 2D or 3D files. You may want shade reports or other project info. For that reason, the Get design API response will provide the location to the files you rely on. Commonly used files include:
FieldDescription
systemSizeProduction for whole system
ASAAnnual Solar Access
annualProductionAnnual production for all segments combined
shadeReportUrlShade report URL will be populated if a user has generate shade analysis this in Scanifly
hourlyProductionUrlLink to the system hourly production report
hourlyProductSegmentUrlsLinks to the hourly production by segments report
projectInfoReportIncludes project info, nearest weather station info and distance to weather station
systemOverviewIncludes segment count, module quantity, estimated production, annual consumption, System offset, roof surface area, etc
dxf2DWireframeUrlURL to 2D design file location
dxf3DWireframeUrlURL to 3D design file location
segmentInfoIncludes module type, quantity, arraySize, estimated production, systemLosses, monthlyAsa, etc.
monthlyBreakdownProduction and Consumption by month