Make the Create project call

Reference Link

There are only two fields that are required when creating the project through the API; the others are optional:

name
address

Tips

Currently, we do not support translating geolocation to an address when creating a project from the API. This will be supported in the future.

If you have consumption data that you would like to factor into modeling, you can send this data with the Create project or Update project calls. You are required to send 12 values in the kwh array; the first value in the list represents data for January.

Validation

Invalid addresses will receive a 400 error.
If sending consumption data, 12 values representing each month's consumption (starting with January) are required.

Create Project Response

Scanifly will send the Scanifly Project ID back in the response. This value is required in most of the following calls that you will likely be making. Store the Scanifly project ID with your internal ID.

Update Projects

There are scenarios where you may want to update. If you capture the customer's consumption data or would like to add additional client contact information, you can make those requests in the Update projects call.

Make a PATCH call: https://api.portal.scanifly.com/api/v1/projects/{projectId}

Sample_Update Projects_ Call

In this call, the project name and consumption data are being updated on the project.

Sample_Update Projects_ Response

Project Statuses

Project status is returned in the response to the Create and Update project calls. These statuses can be used as triggers to manage workflow in your CRM.

Status	Description
locationSubmitted	Project has been created, address and geolocation stored
doneImagesUploading	User is uploading drone images from the portal or mobile
droneImagesUploaded	Deprecated
submitError	Error occurred when submitting project for processing
uploadProcessing	Photogrammetry model is processing
uploadError	Error occurred during photogrammetry process (i.e. too few photos, poor quality photos, etc.)
uploadComplete	Photogrammetry processing is complete. 3D model is available
remoteDesignStarted	User initiated a remote design
adminLocationSubmitted	Scanifly Admin created a new project on the customer's behalf, not yet visible to customer
adminDoneImagesUploaded	Scanifly Admin uploaded drone images on the customer's behalf, not yet visible to customer
adminUploadProcessing	Scanifly Admin processing images, not yet visible to customer
adminUpload Error	Scanifly Admin's processing request error, not yet visible to customer
adminUploadComplete	Scanifly Admin's project has completed processing, not yet visible to customer
adminDeclined	Project is 'deleted' but not deleted for billing purposes, not visible to customer
adminReplaced	Scanifly Admin has replaced the model with a reprocessed project
maintenance	The installation is complete and maintenance reports are being filled out.
noFlight	Used to indicate that a drone flight will not be completed for this project.