Design Requests

Retrieve Design Request

Changed on

Retrieve a design request by ID.

get/tenants/{tenant_id}/design_requests/{id}

Request

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

Path parameters

tenant_idstring uuid required

The ID of the tenant that the design request is part of.

idstring uuid required

The ID of the design request to retrieve.

Response

Design Request successfully retrieved.

Example response

{
  "design_request": {
    "status": "submitted",
    "latitude": 40.71435282,
    "longitude": -74.00597314,
    "address": "123 Main Street, Unit 12, City, CA, 93120",
    "image_metadata": {
      "capture_date": "2024-03-19",
      "resolution": 5.5
    },
    "lidar_metadata": {
      "capture_date": "2024-03-19"
    },
    "sla": 180,
    "auto_accept": true,
    "roof_pitch": 15,
    "number_of_stories": 2
  }
}

Changes

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      removed the EagleView enum value from the / response property for the response status