Repository navigation
DiGi.GIS.WebAPI.UI.Controllers
Provides API endpoints for managing and retrieving 2D administrative areal data.
public class AdministrativeAreal2DController : Microsoft.AspNetCore.Mvc.ControllerInheritance System.Object → Microsoft.AspNetCore.Mvc.ControllerBase → Microsoft.AspNetCore.Mvc.Controller → AdministrativeAreal2DController
Initializes a new instance of the AdministrativeAreal2DController class.
public AdministrativeAreal2DController(System.Net.Http.IHttpClientFactory httpClientFactory);httpClientFactory System.Net.Http.IHttpClientFactory
The System.Net.Http.IHttpClientFactory used to create HTTP clients.
Searches for administrative area reference paths by name.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetAdministrativeAreal2DReferencePathsByNameAsync(string text);text System.String
The text to search for within the name column.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A System.Threading.Tasks.Task<> representing the asynchronous operation, containing the result of the search.
AdministrativeAreal2DController.GetAdministrativeAreal2DReferencesByAdministrativeArealTypeAsync(string, Nullable<int>, Nullable<bool>) Method
Retrieves administrative 2D area references based on the specified administrative areal type, parent identifier, and unique code filter.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetAdministrativeAreal2DReferencesByAdministrativeArealTypeAsync(string administrativeArealType, System.Nullable<int> parentId, System.Nullable<bool> uniqueCode);administrativeArealType System.String
The type of the administrative area.
parentId System.Nullable<System.Int32>
The optional identifier of the parent administrative area.
uniqueCode System.Nullable<System.Boolean>
An optional flag indicating whether to filter by unique code.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A System.Threading.Tasks.Task<> representing the asynchronous operation result.
Retrieves administrative areal 2D references by the specified code asynchronously.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetAdministrativeAreal2DReferencesByCodeAsync(string code);code System.String
The code used to retrieve the administrative areal 2D references.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A System.Threading.Tasks.Task<> representing the asynchronous operation result.
Retrieves the administrative areal 2D references by their identifier.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetAdministrativeAreal2DReferencesByIdAsync(int id);id System.Int32
The unique identifier of the administrative areal 2D reference.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation. The task result contains an Microsoft.AspNetCore.Mvc.IActionResult.
Retrieves an administrative areal 2D item by its specified code.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetItemByCodeAsync(string code);code System.String
The code of the item to retrieve.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation. The task result contains an Microsoft.AspNetCore.Mvc.IActionResult.
Retrieves items filtered by the specified administrative area type.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetItemsByAdministrativeArealTypeAsync(string administrativeArealType);administrativeArealType System.String
The administrative area type (e.g., country, voivodeship, county, municipality) to filter by.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A System.Threading.Tasks.Task<> representing the asynchronous operation result containing the items or an error response.
Retrieves polygons associated with a specific administrative areal identifier.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetPolygonsByIdAsync(int id, System.Nullable<double> reductionFactor=null, System.Nullable<int> minCount=null);id System.Int32
The unique identifier of the administrative areal.
reductionFactor System.Nullable<System.Double>
The optional reduction factor used to simplify the geometry of the retrieved polygons.
minCount System.Nullable<System.Int32>
The optional minimum count for filtering the results.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A Microsoft.AspNetCore.Mvc.IActionResult representing the result of the request.
Starts the Administrative Areal 2D view.
public Microsoft.AspNetCore.Mvc.IActionResult Start();Microsoft.AspNetCore.Mvc.IActionResult
An Microsoft.AspNetCore.Mvc.IActionResult result that renders the start view.
Provides API endpoints for managing and retrieving building 2D information.
public class Building2DController : Microsoft.AspNetCore.Mvc.ControllerInheritance System.Object → Microsoft.AspNetCore.Mvc.ControllerBase → Microsoft.AspNetCore.Mvc.Controller → Building2DController
Initializes a new instance of the Building2DController class.
public Building2DController(System.Net.Http.IHttpClientFactory httpClientFactory);httpClientFactory System.Net.Http.IHttpClientFactory
The System.Net.Http.IHttpClientFactory used to create System.Net.Http.HttpClient instances.
Asynchronously retrieves building 2D references associated with the specified administrative areal 2D identifier.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetBuilding2DReferencesByAdministrativeAreal2DIdAsync(int administrativeAreal2DId);administrativeAreal2DId System.Int32
The administrative areal 2D identifier to filter by.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A System.Threading.Tasks.Task<> representing the asynchronous operation.
Asynchronously retrieves a building 2D item by its unique identifier.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetItemByIdAsync(long id, System.Nullable<int> countyId);id System.Int64
The unique identifier of the item to retrieve.
countyId System.Nullable<System.Int32>
The optional unique identifier of the county associated with the item.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation, containing the Microsoft.AspNetCore.Mvc.IActionResult result.
Asynchronously retrieves 2D points based on a collection of references and an optional county identifier.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetPointsByReferencesAsync(System.Collections.Generic.IEnumerable<string> references, System.Nullable<int> countyId);references System.Collections.Generic.IEnumerable<System.String>
The collection of string references used to identify the building points.
countyId System.Nullable<System.Int32>
The optional integer identifier of the county associated with the buildings.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation. The task result contains an Microsoft.AspNetCore.Mvc.IActionResult.
Building2DController.GetPolygonByIdAsync(long, Nullable<int>, Nullable<double>, Nullable<int>) Method
Retrieves a polygon by its unique identifier asynchronously.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetPolygonByIdAsync(long id, System.Nullable<int> countyId, System.Nullable<double> reductionFactor=null, System.Nullable<int> minCount=null);id System.Int64
The unique identifier of the polygon.
countyId System.Nullable<System.Int32>
The optional county identifier used to filter the request.
reductionFactor System.Nullable<System.Double>
The optional reduction factor for simplifying the polygon geometry.
minCount System.Nullable<System.Int32>
The optional minimum count threshold for the data retrieval.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A System.Threading.Tasks.Task<> representing the asynchronous operation result containing the requested polygon data.
Initializes and returns the start view for the 2D building interface.
public Microsoft.AspNetCore.Mvc.IActionResult Start();Microsoft.AspNetCore.Mvc.IActionResult
An Microsoft.AspNetCore.Mvc.IActionResult result that renders the starting view.
Provides controller endpoints for accessing and managing building data, acting as an interface between the client and the underlying GIS building data services.
public class BuildingDataController : Microsoft.AspNetCore.Mvc.ControllerInheritance System.Object → Microsoft.AspNetCore.Mvc.ControllerBase → Microsoft.AspNetCore.Mvc.Controller → BuildingDataController
Initializes a new instance of the BuildingDataController class.
public BuildingDataController(System.Net.Http.IHttpClientFactory httpClientFactory);httpClientFactory System.Net.Http.IHttpClientFactory
The System.Net.Http.IHttpClientFactory used to create and manage System.Net.Http.HttpClient instances for making API requests.
Asynchronously retrieves a building data table based on the specified reference and an optional county identifier.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetTableByReferenceAsync(string reference, System.Nullable<int> countyId=null);reference System.String
The unique reference string used to look up the table.
countyId System.Nullable<System.Int32>
The optional ID of the county associated with the request.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation. The task result contains an Microsoft.AspNetCore.Mvc.IActionResult representing the HTTP response.
Handles the HTTP GET request to the root endpoint and returns the starting view for building data operations.
public Microsoft.AspNetCore.Mvc.IActionResult Start();Microsoft.AspNetCore.Mvc.IActionResult
An Microsoft.AspNetCore.Mvc.IActionResult representing the start view.
Provides controller endpoints for accessing and managing EPW file data.
public class EPWFileController : Microsoft.AspNetCore.Mvc.ControllerInheritance System.Object → Microsoft.AspNetCore.Mvc.ControllerBase → Microsoft.AspNetCore.Mvc.Controller → EPWFileController
Initializes a new instance of the EPWFileController class.
public EPWFileController(System.Net.Http.IHttpClientFactory httpClientFactory);httpClientFactory System.Net.Http.IHttpClientFactory
The HTTP client factory.
Asynchronously retrieves an EPW file based on the specified coordinates.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetEPWFileAsync(double x, double y);The X coordinate (longitude).
The Y coordinate (latitude).
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation. The task result contains an Microsoft.AspNetCore.Mvc.IActionResult representing the HTTP response.
Returns the starting view.
public Microsoft.AspNetCore.Mvc.IActionResult Start();Microsoft.AspNetCore.Mvc.IActionResult
An Microsoft.AspNetCore.Mvc.IActionResult representing the start view.
Controller responsible for handling requests related to heat transfer coefficients, providing data based on year or building reference.
public class HeatTransferCoefficientController : Microsoft.AspNetCore.Mvc.ControllerInheritance System.Object → Microsoft.AspNetCore.Mvc.ControllerBase → Microsoft.AspNetCore.Mvc.Controller → HeatTransferCoefficientController
Initializes a new instance of the HeatTransferCoefficientController class.
public HeatTransferCoefficientController(System.Net.Http.IHttpClientFactory httpClientFactory);httpClientFactory System.Net.Http.IHttpClientFactory
The HTTP client factory used to create clients for external API communication.
HeatTransferCoefficientController.GetRegulatedHeatTransferCoefficientsByReferenceAsync(string, Nullable<int>) Method
Retrieves regulated heat transfer coefficients for a building identified by its reference, determining the applicable year based on the building's construction data.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetRegulatedHeatTransferCoefficientsByReferenceAsync(string reference, System.Nullable<int> countyId);reference System.String
The unique reference string of the building.
countyId System.Nullable<System.Int32>
The optional identifier for the county associated with the building.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
An Microsoft.AspNetCore.Mvc.IActionResult containing a partial view with the coefficient data, or an error result if the request fails.
HeatTransferCoefficientController.GetRegulatedHeatTransferCoefficientsByYearAsync(short, CancellationToken) Method
Retrieves regulated heat transfer coefficients for a specific year and returns them via a partial view.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetRegulatedHeatTransferCoefficientsByYearAsync(short year, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));year System.Int16
The calendar year used to filter the regulated heat transfer coefficients.
cancellationToken System.Threading.CancellationToken
A token to monitor for cancellation requests.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
An Microsoft.AspNetCore.Mvc.IActionResult containing a partial view with the coefficient data, or an error result if the request fails.
Provides the controller logic for handling requests to the home page of the GIS WebAPI user interface.
public class HomeController : Microsoft.AspNetCore.Mvc.ControllerInheritance System.Object → Microsoft.AspNetCore.Mvc.ControllerBase → Microsoft.AspNetCore.Mvc.Controller → HomeController
Handles the request for the start page and returns the corresponding view.
public HomeController();Returns the view for the About page.
public Microsoft.AspNetCore.Mvc.IActionResult About();Microsoft.AspNetCore.Mvc.IActionResult
An Microsoft.AspNetCore.Mvc.IActionResult result.
Returns the view for the Start page.
public Microsoft.AspNetCore.Mvc.IActionResult Start();Microsoft.AspNetCore.Mvc.IActionResult
An Microsoft.AspNetCore.Mvc.IActionResult result.
Controller responsible for handling requests related to occupancy data for 2D buildings.
public class OccupancyDataController : Microsoft.AspNetCore.Mvc.ControllerInheritance System.Object → Microsoft.AspNetCore.Mvc.ControllerBase → Microsoft.AspNetCore.Mvc.Controller → OccupancyDataController
Initializes a new instance of the OccupancyDataController class.
public OccupancyDataController(System.Net.Http.IHttpClientFactory httpClientFactory);httpClientFactory System.Net.Http.IHttpClientFactory
The HTTP client factory used to create clients for external API communication.
Retrieves the occupancy data and building reference for a specific 2D building item by its reference identifier.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetBuilding2DItemByIdAsync(string reference, System.Nullable<int> countyId, System.Nullable<bool> isResidential);reference System.String
The unique reference string of the building.
countyId System.Nullable<System.Int32>
The optional ID of the county associated with the building.
isResidential System.Nullable<System.Boolean>
An optional flag indicating whether the building is residential.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation. The task result contains an Microsoft.AspNetCore.Mvc.IActionResult, which returns a partial view containing the occupancy data if successful; otherwise, a bad request or no content response.
Controller providing endpoints for managing and retrieving orthodata and coverage factor information.
public class OrtoDatasController : Microsoft.AspNetCore.Mvc.ControllerInheritance System.Object → Microsoft.AspNetCore.Mvc.ControllerBase → Microsoft.AspNetCore.Mvc.Controller → OrtoDatasController
Initializes a new instance of the OrtoDatasController class.
public OrtoDatasController(System.Net.Http.IHttpClientFactory httpClientFactory);httpClientFactory System.Net.Http.IHttpClientFactory
The HTTP client factory used to create System.Net.Http.HttpClient instances.
Retrieves the estimated coverage factor for a specific administrative area L2D identifier.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetEstimatedCoverageFactorAsync(int administrativeAreal2DId);administrativeAreal2DId System.Int32
The unique identifier of the administrative area L2D.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation. The task result contains an Microsoft.AspNetCore.Mvc.IActionResult with the coverage factor or error status.
Retrieves estimated coverage factors for a collection of administrative area L2D identifiers.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetEstimatedCoverageFactorsAsync(System.Collections.Generic.IEnumerable<int> administrativeAreal2DIds);administrativeAreal2DIds System.Collections.Generic.IEnumerable<System.Int32>
An enumerable collection of administrative area L2D identifiers.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation. The task result contains an Microsoft.AspNetCore.Mvc.IActionResult with the list of coverage factor values or error status.
Retrieves orthodata and building 2D reference information based on a provided reference and optional county ID.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetItemByIdAsync(string reference, System.Nullable<int> countyId);reference System.String
The unique reference string for the item.
countyId System.Nullable<System.Int32>
The optional identifier for the county.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation. The task result contains an Microsoft.AspNetCore.Mvc.IActionResult representing the partial view or error response.
Provides API endpoints for retrieving and managing year built data.
public class YearBuiltDataController : Microsoft.AspNetCore.Mvc.ControllerInheritance System.Object → Microsoft.AspNetCore.Mvc.ControllerBase → Microsoft.AspNetCore.Mvc.Controller → YearBuiltDataController
Initializes a new instance of the YearBuiltDataController class.
public YearBuiltDataController(System.Net.Http.IHttpClientFactory httpClientFactory);httpClientFactory System.Net.Http.IHttpClientFactory
The System.Net.Http.IHttpClientFactory used to create HTTP clients.
Retrieves a year built data item based on the specified reference and optional county identifier.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetItemByReferenceAsync(string reference, System.Nullable<int> countyId);reference System.String
The unique reference of the item to retrieve.
countyId System.Nullable<System.Int32>
The optional identifier of the county associated with the item.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation, containing an Microsoft.AspNetCore.Mvc.IActionResult result.