AUaurorasolar
Site Surveys

Retrieve Site Survey

Changed on

Returns 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]

get/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 to get a site survey for.

site_survey_idstring uuid required

The ID of the site survey to retrieve.

Response

Site survey successfully retrieved.

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"
      }
    ],
    "electrical": {
      "main_bus_rating": 200,
      "main_breaker_rating": 200,
      "existing_grounding_location": "garage",
      "main_panel_manufacturer": "Square D",
      "images": [
        {
          "url": "https://example.com/image.jpg",
          "filename": "image.jpg"
        }
      ],
      "notes": "Meter obscured by overgrown hedge",
      "subpanels": [
        {
          "location": "Garage west wall",
          "disconnect_location": "Garage west wall",
          "bus_rating": 125,
          "disconnect_size": 100,
          "notes": "Broken latch needs to be replaced",
          "images": [
            {
              "url": "https://example.com/image.jpg",
              "filename": "image.jpg"
            }
          ]
        }
      ]
    },
    "roof": {
      "mounting_planes": [
        {
          "units_of_measurement": "Imperial",
          "pitch": 21,
          "azimuth": 180,
          "roof_type": "composition_shingles",
          "framing_type": "trussed",
          "rafter_size": "2x4",
          "rafter_spacing": 24,
          "notes": "Water damage around vent pipe",
          "images": [
            {
              "url": "https://example.com/image.jpg",
              "filename": "image.jpg"
            }
          ]
        }
      ]
    }
  }
}

Changes