AUaurorasolar
Designs

Retrieve Design

Changed on

Retrieve a design

get/tenants/{tenant_id}/designs/{id}

Request

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

Path parameters

tenant_idstring uuid required

The ID of the tenant to retrieve the design in.

idstring uuid required

The ID of the design to retrieve.

Response

Design successfully retrieved.

Example response

{
  "design": {
    "external_provider_id": "YourId123",
    "name": "My first test design",
    "milestone": {
      "notes": "Customer signed contract"
    },
    "image_metadata": {
      "capture_date": "2024-03-19",
      "resolution": 5.5
    },
    "lidar_metadata": {
      "capture_date": "2024-03-19"
    }
  }
}

Changes

  • 97a7ad8a993aRevision changes
    • warning

      added the new Custom enum value to the / response property for the response status

    • warning

      added the new Custom enum value to the / response property for the response 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