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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<DataPackage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gemma.WebApi.ServiceModel.CensusData.Model">
  <ElectricPanels>
    <ElectricPanel i:nil="true" />
  </ElectricPanels>
  <GeneralData>
    <GeneralData i:nil="true" />
  </GeneralData>
  <HomogeneousAreaLinks>
    <HomogeneousAreaLink i:nil="true" />
  </HomogeneousAreaLinks>
  <HomogeneousAreas>
    <HomogeneousArea i:nil="true" />
  </HomogeneousAreas>
  <LightSpots>
    <LightSpot i:nil="true" />
  </LightSpots>
  <Pods>
    <POD i:nil="true" />
  </Pods>
</DataPackage>