AUaurorasolar
Plan Sets

Retrieve Plan Set Request

Changed on

Retrieve a plan set request.

[block:callout] { "type": "warning", "body": "Please note that the Plan Set Requests API is in limited release at this time, and is subject to change. If you are interested in accessing this API, please contact your Aurora account team." } [/block]

get/tenants/{tenant_id}/plan_set_requests/{id}

Request

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

Path parameters

tenant_idstring uuid required

The ID of the tenant that the plan set request was submitted for.

idstring uuid required

The ID of the plan set request to retrieve.

Response

Plan Set Request successfully retrieved

Example response

{
  "plan_set_request": {
    "project_information": {
      "ahj_notes_or_setbacks": "Plans need to show dimensions from roof edges to modules.",
      "contractor_name": "Jane Doe",
      "contractor_address": "434 Brannan St, San Francisco, CA, USA",
      "contractor_phone": "(415) 360-9291"
    },
    "electrical_information": {
      "main_panel_location": "Below the meter",
      "main_bus_rating": 125,
      "main_breaker_rating": 100,
      "existing_grounding_location": "Below the meter",
      "main_service_panel_manufacturer": "Square D",
      "main_panel_upgrade": true,
      "main_panel_upgrade_bus_rating": 225,
      "main_panel_upgrade_main_breaker_rating": 200,
      "electrical_notes": "Thin breakers to make space for the PV breaker."
    }
  }
}

Changes