Create Plan Set Request

post https://api-sandbox.aurorasolar.com/tenants/{tenant_id}/plan_set_requests

Create a new plan set request.

🚧
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.

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.

Responses

Response body

object

plan_set_request

object

uuid

Unique ID identifying the plan set request within Aurora.

design_cad_view_url

string

A link to the CAD view of the design the plan set request was created for.

design_id

uuid

The ID of the design the plan set request was created for.

plan_set_intake_form_url

string

A link to the intake form for the plan set request.

project_id

uuid

The ID of the project the plan set request was created for.

project_overview_url

string

A link to the project overview of the project the plan set request was created for.

rejection_reasons

array of objects

rejection_reasons

object

reason

string

The reason why the plan set request was rejected.

missing_information outside_scope other

sub_reasons

array of strings

Additional information related to the rejection reason.

sub_reasons

status

string

The status of the plan set request.

draft submitted completed rejected

project_information

object

electrical_information

object

Language

Credentials

Bearer

header


xxxxxxxxxx
13
1
curl --request POST \
2
     --url https://api-sandbox.aurorasolar.com/tenants/tenant_id/plan_set_requests \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "plan_set_request": {
8
    "electrical_information": {
9
      "main_bus_rating": 30
10
    }
11
  }
12
}
13
'


xxxxxxxxxx
42
}
1
{
2
  "plan_set_request": {
3
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4
    "design_cad_view_url": "https://v2.aurorasolar.com/projects/60ac2924-78f5-4bbc-90a3-3cd1a2e90d54/designs/4406e8c7-5f3d-4037-8bc4-ea84aea8710c/cad",
5
    "design_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
6
    "plan_set_intake_form_url": "https://v2.aurorasolar.com/projects/60ac2924-78f5-4bbc-90a3-3cd1a2e90d54/plan-set/7ff13d71-e70f-4bcd-b65e-a3c4c5444d9c",
7
    "project_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
8
    "project_overview_url": "https://v2.aurorasolar.com/projects/60ac2924-78f5-4bbc-90a3-3cd1a2e90d54",
9
    "rejection_reasons": [
10
      {
11
        "reason": "outside_scope",
12
        "sub_reasons": [
13
          "Commercial project"
14
        ]
15
      }
16
    ],
17
    "status": "draft",
18
    "project_information": {
19
      "ahj_notes_or_setbacks": "Plans need to show dimensions from roof edges to modules.",
20
      "contractor_name": "Jane Doe",
21
      "contractor_license_number": "string",
22
      "contractor_license_type": "string",
23
      "contractor_address": "434 Brannan St, San Francisco, CA, USA",
24
      "contractor_phone": "(415) 360-9291"
25
    },

200Plan Set Request successfully created.

400Bad Request

401Unauthorized

403Forbidden

404Provided design was not found.

409A plan set request already exists for the project.

422Unprocessable Entity