SolarAssessment

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/energy-projects-com-au/json-schema/energy-projects-com-au-solar-assessment-schema.json",
  "title": "SolarAssessment",
  "x-generated": "2026-11-07",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/energy-projects-com-au-openapi.json#/components/schemas/SolarAssessment",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "assessmentId": {
      "type": "string",
      "format": "uuid"
    },
    "generatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "status": {
      "type": "string",
      "enum": [
        "assessed",
        "no_building_match"
      ]
    },
    "confidence": {
      "type": "string",
      "enum": [
        "screening_only"
      ]
    },
    "roof": {
      "anyOf": [
        {
          "type": "null"
        },
        {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "areaM2": {
              "type": "number"
            },
            "source": {
              "type": "string",
              "const": "Overture Maps"
            },
            "sourceRelease": {
              "type": "string"
            }
          },
          "required": [
            "areaM2",
            "source",
            "sourceRelease"
          ]
        }
      ]
    },
    "solar": {
      "anyOf": [
        {
          "type": "null"
        },
        {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "usableRoofCoverage": {
              "type": "number"
            },
            "potentialSystemKw": {
              "type": "number"
            },
            "annualGenerationKwh": {
              "type": "number"
            },
            "annualGenerationSource": {
              "type": "string",
              "enum": [
                "PVGIS",
                "generic_fallback"
              ]
            }
          },
          "required": [
            "usableRoofCoverage",
            "potentialSystemKw",
            "annualGenerationKwh",
            "annualGenerationSource"
          ]
        }
      ]
    },
    "value": {
      "anyOf": [
        {
          "type": "null"
        },
        {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "electricityRateAudPerKwh": {
              "type": "number"
            },
            "grossEnergyValueAudPerYear": {
              "type": "number"
            }
          },
          "required": [
            "electricityRateAudPerKwh",
            "grossEnergyValueAudPerYear"
          ]
        }
      ]
    },
    "incentives": {
      "type": "object"
    },
    "assumptions": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "caveats": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "links": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "interactiveCalculator": {
          "type": "string",
          "format": "uri"
        },
        "humanReview": {
          "type": "string",
          "format": "uri"
        },
        "methodology": {
          "type": "string",
          "format": "uri"
        }
      },
      "required": [
        "interactiveCalculator",
        "humanReview",
        "methodology"
      ]
    }
  },
  "required": [
    "assessmentId",
    "generatedAt",
    "status",
    "confidence",
    "roof",
    "solar",
    "value",
    "incentives",
    "assumptions",
    "caveats",
    "links"
  ]
}