Get Capacity Heatmap Dataset

curl --request GET \
  --url https://api.example.com/heatmap

{
  "contributor": "My Network Operator North, My Network Operator South",
  "coverage": "North of Scotland, South of England",
  "creator": "My Network Operator",
  "date": "2024-01-01T00:00:00.000+0000",
  "description": "A heatmaps dataset combined for north and south",
  "format": "application/json",
  "identifier": "c91a4b42-4b21-476d-9c6f-5201a1324b2b",
  "issued": "2023-12-22T00:54:52.196+0000",
  "language": "en",
  "publisher": "My Network Operator",
  "rights": "https://www.mynetworkoperators/link/to/license",
  "title": "North South Heatmap Data",
  "valid": [
    "2024-01-01T00:00:00.000+0000",
    "2024-04-01T00:00:00.000+0000"
  ],
  "Substations": [
    {
      "name": "OSPREY",
      "type": "Primary",
      "area": "Southern England",
      "voltages": [
        33,
        11
      ],
      "longitude": -1.275823,
      "latitude": 51.749565,
      "demandFirmCapacity": 30,
      "demandAvailableCapacity": 0.6,
      "demandConstraint": "Amber",
      "demandConstraintLimitingFactor": "FaultLevel",
      "generationFirmCapacity": 1.504,
      "generationAvailableCapacity": 0.2,
      "generationConstraint": "Amber",
      "generationConstraintLimitingFactor": "FaultLevel",
      "reversePowerFlowTotalCapacity": 0,
      "reversePowerFlowAvailableCapacity": 0,
      "mRID": "248ff818f157022515afc2b8e3c65894449ab903",
      "shortCode": "OSPE",
      "description": "<string>",
      "GSP": "<string>",
      "BSP": "<string>",
      "Primary": "<string>",
      "demandContractedCapacity": 0,
      "demandConnectedCapacity": 123,
      "demandQuotedCapacity": 0,
      "demandMaximum": 23.604368,
      "demandMinimum": 5.986012,
      "demand99Percentile": 123,
      "demand75Percentile": 123,
      "demand50Percentile": 123,
      "demand25Percentile": 123,
      "generationConnectedCapacity": 123,
      "generationContractedCapacity": 0.504,
      "generationQuotedCapacity": 0,
      "breakerRatedCurrent": 123,
      "breakerBreakingCapacity": 123,
      "breakerMakingCapacity": 123,
      "breakerAvailableCapacity": 123,
      "breakerShortCircuitCurrent": 123,
      "breakerShortCircuitDuration": 123,
      "embeddedCapacityRegister": "<string>",
      "Demands": [
        {
          "name": "New Demand Project",
          "aggregate": false,
          "demandConnectedCapacity": 157.58,
          "demandContractedCapacity": 0,
          "voltage": 132,
          "mRID": "<string>",
          "demandQuotedCapacity": 123,
          "technologyType": "<string>"
        }
      ],
      "Generators": [
        {
          "name": "New Generator Project",
          "aggregate": false,
          "generationConnectedCapacity": 2.8,
          "generationContractedCapacity": 0,
          "voltage": 11,
          "mRID": "<string>",
          "generationQuotedCapacity": 123,
          "technologyType": "Wind"
        }
      ],
      "Storage": [
        {
          "name": "New Storage Project",
          "aggregate": false,
          "demandConnectedCapacity": 21.3,
          "demandContractedCapacity": 0,
          "generationConnectedCapacity": 1.8,
          "generationContractedCapacity": 0,
          "voltage": 11,
          "mRID": "<string>",
          "demandQuotedCapacity": 123,
          "generationQuotedCapacity": 123,
          "technologyType": "Battery"
        }
      ],
      "Transformers": [
        {
          "name": "Transformer",
          "voltages": [
            33,
            11
          ],
          "mRID": "<string>",
          "Ratings": [
            {
              "name": "Operational",
              "summerRating": 100,
              "winterRating": 120,
              "fromVoltage": 33,
              "toVoltage": 11
            }
          ]
        }
      ],
      "OtherConstraints": [
        {
          "name": "Station Constraint",
          "description": "No room for upgrades",
          "type": "Physical"
        }
      ],
      "Curtailments": [
        {
          "name": "Low load curtailment",
          "description": "Reduced generation capacity in the afternoon",
          "type": "Generation",
          "curtailedBy": 50,
          "technologyType": "<string>",
          "season": "Summer",
          "dayType": "Weekday",
          "startTime": "11:00",
          "endTime": "16:00"
        }
      ]
    }
  ],
  "Circuits": [
    {
      "mRID": "109cb050-a158-4df7-bd8e-a1e8b0469346",
      "name": "My Example Circuit",
      "voltage": 11,
      "demandConstraint": "Amber",
      "FromSubstation": "b3d5cdd9e3033cf61ec1e5c783a4aedeed93ae55",
      "description": "<string>",
      "demandMaximum": 123,
      "demandMinimum": 123,
      "demand99Percentile": 123,
      "demand75Percentile": 123,
      "demand50Percentile": 123,
      "demand25Percentile": 123,
      "demandAvailableCapacity": 123,
      "demandConnectedCapacity": 123,
      "demandContractedCapacity": 123,
      "demandQuotedCapacity": 123,
      "summerRating": 123,
      "winterRating": 123,
      "ToSubstation": [
        "<string>"
      ],
      "OtherConstraints": [
        {
          "name": "Station Constraint",
          "description": "No room for upgrades",
          "type": "Physical"
        }
      ],
      "Geometry": {
        "type": "LineString",
        "Lines": [
          {
            "Coordinates": [
              {
                "latitude": 56.397694,
                "longitude": -3.437605
              }
            ]
          }
        ]
      }
    }
  ]
}