Gemma.WebApi

<back to all web services

DataPackage

The following routes are available for this service:
POST/census-data/data-packageCarica un pacchetto di dati di censimento per la conversione XMLQuesto endpoint è fittizio e rappresenta un **contratto dati**. Non è inteso per essere chiamato direttamente tramite HTTP. Serve a descrivere la struttura completa dei dati estratti, facilitando la generazione automatica di DTOs tramite `openapi-generator-cli` per il tool di conversione Excel-XML.
DataPackage Parameters:
NameParameterData TypeRequiredDescription
GeneralDatabodyList<GeneralData>No
PodsbodyList<POD>No
ElectricPanelsbodyList<ElectricPanel>No
LightSpotsbodyList<LightSpot>No
HomogeneousAreasbodyList<HomogeneousArea>No
HomogeneousAreaLinksbodyList<HomogeneousAreaLink>No
GeneralData Parameters:
NameParameterData TypeRequiredDescription
SheetIDformstringNo
ISTATCodeformstringNo
CityformstringNo
RegionformstringNo
NumberOfCitizensformintNo
SurfaceformdoubleNo
PersonInChargeformstringNo
OverseerformstringNo
ForfaitSystemFlagformboolNo
PlantStatusformstringNo
WholeCityFlagformboolNo
PercentageOfConnectedLightSpotsformdoubleNo
NumberOfTotalLightSpotsformintNo
POD Parameters:
NameParameterData TypeRequiredDescription
PODCodeformstringNo
ToponymformstringNo
LocationReferenceformstringNo
VarietyFlagformboolNo
NumberOfElectricPanelsformintNo
ContractTypeformstringNo
SupplierNameformstringNo
InstalledPowerformdoubleNo
PreviousYearAnnualConsumptionformdoubleNo
PublicTenderIDformstringNo
ElectricPanel Parameters:
NameParameterData TypeRequiredDescription
ElectricPanelIDformstringNo
PODCodeFKformstringNo
OperatingStatusformstringNo
ConstructionYearformintNo
OnlyPublicLighitingFlagformboolNo
NumberOfConnectedLightSpotsformintNo
NumberOfSupportsformintNo
PowerOnMeansformstringNo
NumberOfOperatingHoursformintNo
LightSpot Parameters:
NameParameterData TypeRequiredDescription
LightSpotIDformstringNo
ElectricPanelIDFKformstringNo
LightSpotDeviceIDformstringNo
EquipmentTypeformstringNo
HeightformdoubleNo
SupportMaterialformstringNo
SupportStatusformstringNo
LightSourceTypeformstringNo
NominalPowerformdoubleNo
CCTformintNo
HomogeneousArea Parameters:
NameParameterData TypeRequiredDescription
HomogeneousAreaIDformstringNo
AreaTypologyformstringNo
RoadClassificationCodeformstringNo
GridLengthformdoubleNo
GridWidthformdoubleNo
HomogeneousAreaLink Parameters:
NameParameterData TypeRequiredDescription
HomogeneousAreaIDFKformstringNo
LightSpotDeviceIDFKformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /census-data/data-package HTTP/1.1 
Host: gemma.api.kerberos.energy 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	generalData: 
	[
		{
			
		}
	],
	pods: 
	[
		{
			
		}
	],
	electricPanels: 
	[
		{
			
		}
	],
	lightSpots: 
	[
		{
			
		}
	],
	homogeneousAreas: 
	[
		{
			
		}
	],
	homogeneousAreaLinks: 
	[
		{
			
		}
	]
}