<back to all web services
DataPackage
The following routes are available for this service:| POST | /census-data/data-package | Carica un pacchetto di dati di censimento per la conversione XML | Questo 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:| Name | Parameter | Data Type | Required | Description |
|---|
| GeneralData | body | List<GeneralData> | No | |
| Pods | body | List<POD> | No | |
| ElectricPanels | body | List<ElectricPanel> | No | |
| LightSpots | body | List<LightSpot> | No | |
| HomogeneousAreas | body | List<HomogeneousArea> | No | |
| HomogeneousAreaLinks | body | List<HomogeneousAreaLink> | No | |
GeneralData Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| SheetID | form | string | No | |
| ISTATCode | form | string | No | |
| City | form | string | No | |
| Region | form | string | No | |
| NumberOfCitizens | form | int | No | |
| Surface | form | double | No | |
| PersonInCharge | form | string | No | |
| Overseer | form | string | No | |
| ForfaitSystemFlag | form | bool | No | |
| PlantStatus | form | string | No | |
| WholeCityFlag | form | bool | No | |
| PercentageOfConnectedLightSpots | form | double | No | |
| NumberOfTotalLightSpots | form | int | No | |
POD Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| PODCode | form | string | No | |
| Toponym | form | string | No | |
| LocationReference | form | string | No | |
| VarietyFlag | form | bool | No | |
| NumberOfElectricPanels | form | int | No | |
| ContractType | form | string | No | |
| SupplierName | form | string | No | |
| InstalledPower | form | double | No | |
| PreviousYearAnnualConsumption | form | double | No | |
| PublicTenderID | form | string | No | |
ElectricPanel Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| ElectricPanelID | form | string | No | |
| PODCodeFK | form | string | No | |
| OperatingStatus | form | string | No | |
| ConstructionYear | form | int | No | |
| OnlyPublicLighitingFlag | form | bool | No | |
| NumberOfConnectedLightSpots | form | int | No | |
| NumberOfSupports | form | int | No | |
| PowerOnMeans | form | string | No | |
| NumberOfOperatingHours | form | int | No | |
LightSpot Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| LightSpotID | form | string | No | |
| ElectricPanelIDFK | form | string | No | |
| LightSpotDeviceID | form | string | No | |
| EquipmentType | form | string | No | |
| Height | form | double | No | |
| SupportMaterial | form | string | No | |
| SupportStatus | form | string | No | |
| LightSourceType | form | string | No | |
| NominalPower | form | double | No | |
| CCT | form | int | No | |
HomogeneousArea Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| HomogeneousAreaID | form | string | No | |
| AreaTypology | form | string | No | |
| RoadClassificationCode | form | string | No | |
| GridLength | form | double | No | |
| GridWidth | form | double | No | |
HomogeneousAreaLink Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| HomogeneousAreaIDFK | form | string | No | |
| LightSpotDeviceIDFK | form | string | No | |
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>