AUaurorasolar
Site Surveys

Update Site Survey Overview

Changed on

Updates the overview of a site survey.

[block:callout] { "type": "warning", "body": "Please note that the Site Surveys API is in beta. As a beta product, the API will not be supported via our normal support channels. You may also experience some gaps and changes as the product is refined and documentation is updated before general release." } [/block]

This endpoint is used to update metadata and overview attributes on a site survey.

Currently the only allowed overview field is notes.

To update other site survey attribtues, see:

  • Update Site Survey Electrical Data
  • Update Site Survey Electrical Subpanels
  • Update Site Survey Mounting Planes
  • Update Site Survey Status
put/tenants/{tenant_id}/site_surveys/{site_survey_id}

Request

  • Base URL
    https://api-sandbox.aurorasolar.com
  • URL
    https://api-sandbox.aurorasolar.com/tenants/{tenant_id}/site_surveys/{site_survey_id}
  • Auth
    HTTP bearer

Path parameters

tenant_idstring uuid required

The ID of the tenant the site survey belongs to

site_survey_idstring uuid required

The ID of the site survey to update overview for.

Request body

Example request

{
  "site_survey": {
    "report": {
      "url": "https://example.com/report.pdf",
      "filename": "report.pdf"
    },
    "notes": "Corner lot. Easy access to mounting planes and main panel",
    "images": [
      {
        "url": "https://example.com/image.jpg",
        "filename": "image.jpg"
      }
    ]
  }
}

Response

Overview successfully updated.

Example response

{
  "site_survey": {
    "report": {
      "url": "https://example.com/report.pdf",
      "filename": "report.pdf"
    },
    "notes": "Corner lot. Easy access to mounting planes and main panel",
    "images": [
      {
        "url": "https://example.com/image.jpg",
        "filename": "image.jpg"
      }
    ]
  }
}

Changes