Get Designs
An easy guide to use the Get Designs endpoint to retrieve one or multiple Designs that were created using the Create Designs endpoint and the Quickr Design App
Get Designs Endpoint
To successfully retrieve one or multiple Designs via their Calculation Id’s, the following endpoint can be used:
Endpoint:https://api.novasole.com/designs/get
Request Method:POST
Request Body
The request body includes one or multiple Calculation Id’s from designs created via the Create Design endpoint and Quickr Design App.
{
"calculationIds": [
293821,293820
]
}Successful Response
A successful Get Designs request provides detailed insights about the created energy system and it’s location. This includes for example roof surface data, a detailed overview and pricing of articles in the designed energy system, financial specifications, yearly and monthly energy flows (in kWh) and technical details about the calculation.
Example response:
{
"designAppUrl": "…",
"errors": [
"…"
],
"calculationInfo": {
"calculationId": 1,
"refId": "…",
"creationDate": "2025-03-06T13:56:51.265Z"
},
"location": {
"addressInfo": {
"countryAndRegion": {
"countryId": 1,
"country": "…",
"regionId": 1,
"region": "…"
},
"postalCode": "…",
"houseNumber": 1,
"additive": "…",
"secondAdditive": "…",
"street": "…",
"place": "…",
"latitude": 1,
"longitude": 1
},
"buildingInfo": {
"buildings": [
{
"buildingId": "…",
"buildingType": "…",
"buildingSubType": "…",
"energyLabel": {
"label": "…",
"buildingType": "…",
"buildingSubType": "…"
},
"buildingYear": 1,
"constructionYear": 1,
"dwellingTypeId": 1,
"dwellingType": "…"
}
],
"buildingObstaclesMerged": "…"
},
"locationClimate": {
"ghi": 1,
"goi": 1,
"at": 1,
"irradiationDisk": "…",
"source": {
"pvGisSaf": {
"latitude": 1,
"longitude": 1,
"irradiation": 1
},
"pvGisTemperature": {
"latitude": 1,
"longitude": 1,
"temperature": 1
},
"pvGisIrradiation": {
"latitude": 1,
"longitude": 1,
"irradiation": 1
},
"knmi": {
"stationId": 1,
"station": {
"station": 1,
"latitude": 1,
"longitude": 1,
"altitude": 1,
"place": "…",
"measurements": [
{
"stationId": 1,
"station": null,
"date": 1,
"tg": 1,
"tn": 1,
"tx": 1,
"sq": 1,
"q": 1,
"rh": 1,
"ng": 1
}
]
},
"date": 1,
"tg": 1,
"tn": 1,
"tx": 1,
"sq": 1,
"q": 1,
"rh": 1,
"ng": 1
},
"pvSol": {},
"pvGisMonthlyTemperature": [
{
"latitude": 1,
"longitude": 1,
"month": 1,
"avgTemperature": 1
}
]
}
},
"allSurfaces": {
"surfaces": [
{
"id": 1,
"roofTypeId": 1,
"roofType": "…",
"area": 1,
"inclination": 1,
"orientation": 1,
"gutter": 1,
"ridge": 1,
"shadowLoss": 1,
"roofpotential": 1
}
]
}
},
"energyScenario": {
"yearlyUsage": 1,
"productPreferences": {
"campaignId": 1,
"packageId": 1,
"moduleId": 1
}
},
"customer": {
"customerId": 1,
"email": "…",
"firstName": "…",
"insertion": "…",
"lastName": "…",
"organization": "…",
"telephone": "…",
"fullName": "…"
},
"energySystemInfo": {
"energySystemId": 1,
"priceSummary": {
"subtotal": 1,
"discount": 1,
"netPrice": 1,
"vatAmounts": {
"vatAmountNetPrice": 1,
"batteryTax": {
"batteryTax": 1,
"batteryVatPercentage": 1,
"vatAmountBatteryTax": 1
},
"vatAmount": 1,
"vatRefund": 1
},
"grossPrice": 1
},
"powerTotalsSummary": {
"totalNrOfPv": 1,
"totalMaxNrOfPv": 1,
"totalInstalledPvPower": 1,
"totalInstalledInverterPower": 1
},
"articlesPerGroup": {
"solarPanelGroups": [
{
"groupArticles": [
{
"groupId": 1,
"buildingBlockId": 1,
"buildingBlock": "…",
"categoryId": 1,
"category": "…",
"name": "…",
"model": "…",
"quantity": 1,
"unit": "…",
"description": "…",
"articleCode": "…",
"eanCode": "…",
"warranty": 1,
"pricing": {
"purchasePrice": 1,
"price": 1,
"orderQuantity": 1,
"totalPrice": 1,
"totalPriceDiscounted": 1,
"margin": 1,
"vatAmountDiscounted": 1,
"vat": 1,
"discount": 1
}
}
]
}
],
"otherGroup": {
"groupArticles": []
}
},
"energyHarvesting": {
"inverterConfiguration": [],
"layoutImages": [
"…"
]
},
"energyStorage": {},
"energyUse": {},
"energyManagement": {},
"billOfMaterials": [
{
"ballastSetup": {
"designIntegrationType": 1,
"ballast": [
[
1
]
],
"isEastWest": true
},
"products": [
{
"designIntegrationType": 1,
"code": "…",
"articleCode": "…",
"name": "…",
"quantity": 1,
"price": 1,
"totalPrice": 1,
"priceDiscounted": 1,
"totalPriceDiscounted": 1
}
],
"mountingPvSystemItemId": 1,
"error": {
"errorCategory": 1,
"errorCategoryText": "…",
"errorCode": 1,
"errorMessage": "…"
}
}
]
},
"energySystemCalculationResults": {
"energyFlows": [
{
"yearIndex": 1,
"usage": {
"yearlyKWh": 1,
"selfConsumptionPercentage": 1,
"balancingFactor": 1,
"productionExcessFactor": 1,
"monthlyKWh": {
"yearIndex": 1,
"january": 1,
"february": 1,
"march": 1,
"april": 1,
"may": 1,
"june": 1,
"july": 1,
"august": 1,
"september": 1,
"october": 1,
"november": 1,
"december": 1,
"sum": 1
}
},
"production": {
"yearlyKWh": 1,
"selfConsumptionPercentage": 1,
"balancingFactor": 1,
"productionExcessFactor": 1,
"monthlyKWh": {
"yearIndex": 1,
"january": 1,
"february": 1,
"march": 1,
"april": 1,
"may": 1,
"june": 1,
"july": 1,
"august": 1,
"september": 1,
"october": 1,
"november": 1,
"december": 1,
"sum": 1
}
},
"selfConsumption": {
"yearlyKWh": 1,
"selfConsumptionPercentage": 1,
"balancingFactor": 1,
"productionExcessFactor": 1,
"monthlyKWh": {
"yearIndex": 1,
"january": 1,
"february": 1,
"march": 1,
"april": 1,
"may": 1,
"june": 1,
"july": 1,
"august": 1,
"september": 1,
"october": 1,
"november": 1,
"december": 1,
"sum": 1
}
},
"productionExcess": {
"yearlyKWh": 1,
"selfConsumptionPercentage": 1,
"balancingFactor": 1,
"productionExcessFactor": 1,
"monthlyKWh": {
"yearIndex": 1,
"january": 1,
"february": 1,
"march": 1,
"april": 1,
"may": 1,
"june": 1,
"july": 1,
"august": 1,
"september": 1,
"october": 1,
"november": 1,
"december": 1,
"sum": 1
}
},
"balancingAmount": {
"yearlyKWh": 1,
"selfConsumptionPercentage": 1,
"balancingFactor": 1,
"productionExcessFactor": 1,
"monthlyKWh": {
"yearIndex": 1,
"january": 1,
"february": 1,
"march": 1,
"april": 1,
"may": 1,
"june": 1,
"july": 1,
"august": 1,
"september": 1,
"october": 1,
"november": 1,
"december": 1,
"sum": 1
}
},
"productionExcessFeedIn": {
"yearlyKWh": 1,
"selfConsumptionPercentage": 1,
"balancingFactor": 1,
"productionExcessFactor": 1,
"monthlyKWh": {
"yearIndex": 1,
"january": 1,
"february": 1,
"march": 1,
"april": 1,
"may": 1,
"june": 1,
"july": 1,
"august": 1,
"september": 1,
"october": 1,
"november": 1,
"december": 1,
"sum": 1
}
},
"usageGridTake": {
"yearlyKWh": 1,
"selfConsumptionPercentage": 1,
"balancingFactor": 1,
"productionExcessFactor": 1,
"monthlyKWh": {
"yearIndex": 1,
"january": 1,
"february": 1,
"march": 1,
"april": 1,
"may": 1,
"june": 1,
"july": 1,
"august": 1,
"september": 1,
"october": 1,
"november": 1,
"december": 1,
"sum": 1
}
}
}
]
}
}