Once a project has been created, you can create a design on that project. Scanifly offers Design Services, that will be addressed in Service Requests.

Create design on project id

Reference Link

Scanifly supports two types of designs:

Remote: Designs based on satellite imagery
On-Site: Designs based on photogrammetry generated by drone images

When creating a new design, you have the option to set which type of design you would like to create. If you do not pass a value, the "remote" value will default to "true', meaning, the design will be a remote design.

remote: true (Remote design based on satellite imagery)
remote: false (On-Site design based on drone imagery)

Sample Create design on project id call

Sample_Create design on project id_ response

When you receive the Create design response, you should store the id value in your system so that you can make subsequent calls to retrieve design specific data and media files.

The Create design on project id response will also include the 'designUrl'. This can be stored in your system so that your team can click a the link from your CRM and open the design in Scanifly, eliminating clicks to navigate to the project and design.

Syncing Designs (Get designs by project id and Get designs by design id)

You have two calls available to retrieve design data.

"Get designs by project id" will return all designs associated with a project. This is useful if rely on multiple design versions in your workflow.

"Get designs by design id" narrows the response to the one design that you are interested in syncing.

There are a few things to keep in mind when examining and parsing the data:

The shadeReport Url will only be populated if a user has done one of the following in Scanifly:
- Generated the shade report and save the design
- Clicked the Export to API button

The shareLinkUrl will only be populated if a user has filled out and clicked the Share button on the 'Share' information tab on the design.

Data in_Get designs by project id / design id _ response

There is a significant amount of data passed in the Get design calls. For the best experience, please go to the API doc and submit a test request to see the full response. This is a brief overview (does not include all fields in response) of the data that you are able to extract from the response.

Field	Description
systemSize	Production for whole system
ASA	Annual Solar Access
annualProduction	Annual production for all segments combined
shadeReportUrl	Shade report URL will be populated if a user has generate shade analysis this in Scanifly
hourlyProductionUrl	Link to the system hourly production report (8760 report)
hourlyProductSegmentUrls	Links to the hourly production report by segment
projectInfoReport	Includes project info, nearest weather station info and distance to weather station
systemOverview	Includes segment count, module quantity, estimated production, annual consumption, System offset, roof surface area, etc
dxf2DWireframeUrl	URL to 2D design file location
dxf3DWireframeUrl	URL to 3D design file location
segmentInfo	Includes module type, quantity, arraySize, estimated production, systemLosses, monthlyAsa, etc.
monthlyBreakdown	Production and Consumption by month