AUaurorasolar
Plan Sets

Create Plan Set Request

Changed on

Create a new 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] A plan set request contains information about a project necessary for Aurora to create a plan set document.

Creating a new plan set request requires the following:

  • The id of a design that is ready to install. The design must include modules, and will be more accurate if the stringing and components are already present.
  • The project that the design is associated with must have at least one image or document uploaded to the project as a project asset (see Create Project Asset).

All new plan set requests are created in draft status. See Plan Sets for additional information on statuses.

post/tenants/{tenant_id}/plan_set_requests

Request

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

Path parameters

tenant_idstring uuid required

The ID of the tenant to create the plan set request in.

Request body

Example request

{
  "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."
    }
  }
}

Response

Plan Set Request successfully created.

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