Repository navigation
DiGi.GIS.PostgreSQL.WebAPI.Classes
Web API controller for administrative area 2D operations, providing endpoints to retrieve, filter, and update administrative area data.
public class AdministrativeAreal2DController : DiGi.WebAPI.Classes.WebAPIControllerInheritance System.Object → Microsoft.AspNetCore.Mvc.ControllerBase → DiGi.WebAPI.Classes.WebAPIController → AdministrativeAreal2DController
AdministrativeAreal2DController(GISPostgreSQLWebAPIConfigurationFileWatcher, AdministrativeAreal2DPostgreSQLConverter) Constructor
public AdministrativeAreal2DController(DiGi.GIS.PostgreSQL.WebAPI.Classes.GISPostgreSQLWebAPIConfigurationFileWatcher gISPostgreSQLWebAPIConfigurationFileWatcher, DiGi.GIS.PostgreSQL.Classes.AdministrativeAreal2DPostgreSQLConverter administrativeAreal2DPostgreSQLConverter);gISPostgreSQLWebAPIConfigurationFileWatcher GISPostgreSQLWebAPIConfigurationFileWatcher
The configuration file watcher for the GIS PostgreSQL Web API.
administrativeAreal2DPostgreSQLConverter DiGi.GIS.PostgreSQL.Classes.AdministrativeAreal2DPostgreSQLConverter
The converter used for administrative area 2D PostgreSQL operations.
AdministrativeAreal2DController.GetAdministrativeAreal2DReferenceByCodeAsync(string, Nullable<AdministrativeArealType>) Method
Gets an administrative area reference by its code and type.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetAdministrativeAreal2DReferenceByCodeAsync(string? code, System.Nullable<DiGi.GIS.PostgreSQL.Enums.AdministrativeArealType> administrativeArealType);code System.String
The unique code of the administrative area.
administrativeArealType System.Nullable<DiGi.GIS.PostgreSQL.Enums.AdministrativeArealType>
The type of the administrative area.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation.
Retrieves an administrative area reference by its identifier.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetAdministrativeAreal2DReferenceByIdAsync(int id);id System.Int32
The unique identifier of the administrative area reference to retrieve.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation.
Retrieves the administrative area reference path by its identifier.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetAdministrativeAreal2DReferencePathByIdAsync(int id);id System.Int32
The unique identifier of the administrative area reference path to retrieve.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation.
AdministrativeAreal2DController.GetAdministrativeAreal2DReferencePathsByNameAsync(string, CancellationToken) Method
Retrieves administrative area reference paths by name.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetAdministrativeAreal2DReferencePathsByNameAsync(string text, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));text System.String
The search text used to find matching administrative area reference paths.
cancellationToken System.Threading.CancellationToken
A cancellation token that can be used by the called method to indicate that the operation should be canceled.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation.
AdministrativeAreal2DController.GetAdministrativeAreal2DReferencePathsByNameParameterAsync(AdministrativeAreal2DReferencePathsByNameParameter, CancellationToken) Method
Retrieves administrative area reference paths by name parameter (where Text is the search term).
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetAdministrativeAreal2DReferencePathsByNameParameterAsync(DiGi.GIS.PostgreSQL.WebAPI.Classes.AdministrativeAreal2DReferencePathsByNameParameter administrativeAreal2DReferencePathsByNameParameter, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));administrativeAreal2DReferencePathsByNameParameter AdministrativeAreal2DReferencePathsByNameParameter
The parameter containing the search term for querying administrative areas by name.
cancellationToken System.Threading.CancellationToken
The cancellation token.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation. List of AdministrativeAreal2DReferencePaths DiGi.GIS.PostgreSQL.Classes.AdministrativeAreal2DReferencePath if valid administrative area references are found.
AdministrativeAreal2DController.GetAdministrativeAreal2DReferencesByAdministrativeArealTypeAsync(AdministrativeArealType, Nullable<int>, Nullable<bool>) Method
Retrieves all administrative area references filtered by administrative area type.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetAdministrativeAreal2DReferencesByAdministrativeArealTypeAsync(DiGi.GIS.PostgreSQL.Enums.AdministrativeArealType administrativeArealType, System.Nullable<int> parentId, System.Nullable<bool> uniqueCode);administrativeArealType DiGi.GIS.PostgreSQL.Enums.AdministrativeArealType
The administrative area type used to filter the references.
parentId System.Nullable<System.Int32>
The optional parent identifier used for filtering.
uniqueCode System.Nullable<System.Boolean>
An optional flag indicating whether to filter by unique code.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation.
AdministrativeAreal2DController.GetAdministrativeAreal2DReferencesByCodeAsync(string, Nullable<AdministrativeArealType>) Method
Retrieves administrative area references by their code.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetAdministrativeAreal2DReferencesByCodeAsync(string code, System.Nullable<DiGi.GIS.PostgreSQL.Enums.AdministrativeArealType> administrativeArealType);code System.String
The unique identifier or code used to retrieve the administrative area references.
administrativeArealType System.Nullable<DiGi.GIS.PostgreSQL.Enums.AdministrativeArealType>
An optional filter specifying the type of administrative area.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation.
Retrieves all available administrative area codes.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetCodesAsync();System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation.
Retrieves the identifier for a given code.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetIdByCodeAsync(string code, System.Nullable<DiGi.GIS.PostgreSQL.Enums.AdministrativeArealType> administrativeArealType);code System.String
The unique code of the administrative area.
administrativeArealType System.Nullable<DiGi.GIS.PostgreSQL.Enums.AdministrativeArealType>
The optional type of the administrative area to filter the search.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation.
Retrieves an administrative area item by its code.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetItemByCodeAsync(string code);code System.String
The unique code of the administrative area to retrieve.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation.
Asynchronously retrieves an administrative area item by its unique identifier.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetItemByIdAsync(int id);id System.Int32
The integer identifier of the administrative area item to retrieve.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation.
AdministrativeAreal2DController.GetItemsByAdministrativeArealTypeAsync(AdministrativeArealType) Method
Retrieves all administrative area items filtered by administrative area type.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetItemsByAdministrativeArealTypeAsync(DiGi.GIS.PostgreSQL.Enums.AdministrativeArealType administrativeArealType);administrativeArealType DiGi.GIS.PostgreSQL.Enums.AdministrativeArealType
The administrative area type used to filter the results.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation.
AdministrativeAreal2DController.GetItemsByBoundingBoxAsync(double, double, double, double, Nullable<double>, Nullable<AdministrativeArealType>) Method
Retrieves administrative area items within a specified bounding box.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetItemsByBoundingBoxAsync(double x_1, double y_1, double x_2, double y_2, System.Nullable<double> tolerance, System.Nullable<DiGi.GIS.PostgreSQL.Enums.AdministrativeArealType> administrativeArealType);x_1 System.Double
The X-coordinate of the first corner of the bounding box.
y_1 System.Double
The Y-coordinate of the first corner of the bounding box.
x_2 System.Double
The X-coordinate of the second corner of the bounding box.
y_2 System.Double
The Y-coordinate of the second corner of the bounding box.
tolerance System.Nullable<System.Double>
An optional tolerance value for the spatial query. If not provided, a default macro distance is used.
administrativeArealType System.Nullable<DiGi.GIS.PostgreSQL.Enums.AdministrativeArealType>
An optional filter to restrict results to a specific type of administrative area.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation.
AdministrativeAreal2DController.GetItemsByCircleAsync(double, double, Nullable<double>, Nullable<double>, Nullable<double>, Nullable<AdministrativeArealType>) Method
Retrieves administrative area items within a specified circle.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetItemsByCircleAsync(double x, double y, System.Nullable<double> radius, System.Nullable<double> diameter, System.Nullable<double> tolerance, System.Nullable<DiGi.GIS.PostgreSQL.Enums.AdministrativeArealType> administrativeArealType);The X-coordinate of the center point of the search circle.
The Y-coordinate of the center point of the search circle.
radius System.Nullable<System.Double>
The radius of the search circle.
diameter System.Nullable<System.Double>
The diameter of the search circle.
tolerance System.Nullable<System.Double>
The tolerance value for the spatial query.
administrativeArealType System.Nullable<DiGi.GIS.PostgreSQL.Enums.AdministrativeArealType>
The type of administrative area to retrieve.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
An Microsoft.AspNetCore.Mvc.IActionResult containing a list of administrative area items if found, or an error response.
AdministrativeAreal2DController.GetItemsByCodeAsync(string, Nullable<AdministrativeArealType>) Method
Retrieves administrative area items filtered by code.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetItemsByCodeAsync(string code, System.Nullable<DiGi.GIS.PostgreSQL.Enums.AdministrativeArealType> administrativeArealType);code System.String
The code used to filter the administrative area items.
administrativeArealType System.Nullable<DiGi.GIS.PostgreSQL.Enums.AdministrativeArealType>
The optional type of administrative area to filter by.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
An Microsoft.AspNetCore.Mvc.IActionResult containing a list of matching administrative area items, or an error response if the code is invalid or no items are found.
Retrieves administrative area items filtered by multiple codes.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetItemsByCodesAsync(System.Collections.Generic.List<string> codes);codes System.Collections.Generic.List<System.String>
The list of codes used to filter the administrative area items.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation.
AdministrativeAreal2DController.GetItemsByPointAsync(double, double, Nullable<double>, Nullable<AdministrativeArealType>) Method
Retrieves administrative area items at or near a specified point.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetItemsByPointAsync(double x, double y, System.Nullable<double> tolerance, System.Nullable<DiGi.GIS.PostgreSQL.Enums.AdministrativeArealType> administrativeArealType);The X-coordinate of the search point.
The Y-coordinate of the search point.
tolerance System.Nullable<System.Double>
The optional tolerance distance to use when searching for items near the specified point. If null, a default macro distance is used.
administrativeArealType System.Nullable<DiGi.GIS.PostgreSQL.Enums.AdministrativeArealType>
The optional type filter for the administrative area items to be retrieved.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation.
Retrieves subcodes for a given code.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetSubCodesAsync(string code);code System.String
The administrative area code used to retrieve the associated subcodes.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation.
Updates a single administrative area item.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> UpdateItemAsync(System.Text.Json.Nodes.JsonObject? jsonObject);jsonObject System.Text.Json.Nodes.JsonObject
The System.Text.Json.Nodes.JsonObject containing the data used to update the administrative area item. This value can be null.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation.
Updates multiple administrative area items.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> UpdateItemsAsync(System.Text.Json.Nodes.JsonArray? jsonArray);jsonArray System.Text.Json.Nodes.JsonArray
The JSON array containing the administrative area items to be updated.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation.
Represents a parameter containing text for querying administrative area reference paths.
public class AdministrativeAreal2DReferencePathsByNameParameter : DiGi.WebAPI.Classes.ParameterInheritance System.Object → DiGi.Core.Classes.Object → DiGi.Core.Classes.SerializableObject → DiGi.WebAPI.Classes.Parameter → AdministrativeAreal2DReferencePathsByNameParameter
Initializes a new instance of the AdministrativeAreal2DReferencePathsByNameParameter class.
public AdministrativeAreal2DReferencePathsByNameParameter();Initializes a new instance of the AdministrativeAreal2DReferencePathsByNameParameter class with the specified text (search phrase).
public AdministrativeAreal2DReferencePathsByNameParameter(string text);text System.String
The text to search for.
Initializes a new instance of the AdministrativeAreal2DReferencePathsByNameParameter class using an System.Text.Json.Nodes.JsonObject object.
public AdministrativeAreal2DReferencePathsByNameParameter(System.Text.Json.Nodes.JsonObject jsonObject);jsonObject System.Text.Json.Nodes.JsonObject
The JSON object containing the parameter values.
Text to search for in the names of the administrative areal 2D reference paths. The search is case-insensitive and matches any path whose name contains the specified text.
public string? Text { get; set; }Provides functionality to asynchronously post a collection of DiGi.GIS.Classes.AdministrativeAreal2D objects to the PostgreSQL database.
public class AdministrativeAreal2DsPostTask : DiGi.GIS.PostgreSQL.WebAPI.Classes.SerializableObjectsPostTask<DiGi.GIS.Classes.AdministrativeAreal2D>Inheritance System.Object → DiGi.Core.Classes.BackgroundTask → DiGi.Core.Classes.CancelableBackgroundTask → DiGi.Core.Classes.ReportableBackgroundTask<System.Int64> → DiGi.GIS.PostgreSQL.WebAPI.Classes.SerializableObjectsPostTask<DiGi.GIS.Classes.AdministrativeAreal2D> → AdministrativeAreal2DsPostTask
Initializes a new instance of the AdministrativeAreal2DsPostTask class.
public AdministrativeAreal2DsPostTask(DiGi.GIS.PostgreSQL.WebAPI.Classes.GISPostgreSQLWebAPIManager gISPostgreSQLWebAPIManager);gISPostgreSQLWebAPIManager GISPostgreSQLWebAPIManager
The GIS PostgreSQL Web API manager used to handle database operations.
Web API controller for building 2D operations, providing endpoints to retrieve, filter, and update building 2D data.
public class Building2DController : DiGi.WebAPI.Classes.WebAPIControllerInheritance System.Object → Microsoft.AspNetCore.Mvc.ControllerBase → DiGi.WebAPI.Classes.WebAPIController → Building2DController
Building2DController(GISPostgreSQLWebAPIConfigurationFileWatcher, Building2DPostgreSQLConverter) Constructor
public Building2DController(DiGi.GIS.PostgreSQL.WebAPI.Classes.GISPostgreSQLWebAPIConfigurationFileWatcher gISPostgreSQLWebAPIConfigurationFileWatcher, DiGi.GIS.PostgreSQL.Classes.Building2DPostgreSQLConverter building2DPostgreSQLConverter);gISPostgreSQLWebAPIConfigurationFileWatcher GISPostgreSQLWebAPIConfigurationFileWatcher
The configuration file watcher for the GIS PostgreSQL Web API.
building2DPostgreSQLConverter DiGi.GIS.PostgreSQL.Classes.Building2DPostgreSQLConverter
The converter used for Building 2D data operations in PostgreSQL.
Asynchronously counts the number of buildings based on the administrative areal 2D identifiers.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> CountAsync(DiGi.GIS.PostgreSQL.WebAPI.Classes.CountByAdministrativeAreal2DIdsParameter countByAdministrativeAreal2DIdsParameter);countByAdministrativeAreal2DIdsParameter CountByAdministrativeAreal2DIdsParameter
The parameter object containing the collection of administrative areal 2D identifiers.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation.
Asynchronously retrieves a building 2D reference by its unique identifier and an optional county identifier.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetBuilding2DReferenceByIdAsync(long id, System.Nullable<int> countyId);id System.Int64
The unique identifier of the building.
countyId System.Nullable<System.Int32>
An optional integer representing the county identifier used to filter the search.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation.
Retrieves a building 2D reference by its unique reference code and an optional county identifier.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetBuilding2DReferenceByReferenceAsync(string reference, System.Nullable<int> countyId);reference System.String
The unique reference string of the building to retrieve.
countyId System.Nullable<System.Int32>
The optional integer identifier of the county used to filter the search.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation.
Retrieves building 2D references filtered by administrative area 2D identifier. Can be used for relatively small number of buildings
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetBuilding2DReferencesByAdministrativeAreal2DIdAsync(int administrativeAreal2DId);administrativeAreal2DId System.Int32
The unique identifier of the administrative area 2D used to filter the building references.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation.
Building2DController.GetBuilding2DReferencesByPagingParameterAsync(Building2DReferencesByPagingParameter) Method
Retrieves a paginated list of building 2D references.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetBuilding2DReferencesByPagingParameterAsync(DiGi.GIS.PostgreSQL.WebAPI.Classes.Building2DReferencesByPagingParameter building2DReferencesByPagingParameter);building2DReferencesByPagingParameter Building2DReferencesByPagingParameter
The parameter containing paging options, including county identifier, cursor, and page size.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task representing the asynchronous operation, returning a list of building 2D references.
Retrieves a building 2D item by its 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 building 2D item to retrieve.
countyId System.Nullable<System.Int32>
The optional county identifier associated with the building.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation.
Retrieves a building 2D item at or near a specified point.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetItemByPointAsync(double x, double y, System.Nullable<double> tolerance);The X coordinate of the search point.
The Y coordinate of the search point.
tolerance System.Nullable<System.Double>
The optional tolerance distance to use when searching for the item near the specified point.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
An Microsoft.AspNetCore.Mvc.IActionResult containing the building 2D item if found, or an error response.
Asynchronously retrieves a building 2D item by its reference code and an 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 string used to locate the building 2D item.
countyId System.Nullable<System.Int32>
The optional identifier of the county associated with the building.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation.
Building2DController.GetItemsByBoundingBoxAsync(double, double, double, double, Nullable<double>) Method
Retrieves building 2D items within a specified bounding box.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetItemsByBoundingBoxAsync(double x_1, double y_1, double x_2, double y_2, System.Nullable<double> tolerance);x_1 System.Double
The X-coordinate of the first corner of the bounding box.
y_1 System.Double
The Y-coordinate of the first corner of the bounding box.
x_2 System.Double
The X-coordinate of the second corner of the bounding box.
y_2 System.Double
The Y-coordinate of the second corner of the bounding box.
tolerance System.Nullable<System.Double>
An optional tolerance value for the spatial query. If not provided or NaN, a default macro distance is used.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation.
Retrieves building 2D items by their references.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetItemsByBuilding2DReferencesAsync(System.Text.Json.Nodes.JsonArray? jsonArray);jsonArray System.Text.Json.Nodes.JsonArray
The JSON array containing the building 2D references to retrieve.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation.
Building2DController.GetItemsByCircleAsync(double, double, Nullable<double>, Nullable<double>, Nullable<double>) Method
Retrieves building 2D items within a specified circle.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetItemsByCircleAsync(double x, double y, System.Nullable<double> radius, System.Nullable<double> diameter, System.Nullable<double> tolerance);The X-coordinate of the center of the circle.
The Y-coordinate of the center of the circle.
radius System.Nullable<System.Double>
The radius of the search circle.
diameter System.Nullable<System.Double>
The diameter of the search circle.
tolerance System.Nullable<System.Double>
The tolerance value to be applied to the search area.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation.
Retrieves Point2D coordinates by their references.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetPoint2DsByReferencesAsync(System.Collections.Generic.IEnumerable<string> references, System.Nullable<int> countyId);references System.Collections.Generic.IEnumerable<System.String>
A collection of reference strings used to identify the Point2D objects.
countyId System.Nullable<System.Int32>
The optional identifier for the county associated with the coordinates.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation.
Retrieves references of the building2Ds filtered by county Id.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetReferencesByCountyIdAsync(int countyId, System.Nullable<int> subdivisionId=null);countyId System.Int32
The unique identifier of the county used to filter the building 2D references.
subdivisionId System.Nullable<System.Int32>
The optional unique identifier of the subdivision used to further filter the building 2D references.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation.
Updates a single building 2D item.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> UpdateItemAsync(System.Text.Json.Nodes.JsonObject? jsonObject, string? code);jsonObject System.Text.Json.Nodes.JsonObject
The System.Text.Json.Nodes.JsonObject containing the data to update the building 2D item. This value can be null.
code System.String
The code identifying the specific building 2D item to be updated. This value can be null.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation.
Updates multiple building 2D items.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> UpdateItemsAsync(System.Text.Json.Nodes.JsonArray? jsonArray, string? code);jsonArray System.Text.Json.Nodes.JsonArray
The JSON array containing the building 2D items to be updated.
code System.String
An optional code used for the update operation.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation.
Parameter class containing options for keyset-paginated building 2D reference queries.
public class Building2DReferencesByPagingParameter : DiGi.WebAPI.Classes.ParameterInheritance System.Object → DiGi.Core.Classes.Object → DiGi.Core.Classes.SerializableObject → DiGi.WebAPI.Classes.Parameter → Building2DReferencesByPagingParameter
Initializes a new instance of the Building2DReferencesByPagingParameter class.
public Building2DReferencesByPagingParameter();Initializes a new instance of the Building2DReferencesByPagingParameter class by copying properties from another instance.
public Building2DReferencesByPagingParameter(DiGi.GIS.PostgreSQL.WebAPI.Classes.Building2DReferencesByPagingParameter building2DReferencesByPagingParameter);building2DReferencesByPagingParameter Building2DReferencesByPagingParameter
The parameter instance to copy properties from.
Initializes a new instance of the Building2DReferencesByPagingParameter class using a System.Text.Json.Nodes.JsonObject object.
public Building2DReferencesByPagingParameter(System.Text.Json.Nodes.JsonObject jsonObject);jsonObject System.Text.Json.Nodes.JsonObject
The JSON object containing data used to initialize the parameter.
Gets or sets the target partition identifier (County ID).
public int CountyId { get; set; }10365
Gets or sets the pagination cursor tracking the last processed building reference.
public string? Cursor { get; set; }BLDG-12345
Gets or sets the maximum count of references per page. Defaults to 250.
public int PageSize { get; set; }100
Gets or sets the target subdivision identifier (Subdivision ID).
public int SubdivisionId { get; set; }1035
Provides functionality to handle the asynchronous posting of multiple DiGi.GIS.Classes.Building2D objects to the GIS PostgreSQL database.
public class Building2DsPostTask : DiGi.GIS.PostgreSQL.WebAPI.Classes.SerializableObjectsPostTask<DiGi.GIS.Classes.Building2D>Inheritance System.Object → DiGi.Core.Classes.BackgroundTask → DiGi.Core.Classes.CancelableBackgroundTask → DiGi.Core.Classes.ReportableBackgroundTask<System.Int64> → DiGi.GIS.PostgreSQL.WebAPI.Classes.SerializableObjectsPostTask<DiGi.GIS.Classes.Building2D> → Building2DsPostTask
Initializes a new instance of the Building2DsPostTask class.
public Building2DsPostTask(DiGi.GIS.PostgreSQL.WebAPI.Classes.GISPostgreSQLWebAPIManager gISPostgreSQLWebAPIManager);gISPostgreSQLWebAPIManager GISPostgreSQLWebAPIManager
The GISPostgreSQLWebAPIManager used to manage PostgreSQL GIS operations.
Gets or sets the code associated with the building 2D post task.
public string? Code { get; set; }Parameter class containing options for building data queries using dynamic hierarchical filters.
public class BuildingDataByFilterGroupParameter : DiGi.WebAPI.Classes.ParameterInheritance System.Object → DiGi.Core.Classes.Object → DiGi.Core.Classes.SerializableObject → DiGi.WebAPI.Classes.Parameter → BuildingDataByFilterGroupParameter
Initializes a new instance of the BuildingDataByFilterGroupParameter class.
public BuildingDataByFilterGroupParameter();Initializes a new instance of the BuildingDataByFilterGroupParameter class using an System.Text.Json.Nodes.JsonObject object.
public BuildingDataByFilterGroupParameter(System.Text.Json.Nodes.JsonObject jsonObject);jsonObject System.Text.Json.Nodes.JsonObject
The JSON object containing data used to initialize the parameter.
Gets or sets the optional list of column unique identifiers to project in the result.
public System.Collections.Generic.List<string>? ColumnUniqueIds { get; set; }System.Collections.Generic.List<System.String>
Gets or sets the dynamic hierarchical filter group to apply to the database query.
public DiGi.PostgreSQL.Table.Classes.FilterGroup FilterGroup { get; set; }DiGi.PostgreSQL.Table.Classes.FilterGroup
Parameter class containing options for keyset-paginated building queries.
public class BuildingDataByPagingParameter : DiGi.WebAPI.Classes.ParameterInheritance System.Object → DiGi.Core.Classes.Object → DiGi.Core.Classes.SerializableObject → DiGi.WebAPI.Classes.Parameter → BuildingDataByPagingParameter
Initializes a new instance of the BuildingDataByPagingParameter class.
public BuildingDataByPagingParameter();Initializes a new instance of the BuildingDataByPagingParameter class using an System.Text.Json.Nodes.JsonObject object.
public BuildingDataByPagingParameter(System.Text.Json.Nodes.JsonObject jsonObject);jsonObject System.Text.Json.Nodes.JsonObject
The JSON object containing data used to initialize the parameter.
Gets or sets the list of column unique identifiers to project in the result.
public System.Collections.Generic.List<string>? ColumnUniqueIds { get; set; }System.Collections.Generic.List<System.String>
["building_id", "address"]
Gets or sets the target partition identifier (County ID).
public int CountyId { get; set; }10365
Gets or sets the pagination cursor tracking the last processed building reference.
public string? Cursor { get; set; }eyJpZCI6MTIzfQ==
Gets or sets the maximum count of rows per page. Defaults to 250.
public int PageSize { get; set; }100
Represents a parameter containing references for querying building data.
public class BuildingDataByReferencesParameter : DiGi.WebAPI.Classes.ParameterInheritance System.Object → DiGi.Core.Classes.Object → DiGi.Core.Classes.SerializableObject → DiGi.WebAPI.Classes.Parameter → BuildingDataByReferencesParameter
Initializes a new instance of the BuildingDataByReferencesParameter class.
public BuildingDataByReferencesParameter();Initializes a new instance of the BuildingDataByReferencesParameter class using an existing BuildingDataByReferencesParameter object.
public BuildingDataByReferencesParameter(DiGi.GIS.PostgreSQL.WebAPI.Classes.BuildingDataByReferencesParameter buildingDataByReferencesParameter);buildingDataByReferencesParameter BuildingDataByReferencesParameter
The parameter object to copy data from.
Initializes a new instance of the BuildingDataByReferencesParameter class using a JSON object.
public BuildingDataByReferencesParameter(System.Text.Json.Nodes.JsonObject jsonObject);jsonObject System.Text.Json.Nodes.JsonObject
The JSON object containing parameter data.
Gets or sets the unique identifiers of the columns (Column.UniqueId). All columns will be returned if the collection is null or empty. Required if performance is a concern and the column unique identifiers are available; otherwise, the column unique identifiers will be determined by the building data PostgreSQL converter.
public System.Collections.Generic.IEnumerable<string> ColumnUniqueIds { get; set; }System.Collections.Generic.IEnumerable<System.String>
Gets or sets the county identifier. Required if performance is a concern and the county identifier is available; otherwise, the county identifier will be determined by the building data PostgreSQL converter.
public System.Nullable<int> CountyId { get; set; }Gets or sets the references for the building data parameter.
public System.Collections.Generic.IEnumerable<string> References { get; set; }System.Collections.Generic.IEnumerable<System.String>
Represents a parameter containing subdivision ids for querying building data.
public class BuildingDataBySubdivisionIdsParameter : DiGi.WebAPI.Classes.ParameterInheritance System.Object → DiGi.Core.Classes.Object → DiGi.Core.Classes.SerializableObject → DiGi.WebAPI.Classes.Parameter → BuildingDataBySubdivisionIdsParameter
Initializes a new instance of the BuildingDataBySubdivisionIdsParameter class.
public BuildingDataBySubdivisionIdsParameter();Initializes a new instance of the BuildingDataBySubdivisionIdsParameter class using an existing BuildingDataBySubdivisionIdsParameter object.
public BuildingDataBySubdivisionIdsParameter(DiGi.GIS.PostgreSQL.WebAPI.Classes.BuildingDataBySubdivisionIdsParameter buildingDataBySubdivisionIdsParameter);buildingDataBySubdivisionIdsParameter BuildingDataBySubdivisionIdsParameter
The parameter object to copy data from.
Initializes a new instance of the BuildingDataBySubdivisionIdsParameter class using a JSON object.
public BuildingDataBySubdivisionIdsParameter(System.Text.Json.Nodes.JsonObject jsonObject);jsonObject System.Text.Json.Nodes.JsonObject
The JSON object containing parameter data.
Gets or sets the unique identifiers of the columns (Column.UniqueId). All columns will be returned if the collection is null or empty. Required if performance is a concern and the column unique identifiers are available; otherwise, the column unique identifiers will be determined by the building data PostgreSQL converter.
public System.Collections.Generic.IEnumerable<string> ColumnUniqueIds { get; set; }System.Collections.Generic.IEnumerable<System.String>
Gets or sets the subdivision ids for the building data
public System.Collections.Generic.IEnumerable<int> SubdivisionIds { get; set; }System.Collections.Generic.IEnumerable<System.Int32>
Controller responsible for handling API requests related to building data retrieved from a PostgreSQL database.
public class BuildingDataController : DiGi.WebAPI.Classes.WebAPIControllerInheritance System.Object → Microsoft.AspNetCore.Mvc.ControllerBase → DiGi.WebAPI.Classes.WebAPIController → BuildingDataController
Initializes a new instance of the BuildingDataController class.
public BuildingDataController(DiGi.GIS.PostgreSQL.Classes.BuildingDataPostgreSQLConverter buildingDataPostgreSQLConverter);buildingDataPostgreSQLConverter DiGi.GIS.PostgreSQL.Classes.BuildingDataPostgreSQLConverter
The DiGi.GIS.PostgreSQL.Classes.BuildingDataPostgreSQLConverter used to handle building data operations and database conversions.
Asynchronously retrieves all available building data column categories.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetCategoriesAsync();System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation.
Asynchronously retrieves all column references, optionally filtered by the specified categories.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetColumnReferencesAsync(System.Collections.Generic.List<string>? categories=null);categories System.Collections.Generic.List<System.String>
An optional list of category names to filter the column references by.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task representing the asynchronous operation, returning a list of column references.
Asynchronously retrieves all available column definitions for building data.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetColumnsAsync();System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation.
Asynchronously retrieves all columns filtered by the specified categories.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetColumnsByCategoriesAsync(System.Collections.Generic.List<string>? categories=null);categories System.Collections.Generic.List<System.String>
An optional list of category names to filter the columns by. If null, the filtering behavior is determined by the underlying data source.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation.
Retrieves all columns with given categories by columns by categories parameter (which contains categories).
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetColumnsByCategoriesParameterAsync(DiGi.GIS.PostgreSQL.WebAPI.Classes.ColumnsByCategoriesParameter columnsByCategoriesParameter);columnsByCategoriesParameter ColumnsByCategoriesParameter
The parameter containing the categories for querying columns.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
Column DiGi.PostgreSQL.Table.Classes.Column
Retrieves the unique identifiers for columns, optionally filtered by the specified categories.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetColumnUniqueIdsAsync(System.Collections.Generic.List<string>? categories=null);categories System.Collections.Generic.List<System.String>
An optional list of category names used to filter the column references.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation.
Generates a value range distribution histogram for a specific building data column inside a county partition, applying optional dynamic filters.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetHistogramSummaryAsync(DiGi.GIS.PostgreSQL.WebAPI.Classes.HistogramRequestParameter histogramRequestParameter);histogramRequestParameter HistogramRequestParameter
The parameter containing the target column, county identifier, desired bucket count, and optional dynamic filters.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task representing the asynchronous operation, returning the histogram bucket list as a JSON array.
BuildingDataController.GetMultivalueAggregateSummaryAsync(MultivalueAggregateRequestParameter) Method
Computes multi-value statistical summaries (SplitDistinctCount, SplitValueDistribution) on a partition column.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetMultivalueAggregateSummaryAsync(DiGi.GIS.PostgreSQL.WebAPI.Classes.MultivalueAggregateRequestParameter multivalueAggregateRequestParameter);multivalueAggregateRequestParameter MultivalueAggregateRequestParameter
The parameter containing target column, multi-value aggregate function, county identifier, and optional separator.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task representing the asynchronous operation, returning the aggregate result as a JSON node.
BuildingDataController.GetSinglevalueAggregateSummaryAsync(SinglevalueAggregateRequestParameter) Method
Computes single-value statistical summaries (Avg, Sum, Min, Max, Count, DistinctCount) on a partition column.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetSinglevalueAggregateSummaryAsync(DiGi.GIS.PostgreSQL.WebAPI.Classes.SinglevalueAggregateRequestParameter singlevalueAggregateRequestParameter);singlevalueAggregateRequestParameter SinglevalueAggregateRequestParameter
The parameter containing target column, single-value aggregate function, and county identifier.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task representing the asynchronous operation, returning the aggregate result as a JSON node.
BuildingDataController.GetTableByBuildingDataByPagingParameterAsync(BuildingDataByPagingParameter) Method
Retrieves a building data table using keyset-based paginated cursor streaming.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetTableByBuildingDataByPagingParameterAsync(DiGi.GIS.PostgreSQL.WebAPI.Classes.BuildingDataByPagingParameter buildingDataByPagingParameter);buildingDataByPagingParameter BuildingDataByPagingParameter
The parameter containing paging options, including column projections, county identifier, cursor, and page size.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task representing the asynchronous operation, returning the populated table.
BuildingDataController.GetTableByBuildingDataByReferencesParameterAsync(BuildingDataByReferencesParameter) Method
Retrieves a building data table by building data by references parameter (column unique ids, county id and references).
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetTableByBuildingDataByReferencesParameterAsync(DiGi.GIS.PostgreSQL.WebAPI.Classes.BuildingDataByReferencesParameter buildingDataByReferencesParameter);buildingDataByReferencesParameter BuildingDataByReferencesParameter
The parameter containing references for querying building data, including column unique identifiers, county identifier, and specific references.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
An Microsoft.AspNetCore.Mvc.IActionResult representing the result of the operation, typically containing a DiGi.PostgreSQL.Table.Classes.Table if found.
BuildingDataController.GetTableByBuildingDataBySubdivisionIdsParameterAsync(BuildingDataBySubdivisionIdsParameter) Method
Retrieves a building data table by building data by subdivision ids parameter (column unique ids, subdivision ids).
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetTableByBuildingDataBySubdivisionIdsParameterAsync(DiGi.GIS.PostgreSQL.WebAPI.Classes.BuildingDataBySubdivisionIdsParameter buildingDataBySubdivisionIdsParameter);buildingDataBySubdivisionIdsParameter BuildingDataBySubdivisionIdsParameter
The parameter containing the subdivision IDs and optional column unique identifiers for querying building data.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation.
Retrieves a building data table filtered by the specified dynamic hierarchical filters.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetTableByFilterGroupAsync(DiGi.GIS.PostgreSQL.WebAPI.Classes.BuildingDataByFilterGroupParameter buildingDataByFilterGroupParameter);buildingDataByFilterGroupParameter BuildingDataByFilterGroupParameter
The parameter containing the dynamic filter group and optional column unique identifiers.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task representing the asynchronous operation, returning the populated filtered table.
Retrieves a building data table for one specific building.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetTableByReferenceAsync(string reference, System.Nullable<int> countyId=null);reference System.String
Building reference
countyId System.Nullable<System.Int32>
The unique identifier of the county for which building belongs to.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task representing the asynchronous operation, returning the populated filtered table with data for sigle building.
Retrieves unique values for a specified column unique identifier and an optional county identifier.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetUniqueValuesAsync(string columnUniqueId, System.Nullable<int> countyId=null);columnUniqueId System.String
The unique identifier of the column from which to retrieve unique values.
countyId System.Nullable<System.Int32>
The optional integer identifier of the county used to filter the results.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation.
BuildingDataController.GetUniqueValuesByColumnUniqueIdParameterAsync(UniqueValuesByColumnUniqueIdParameter) Method
Retrieves unique values for a given UniqueValuesByColumnUniqueIdParameter (column unique id and optionally county id), applying optional dynamic filters.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetUniqueValuesByColumnUniqueIdParameterAsync(DiGi.GIS.PostgreSQL.WebAPI.Classes.UniqueValuesByColumnUniqueIdParameter uniqueValuesByColumnUniqueIdParameter);uniqueValuesByColumnUniqueIdParameter UniqueValuesByColumnUniqueIdParameter
The parameter containing the column unique identifier, optional county identifier, and optional dynamic filters.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
An Microsoft.AspNetCore.Mvc.IActionResult representing the result of the operation, typically a list of unique values or a not found status.
Represents a parameter containing categories for querying columns.
public class ColumnsByCategoriesParameter : DiGi.WebAPI.Classes.ParameterInheritance System.Object → DiGi.Core.Classes.Object → DiGi.Core.Classes.SerializableObject → DiGi.WebAPI.Classes.Parameter → ColumnsByCategoriesParameter
Initializes a new instance of the ColumnsByCategoriesParameter class.
public ColumnsByCategoriesParameter();Initializes a new instance of the ColumnsByCategoriesParameter class with the specified categories.
public ColumnsByCategoriesParameter(System.Collections.Generic.IEnumerable<string> categories);categories System.Collections.Generic.IEnumerable<System.String>
The collection of categories for querying columns.
Initializes a new instance of the ColumnsByCategoriesParameter class using an System.Text.Json.Nodes.JsonObject object.
public ColumnsByCategoriesParameter(System.Text.Json.Nodes.JsonObject jsonObject);jsonObject System.Text.Json.Nodes.JsonObject
The System.Text.Json.Nodes.JsonObject containing the data used to initialize the parameter.
Gets or sets the categories for querying columns. All columns will be returned if the collection is null or empty.
public System.Collections.Generic.IEnumerable<string> Categories { get; set; }System.Collections.Generic.IEnumerable<System.String>
Represents a parameter object used to perform counting operations based on a collection of administrative areal 2D identifiers.
public class CountByAdministrativeAreal2DIdsParameter : DiGi.WebAPI.Classes.ParameterInheritance System.Object → DiGi.Core.Classes.Object → DiGi.Core.Classes.SerializableObject → DiGi.WebAPI.Classes.Parameter → CountByAdministrativeAreal2DIdsParameter
Initializes a new instance of the CountByAdministrativeAreal2DIdsParameter class.
public CountByAdministrativeAreal2DIdsParameter();Initializes a new instance of the CountByAdministrativeAreal2DIdsParameter class by copying the values from an existing instance.
public CountByAdministrativeAreal2DIdsParameter(DiGi.GIS.PostgreSQL.WebAPI.Classes.CountByAdministrativeAreal2DIdsParameter countByAdministrativeAreal2DIdsParameter);countByAdministrativeAreal2DIdsParameter CountByAdministrativeAreal2DIdsParameter
The source instance from which to copy the administrative areal 2D identifiers.
Initializes a new instance of the CountByAdministrativeAreal2DIdsParameter class using the provided JSON object.
public CountByAdministrativeAreal2DIdsParameter(System.Text.Json.Nodes.JsonObject jsonObject);jsonObject System.Text.Json.Nodes.JsonObject
The System.Text.Json.Nodes.JsonObject containing the data used to initialize the parameter.
Gets or sets the collection of administrative areal 2D identifiers used for counting operations.
public System.Collections.Generic.IEnumerable<int> AdministrativeAreal2DIds { get; set; }System.Collections.Generic.IEnumerable<System.Int32>
Controller responsible for handling API requests related to EPW files retrieved from or updated in a PostgreSQL database.
public class EPWFileController : DiGi.WebAPI.Classes.WebAPIControllerInheritance System.Object → Microsoft.AspNetCore.Mvc.ControllerBase → DiGi.WebAPI.Classes.WebAPIController → EPWFileController
EPWFileController(GISPostgreSQLWebAPIConfigurationFileWatcher, EPWFilePostgreSQLConverter) Constructor
Initializes a new instance of the EPWFileController class.
public EPWFileController(DiGi.GIS.PostgreSQL.WebAPI.Classes.GISPostgreSQLWebAPIConfigurationFileWatcher gISPostgreSQLWebAPIConfigurationFileWatcher, DiGi.GIS.PostgreSQL.Classes.EPWFilePostgreSQLConverter ePWFilePostgreSQLConverter);gISPostgreSQLWebAPIConfigurationFileWatcher GISPostgreSQLWebAPIConfigurationFileWatcher
The configuration file watcher used to monitor changes to the GIS PostgreSQL Web API settings.
ePWFilePostgreSQLConverter DiGi.GIS.PostgreSQL.Classes.EPWFilePostgreSQLConverter
The converter used for handling EPW file operations within the PostgreSQL database.
Asynchronously retrieves the closest EPWFile to the given coordinate (x, y).
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetEPWFileAsync(double x, double y, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));The X coordinate (longitude).
The Y coordinate (latitude).
cancellationToken System.Threading.CancellationToken
A cancellation token that can be used by the caller to cancel the asynchronous operation.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation.
Asynchronously updates or inserts a collection of EPW files.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> UpdateItemsAsync(System.Text.Json.Nodes.JsonArray? jsonArray, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));jsonArray System.Text.Json.Nodes.JsonArray
The JSON array containing the EPW files to update or insert.
cancellationToken System.Threading.CancellationToken
A cancellation token that can be used by the caller to cancel the asynchronous operation.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation.
Provides functionality to handle the asynchronous posting of multiple DiGi.EPW.Classes.EPWFile objects to the GIS PostgreSQL database.
public class EPWFilesPostTask : DiGi.GIS.PostgreSQL.WebAPI.Classes.SerializableObjectsPostTask<DiGi.EPW.Classes.EPWFile>Inheritance System.Object → DiGi.Core.Classes.BackgroundTask → DiGi.Core.Classes.CancelableBackgroundTask → DiGi.Core.Classes.ReportableBackgroundTask<System.Int64> → DiGi.GIS.PostgreSQL.WebAPI.Classes.SerializableObjectsPostTask<DiGi.EPW.Classes.EPWFile> → EPWFilesPostTask
Initializes a new instance of the EPWFilesPostTask class.
public EPWFilesPostTask(DiGi.GIS.PostgreSQL.WebAPI.Classes.GISPostgreSQLWebAPIManager gISPostgreSQLWebAPIManager);gISPostgreSQLWebAPIManager GISPostgreSQLWebAPIManager
The GISPostgreSQLWebAPIManager used to manage PostgreSQL GIS operations.
Asynchronously executes the posting of EPW files.
protected System.Threading.Tasks.Task<bool> ExecuteAsync(System.Collections.Generic.IEnumerable<DiGi.EPW.Classes.EPWFile>? ePWFiles, DiGi.Core.Classes.LongProgressWrapper? longProgressWrapper, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));ePWFiles System.Collections.Generic.IEnumerable<DiGi.EPW.Classes.EPWFile>
The collection of EPW files to post.
longProgressWrapper DiGi.Core.Classes.LongProgressWrapper
The progress wrapper to track the number of posted files.
cancellationToken System.Threading.CancellationToken
The cancellation token to cancel the operation.
System.Threading.Tasks.Task<System.Boolean>
A task that represents the asynchronous operation, returning true if the post succeeded; otherwise, false.
Asynchronously executes the background task, reporting progress.
protected override System.Threading.Tasks.Task<bool> ExecuteAsync(System.IProgress<long> progress, System.Threading.CancellationToken cancellationToken);progress System.IProgress<System.Int64>
The progress reporter for reporting progress updates.
cancellationToken System.Threading.CancellationToken
The cancellation token to cancel the operation.
System.Threading.Tasks.Task<System.Boolean>
A task that represents the asynchronous operation, returning true if the operation succeeded; otherwise, false.
Provides functionality to watch and retrieve configuration settings for the GIS PostgreSQL Web API from a specified configuration file.
public class GISPostgreSQLWebAPIConfigurationFileWatcher : DiGi.Core.IO.FileWatcher.Classes.ConfigurationFileWatcherInheritance System.Object → DiGi.Core.IO.FileWatcher.Classes.FileWatcher → DiGi.Core.IO.FileWatcher.Classes.ConfigurationFileWatcher → GISPostgreSQLWebAPIConfigurationFileWatcher
Initializes a new instance of the GISPostgreSQLWebAPIConfigurationFileWatcher class.
public GISPostgreSQLWebAPIConfigurationFileWatcher(string path, double interval=5000.0);path System.String
The path to the configuration file to be watched.
interval System.Double
The time interval in milliseconds between checks for changes to the configuration file.
Gets a value indicating whether updates to administrative areal 2D data are permitted according to the configuration file.
public bool AllowUpdateAdministrativeAreal2D { get; }Gets a value indicating whether updates to 2D buildings are permitted based on the configuration file settings.
public bool AllowUpdateBuilding2D { get; }Gets a value indicating whether updating EPW file data is enabled in the configuration.
public bool AllowUpdateEPWFile { get; }Gets a value indicating whether updates to orthophoto data are permitted according to the configuration file.
public bool AllowUpdateOrtoDatas { get; }Gets a value indicating whether updating year built data is enabled in the configuration.
public bool AllowUpdateYearBuiltData { get; }Manages the creation and lifecycle of System.Net.Http.HttpClient instances used to interact with the GIS PostgreSQL Web API.
public class GISPostgreSQLWebAPIManagerInheritance System.Object → GISPostgreSQLWebAPIManager
Initializes a new instance of the GISPostgreSQLWebAPIManager class.
public GISPostgreSQLWebAPIManager(System.Net.Http.IHttpClientFactory? httpClientFactory);httpClientFactory System.Net.Http.IHttpClientFactory
The HTTP client factory used to create and manage System.Net.Http.HttpClient instances.
Creates an HttpClient instance with the specified name.
public System.Net.Http.HttpClient? CreateHttpClient(string name);name System.String
The unique identifier or name of the HTTP client to be created.
System.Net.Http.HttpClient
A task that represents the asynchronous operation.
Creates an System.Net.Http.HttpClient instance configured for the Web API, resolving the route associated with the specified controller type.
public System.Net.Http.HttpClient? CreateHttpClient<TControllerBase>(out string? route)
where TControllerBase : Microsoft.AspNetCore.Mvc.ControllerBase;TControllerBase
The TControllerBase type parameter.
route System.String
The route.
System.Net.Http.HttpClient
A task that represents the asynchronous operation.
Creates an System.Net.Http.HttpClient instance configured for the specified controller's method and retrieves the corresponding API path.
public System.Net.Http.HttpClient? CreateHttpClient<TControllerBase>(string methodName, out string? path)
where TControllerBase : Microsoft.AspNetCore.Mvc.ControllerBase;TControllerBase
The type of the base controller used to resolve the endpoint path.
methodName System.String
The name of the method within the controller to resolve.
path System.String
The path.
System.Net.Http.HttpClient
A task that represents the asynchronous operation.
Controller responsible for handling API requests related to heat transfer coefficients, providing access to regulated heat transfer coefficient data.
public class HeatTransferCoefficientController : DiGi.WebAPI.Classes.WebAPIControllerInheritance System.Object → Microsoft.AspNetCore.Mvc.ControllerBase → DiGi.WebAPI.Classes.WebAPIController → HeatTransferCoefficientController
Initializes a new instance of the HeatTransferCoefficientController class.
public HeatTransferCoefficientController();HeatTransferCoefficientController.GetRegulatedHeatTransferCoefficientsByYearAsync(short, CancellationToken) Method
Retrieves the regulated heat transfer coefficients for a specified year.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetRegulatedHeatTransferCoefficientsByYearAsync(short year, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));year System.Int16
The year used to filter the regulated heat transfer coefficients.
cancellationToken System.Threading.CancellationToken
A cancellation token that can be used by the caller to cancel the asynchronous operation.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
An Microsoft.AspNetCore.Mvc.IActionResult representing the result of the request, containing the retrieved coefficients or an error status.
Parameter class containing options for generating histograms.
public class HistogramRequestParameter : DiGi.WebAPI.Classes.ParameterInheritance System.Object → DiGi.Core.Classes.Object → DiGi.Core.Classes.SerializableObject → DiGi.WebAPI.Classes.Parameter → HistogramRequestParameter
Initializes a new instance of the HistogramRequestParameter class.
public HistogramRequestParameter();Initializes a new instance of the HistogramRequestParameter class using an System.Text.Json.Nodes.JsonObject object.
public HistogramRequestParameter(System.Text.Json.Nodes.JsonObject jsonObject);jsonObject System.Text.Json.Nodes.JsonObject
The JSON object containing data used to initialize the parameter.
Gets or sets the total number of histogram buckets. Defaults to 10.
public int BucketCount { get; set; }20
Gets or sets the column unique identifier to calculate value distributions for.
public string ColumnUniqueId { get; set; }"column_unique_id_123"
Gets or sets the target partition identifier (County ID).
public int CountyId { get; set; }10365
Gets or sets the optional dynamic hierarchical filters to apply prior to generating the histogram.
public DiGi.PostgreSQL.Table.Classes.FilterGroup? FilterGroup { get; set; }DiGi.PostgreSQL.Table.Classes.FilterGroup
Parameter class containing options for multi-value database aggregation queries.
public class MultivalueAggregateRequestParameter : DiGi.WebAPI.Classes.ParameterInheritance System.Object → DiGi.Core.Classes.Object → DiGi.Core.Classes.SerializableObject → DiGi.WebAPI.Classes.Parameter → MultivalueAggregateRequestParameter
Initializes a new instance of the MultivalueAggregateRequestParameter class.
public MultivalueAggregateRequestParameter();Initializes a new instance of the MultivalueAggregateRequestParameter class using a System.Text.Json.Nodes.JsonObject object.
public MultivalueAggregateRequestParameter(System.Text.Json.Nodes.JsonObject jsonObject);jsonObject System.Text.Json.Nodes.JsonObject
The JSON object containing data used to initialize the parameter.
Gets or sets the column unique identifier to calculate statistics for.
public string ColumnUniqueId { get; set; }"col_unique_id_123"
Gets or sets the target partition identifier (County ID).
public int CountyId { get; set; }10365
Gets or sets the optional dynamic hierarchical filters to apply prior to aggregation.
public DiGi.PostgreSQL.Table.Classes.FilterGroup? FilterGroup { get; set; }DiGi.PostgreSQL.Table.Classes.FilterGroup
Gets or sets the multi-value aggregation function to perform.
public DiGi.PostgreSQL.Table.Enums.MultivalueAggregateFunction MultivalueAggregateFunction { get; set; }DiGi.PostgreSQL.Table.Enums.MultivalueAggregateFunction
SplitDistinctCount
Gets or sets the optional string separator; defaults to null triggering dynamic auto-detection.
public string? Separator { get; set; }","
Controller responsible for handling requests related to occupancy data within the GIS PostgreSQL Web API.
public class OccupancyDataController : DiGi.WebAPI.Classes.WebAPIControllerInheritance System.Object → Microsoft.AspNetCore.Mvc.ControllerBase → DiGi.WebAPI.Classes.WebAPIController → OccupancyDataController
OccupancyDataController(GISPostgreSQLWebAPIConfigurationFileWatcher, Building2DOccupancyDataPostgreSQLConverter, AdministrativeAreal2DOccupancyDataPostgreSQLConverter, AdministrativeAreal2DPostgreSQLConverter) Constructor
Initializes a new instance of the OccupancyDataController class.
public OccupancyDataController(DiGi.GIS.PostgreSQL.WebAPI.Classes.GISPostgreSQLWebAPIConfigurationFileWatcher gISPostgreSQLWebAPIConfigurationFileWatcher, DiGi.GIS.PostgreSQL.Classes.Building2DOccupancyDataPostgreSQLConverter building2DOccupancyDataPostgreSQLConverter, DiGi.GIS.PostgreSQL.Classes.AdministrativeAreal2DOccupancyDataPostgreSQLConverter administrativeAreal2DOccupancyDataPostgreSQLConverter, DiGi.GIS.PostgreSQL.Classes.AdministrativeAreal2DPostgreSQLConverter administrativeAreal2DPostgreSQLConverter);gISPostgreSQLWebAPIConfigurationFileWatcher GISPostgreSQLWebAPIConfigurationFileWatcher
The configuration file watcher used to monitor settings for the GIS PostgreSQL Web API.
building2DOccupancyDataPostgreSQLConverter DiGi.GIS.PostgreSQL.Classes.Building2DOccupancyDataPostgreSQLConverter
The converter used for building 2D occupancy data operations in the PostgreSQL database.
administrativeAreal2DOccupancyDataPostgreSQLConverter DiGi.GIS.PostgreSQL.Classes.AdministrativeAreal2DOccupancyDataPostgreSQLConverter
The converter used for administrative areal 2D occupancy data operations in the PostgreSQL database.
administrativeAreal2DPostgreSQLConverter DiGi.GIS.PostgreSQL.Classes.AdministrativeAreal2DPostgreSQLConverter
The converter used for administrative areal 2D data operations in the PostgreSQL database.
Asynchronously updates occupancy data items for administrative areal 2D entities.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> AdministrativeAreal2DUpdateItemsAsync(System.Text.Json.Nodes.JsonArray? jsonArray);jsonArray System.Text.Json.Nodes.JsonArray
The System.Text.Json.Nodes.JsonArray containing the occupancy data items to be updated.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
An Microsoft.AspNetCore.Mvc.IActionResult representing the result of the update operation, returning a bad request if updates are disabled or no content if the input array is null or empty.
Asynchronously updates building 2D items based on the provided JSON data and identification code.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> Building2DUpdateItemsAsync(System.Text.Json.Nodes.JsonArray? jsonArray, string code);jsonArray System.Text.Json.Nodes.JsonArray
The System.Text.Json.Nodes.JsonArray containing the item data to be updated.
code System.String
The identification code used to validate or categorize the update request.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation.
OccupancyDataController.GetAdministrativeAreal2DItemsByReferenceAsync(string, CancellationToken) Method
Retrieves administrative areal 2D items based on the provided reference identifier.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetAdministrativeAreal2DItemsByReferenceAsync(string reference, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));reference System.String
The unique reference string used to identify the administrative areal 2D items.
cancellationToken System.Threading.CancellationToken
A cancellation token that can be used by the caller to cancel the asynchronous operation.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
An Microsoft.AspNetCore.Mvc.IActionResult representing the result of the operation, containing the requested items or an error response.
OccupancyDataController.GetBuilding2DItemsByReferenceAsync(string, Nullable<int>, CancellationToken) Method
Retrieves Building 2D occupancy data items based on a specified reference and an optional county identifier.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetBuilding2DItemsByReferenceAsync(string reference, System.Nullable<int> countyId, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));reference System.String
The unique reference string used to identify the building 2D items.
countyId System.Nullable<System.Int32>
The optional identifier of the county associated with the building data.
cancellationToken System.Threading.CancellationToken
A cancellation token that can be used by the caller to cancel the asynchronous operation.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
An Microsoft.AspNetCore.Mvc.IActionResult containing the requested building 2D items, or a Microsoft.AspNetCore.Mvc.BadRequestResult if the reference is null or whitespace.
Represents a task for posting occupancy data to the GIS PostgreSQL Web API.
public class OccupancyDatasPostTask : DiGi.GIS.PostgreSQL.WebAPI.Classes.SerializableObjectsPostTask<DiGi.GIS.Classes.OccupancyData>Inheritance System.Object → DiGi.Core.Classes.BackgroundTask → DiGi.Core.Classes.CancelableBackgroundTask → DiGi.Core.Classes.ReportableBackgroundTask<System.Int64> → DiGi.GIS.PostgreSQL.WebAPI.Classes.SerializableObjectsPostTask<DiGi.GIS.Classes.OccupancyData> → OccupancyDatasPostTask
Initializes a new instance of the OccupancyDatasPostTask class.
public OccupancyDatasPostTask(DiGi.GIS.PostgreSQL.WebAPI.Classes.GISPostgreSQLWebAPIManager gISPostgreSQLWebAPIManager);gISPostgreSQLWebAPIManager GISPostgreSQLWebAPIManager
The manager used to handle GIS PostgreSQL Web API operations.
Gets or sets the code associated with the occupancy data post task.
public string? Code { get; set; }Gets or sets the collection of DiGi.GIS.Classes.OccupancyData values for administrative areal 2D.
public System.Collections.Generic.IEnumerable<DiGi.GIS.Classes.OccupancyData>? Values_AdministrativeAreal2D { get; set; }System.Collections.Generic.IEnumerable<DiGi.GIS.Classes.OccupancyData>
Controller providing API endpoints for managing and accessing orthophoto data and related GIS spatial information via a PostgreSQL database.
public class OrtoDatasController : DiGi.WebAPI.Classes.WebAPIControllerInheritance System.Object → Microsoft.AspNetCore.Mvc.ControllerBase → DiGi.WebAPI.Classes.WebAPIController → OrtoDatasController
OrtoDatasController(GISPostgreSQLWebAPIConfigurationFileWatcher, OrtoDatasPostgreSQLConverter, Building2DPostgreSQLConverter, AdministrativeAreal2DPostgreSQLConverter) Constructor
Initializes a new instance of the OrtoDatasController class.
public OrtoDatasController(DiGi.GIS.PostgreSQL.WebAPI.Classes.GISPostgreSQLWebAPIConfigurationFileWatcher gISPostgreSQLWebAPIConfigurationFileWatcher, DiGi.GIS.PostgreSQL.Classes.OrtoDatasPostgreSQLConverter ortoDatasPostgreSQLConverter, DiGi.GIS.PostgreSQL.Classes.Building2DPostgreSQLConverter building2DPostgreSQLConverter, DiGi.GIS.PostgreSQL.Classes.AdministrativeAreal2DPostgreSQLConverter administrativeAreal2DPostgreSQLConverter);gISPostgreSQLWebAPIConfigurationFileWatcher GISPostgreSQLWebAPIConfigurationFileWatcher
The configuration file watcher used to monitor changes to the GIS PostgreSQL Web API settings.
ortoDatasPostgreSQLConverter DiGi.GIS.PostgreSQL.Classes.OrtoDatasPostgreSQLConverter
The converter used for handling OrtoDatas data operations within the PostgreSQL database.
building2DPostgreSQLConverter DiGi.GIS.PostgreSQL.Classes.Building2DPostgreSQLConverter
The converter used for handling Building 2D data operations within the PostgreSQL database.
administrativeAreal2DPostgreSQLConverter DiGi.GIS.PostgreSQL.Classes.AdministrativeAreal2DPostgreSQLConverter
The converter used for handling Administrative Areal 2D data operations within the PostgreSQL database.
Asynchronously checks for the existence of a collection of references, optionally filtered by a county identifier.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> ContainsByReferencesAsync(System.Collections.Generic.List<string>? references, System.Nullable<int> countyId, System.Nullable<bool> inverted);references System.Collections.Generic.List<System.String>
A list of strings representing the references to be checked.
countyId System.Nullable<System.Int32>
The countyId.
inverted System.Nullable<System.Boolean>
The inverted.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation.
Retrieves the estimated coverage factor for a specified administrative area 2D identifier.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetEstimatedCoverageFactorAsync(int administrativeAreal2DId);administrativeAreal2DId System.Int32
The unique identifier of the administrative area 2D.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
An Microsoft.AspNetCore.Mvc.IActionResult containing the estimated coverage factor or an error status code.
Retrieves the estimated coverage factors for the specified administrative area identifiers.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetEstimatedCoverageFactorsAsync(System.Collections.Generic.IEnumerable<int> administrativeAreal2DIds, System.Nullable<bool> analyze);administrativeAreal2DIds System.Collections.Generic.IEnumerable<System.Int32>
The collection of administrative area 2D identifiers to be processed.
analyze System.Nullable<System.Boolean>
An optional flag indicating whether to perform an analysis during the retrieval process.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation.
Retrieves orthophoto image data based on the provided reference, year, and optional county identifier.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetImageByReferenceAsync(string reference, short year, System.Nullable<int> countyId=null);reference System.String
The unique reference string of the orthophoto image.
year System.Int16
The production or capture year of the orthophoto image.
countyId System.Nullable<System.Int32>
The optional identifier of the county associated with the orthophoto data.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation.
Asynchronously retrieves an orthodata 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=null);reference System.String
The unique reference string used to locate the orthodata item.
countyId System.Nullable<System.Int32>
The optional identifier of the county associated with the orthodata item.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation.
Retrieves the next batch of building 2D reference objects.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> NextBuilding2DReferences(int count=100);count System.Int32
The maximum number of building 2D reference objects to retrieve. Defaults to 100.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation.
Updates items identified by a specific code using the provided JSON array.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> UpdateItemsByCodeAsync(System.Text.Json.Nodes.JsonArray? jsonArray, string code);jsonArray System.Text.Json.Nodes.JsonArray
The JSON array containing the updated item data.
code System.String
The unique identifier or code used to identify the items for update.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation.
Updates orthodata items associated with a specific county identifier.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> UpdateItemsByCountyIdAsync(System.Text.Json.Nodes.JsonArray? jsonArray, int countyId);jsonArray System.Text.Json.Nodes.JsonArray
The JSON array containing the orthodata items to be updated.
countyId System.Int32
The unique identifier of the county for which the updates are applied.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation.
Handles the process of posting orthodata retrieved from the database.
public class OrtoDatasFromDatabasePostTask : DiGi.GIS.PostgreSQL.WebAPI.Classes.OrtoDatasPostTaskInheritance System.Object → DiGi.Core.Classes.BackgroundTask → DiGi.Core.Classes.CancelableBackgroundTask → DiGi.Core.Classes.ReportableBackgroundTask<System.Int64> → DiGi.GIS.PostgreSQL.WebAPI.Classes.SerializableObjectsPostTask<DiGi.GIS.Classes.OrtoDatas> → OrtoDatasPostTask → OrtoDatasFromDatabasePostTask
Handles the process of posting orthodata retrieved from the database.
public OrtoDatasFromDatabasePostTask(DiGi.GIS.PostgreSQL.WebAPI.Classes.GISPostgreSQLWebAPIManager gISPostgreSQLWebAPIManager);gISPostgreSQLWebAPIManager GISPostgreSQLWebAPIManager
The manager responsible for handling GIS PostgreSQL Web API communications.
Handles the posting of OrtoDatas objects to the PostgreSQL web API.
public class OrtoDatasPostTask : DiGi.GIS.PostgreSQL.WebAPI.Classes.SerializableObjectsPostTask<DiGi.GIS.Classes.OrtoDatas>Inheritance System.Object → DiGi.Core.Classes.BackgroundTask → DiGi.Core.Classes.CancelableBackgroundTask → DiGi.Core.Classes.ReportableBackgroundTask<System.Int64> → DiGi.GIS.PostgreSQL.WebAPI.Classes.SerializableObjectsPostTask<DiGi.GIS.Classes.OrtoDatas> → OrtoDatasPostTask
Derived
↳ OrtoDatasFromDatabasePostTask
Handles the posting of OrtoDatas objects to the PostgreSQL web API.
public OrtoDatasPostTask(DiGi.GIS.PostgreSQL.WebAPI.Classes.GISPostgreSQLWebAPIManager gISPostgreSQLWebAPIManager);gISPostgreSQLWebAPIManager GISPostgreSQLWebAPIManager
The manager instance used to handle PostgreSQL web API operations.
Gets or sets the code associated with the OrtoDatas post task.
public string? Code { get; set; }Handles the background processing of orthophoto data within the GIS PostgreSQL context.
public class OrtoDatasTask : DiGi.Core.Classes.ReportableBackgroundTask<long>, DiGi.GIS.PostgreSQL.Interfaces.IGISPostgreSQLObject, DiGi.Core.Interfaces.IObjectInheritance System.Object → DiGi.Core.Classes.BackgroundTask → DiGi.Core.Classes.CancelableBackgroundTask → DiGi.Core.Classes.ReportableBackgroundTask<System.Int64> → OrtoDatasTask
Implements DiGi.GIS.PostgreSQL.Interfaces.IGISPostgreSQLObject, DiGi.Core.Interfaces.IObject
Initializes a new instance of the OrtoDatasTask class.
public OrtoDatasTask(DiGi.GIS.PostgreSQL.WebAPI.Classes.GISPostgreSQLWebAPIManager? gISPostgreSQLWebAPIManager, DiGi.GIS.PostgreSQL.Classes.GISPostgreSQLConverterManager? gISPostgreSQLConverterManager);gISPostgreSQLWebAPIManager GISPostgreSQLWebAPIManager
The manager responsible for handling GIS PostgreSQL Web API operations.
gISPostgreSQLConverterManager DiGi.GIS.PostgreSQL.Classes.GISPostgreSQLConverterManager
The manager that handles conversion processes for GIS data within a PostgreSQL database context.
Represents the configuration options for posting serializable objects, extending the base post options functionality.
public class SerializableObjectsPostOptions : DiGi.WebAPI.Classes.PostOptionsInheritance System.Object → DiGi.Core.Classes.Object → DiGi.Core.Classes.SerializableObject → DiGi.Core.Classes.SerializableOptions → DiGi.WebAPI.Classes.PostOptions → SerializableObjectsPostOptions
Initializes a new instance of the SerializableObjectsPostOptions class.
public SerializableObjectsPostOptions();Initializes a new instance of the SerializableObjectsPostOptions class using values from an existing instance.
public SerializableObjectsPostOptions(DiGi.GIS.PostgreSQL.WebAPI.Classes.SerializableObjectsPostOptions? serializableObjectsPostOptions);serializableObjectsPostOptions SerializableObjectsPostOptions
The source options instance to copy values from, or null to use default settings.
Initializes a new instance of the SerializableObjectsPostOptions class using the specified JSON object.
public SerializableObjectsPostOptions(System.Text.Json.Nodes.JsonObject jsonObject);jsonObject System.Text.Json.Nodes.JsonObject
The System.Text.Json.Nodes.JsonObject containing the data used to initialize the options.
Gets or sets the memory size threshold in bytes used for processing batches of serializable objects.
public int BatchMemorySize { get; set; }Represents a base class for background tasks that handle the posting of serializable GIS objects to the PostgreSQL database.
public abstract class SerializableObjectsPostTask<T> : DiGi.Core.Classes.ReportableBackgroundTask<long>, DiGi.GIS.PostgreSQL.WebAPI.Interfaces.IGISPostgreSQLWebAPIObject, DiGi.Core.Interfaces.IObject
where T : DiGi.Core.Interfaces.ISerializableObjectT
The type of serializable object being posted, which must implement DiGi.Core.Interfaces.ISerializableObject.
Inheritance System.Object → DiGi.Core.Classes.BackgroundTask → DiGi.Core.Classes.CancelableBackgroundTask → DiGi.Core.Classes.ReportableBackgroundTask<System.Int64> → SerializableObjectsPostTask<T>
Derived
↳ AdministrativeAreal2DsPostTask
↳ Building2DsPostTask
↳ EPWFilesPostTask
↳ OccupancyDatasPostTask
↳ OrtoDatasPostTask
↳ YearBuiltDatasPostTask
Implements DiGi.GIS.PostgreSQL.WebAPI.Interfaces.IGISPostgreSQLWebAPIObject, DiGi.Core.Interfaces.IObject
Initializes a new instance of the SerializableObjectsPostTask class.
public SerializableObjectsPostTask(DiGi.GIS.PostgreSQL.WebAPI.Classes.GISPostgreSQLWebAPIManager gISPostgreSQLWebAPIManager);gISPostgreSQLWebAPIManager GISPostgreSQLWebAPIManager
The GIS PostgreSQL Web API manager used to perform database operations.
Gets or sets the options used for posting serializable objects.
public DiGi.GIS.PostgreSQL.WebAPI.Classes.SerializableObjectsPostOptions SerializableObjectsPostOptions { get; set; }SerializableObjectsPostOptions
Gets or sets the collection of serializable objects to be posted.
public System.Collections.Generic.IEnumerable<T>? Values { get; set; }System.Collections.Generic.IEnumerable<T>
Parameter class containing options for single-value database aggregation queries.
public class SinglevalueAggregateRequestParameter : DiGi.WebAPI.Classes.ParameterInheritance System.Object → DiGi.Core.Classes.Object → DiGi.Core.Classes.SerializableObject → DiGi.WebAPI.Classes.Parameter → SinglevalueAggregateRequestParameter
Initializes a new instance of the SinglevalueAggregateRequestParameter class.
public SinglevalueAggregateRequestParameter();Initializes a new instance of the SinglevalueAggregateRequestParameter class using a System.Text.Json.Nodes.JsonObject object.
public SinglevalueAggregateRequestParameter(System.Text.Json.Nodes.JsonObject jsonObject);jsonObject System.Text.Json.Nodes.JsonObject
The JSON object containing data used to initialize the parameter.
Gets or sets the column unique identifier to calculate statistics for.
public string ColumnUniqueId { get; set; }"col_unique_id_123"
Gets or sets the target partition identifier (County ID).
public int CountyId { get; set; }10365
Gets or sets the optional dynamic hierarchical filters to apply prior to aggregation.
public DiGi.PostgreSQL.Table.Classes.FilterGroup? FilterGroup { get; set; }DiGi.PostgreSQL.Table.Classes.FilterGroup
Gets or sets the single-value aggregation function to perform.
public DiGi.PostgreSQL.Table.Enums.SinglevalueAggregateFunction SinglevalueAggregateFunction { get; set; }DiGi.PostgreSQL.Table.Enums.SinglevalueAggregateFunction
Sum
Represents a parameter containing column unique id for querying unique values.
public class UniqueValuesByColumnUniqueIdParameter : DiGi.WebAPI.Classes.ParameterInheritance System.Object → DiGi.Core.Classes.Object → DiGi.Core.Classes.SerializableObject → DiGi.WebAPI.Classes.Parameter → UniqueValuesByColumnUniqueIdParameter
Initializes a new instance of the UniqueValuesByColumnUniqueIdParameter class.
public UniqueValuesByColumnUniqueIdParameter();Initializes a new instance of the UniqueValuesByColumnUniqueIdParameter class with the specified column unique id and county id.
public UniqueValuesByColumnUniqueIdParameter(string columnUniqueId, System.Nullable<int> countyId);columnUniqueId System.String
The unique identifier of the column.
countyId System.Nullable<System.Int32>
The optional unique identifier of the county.
Initializes a new instance of the UniqueValuesByColumnUniqueIdParameter class using an System.Text.Json.Nodes.JsonObject object.
public UniqueValuesByColumnUniqueIdParameter(System.Text.Json.Nodes.JsonObject jsonObject);jsonObject System.Text.Json.Nodes.JsonObject
The System.Text.Json.Nodes.JsonObject containing the data used to initialize the parameter.
Gets or sets the unique identifier of the column (Column.UniqueId).
public string ColumnUniqueId { get; set; }Gets or sets the county identifier.
public System.Nullable<int> CountyId { get; set; }Gets or sets the optional dynamic hierarchical filters to apply prior to retrieving unique values.
public DiGi.PostgreSQL.Table.Classes.FilterGroup? FilterGroup { get; set; }DiGi.PostgreSQL.Table.Classes.FilterGroup
Provides API endpoints for managing and updating year built data stored in a PostgreSQL database.
public class YearBuiltDataController : DiGi.WebAPI.Classes.WebAPIControllerInheritance System.Object → Microsoft.AspNetCore.Mvc.ControllerBase → DiGi.WebAPI.Classes.WebAPIController → YearBuiltDataController
YearBuiltDataController(GISPostgreSQLWebAPIConfigurationFileWatcher, YearBuiltDataPostgreSQLConverter, AdministrativeAreal2DPostgreSQLConverter) Constructor
Initializes a new instance of the YearBuiltDataController class.
public YearBuiltDataController(DiGi.GIS.PostgreSQL.WebAPI.Classes.GISPostgreSQLWebAPIConfigurationFileWatcher gISPostgreSQLWebAPIConfigurationFileWatcher, DiGi.GIS.PostgreSQL.Classes.YearBuiltDataPostgreSQLConverter yearBuiltDataPostgreSQLConverter, DiGi.GIS.PostgreSQL.Classes.AdministrativeAreal2DPostgreSQLConverter administrativeAreal2DPostgreSQLConverter);gISPostgreSQLWebAPIConfigurationFileWatcher GISPostgreSQLWebAPIConfigurationFileWatcher
The configuration file watcher used to monitor changes to the PostgreSQL Web API configuration.
yearBuiltDataPostgreSQLConverter DiGi.GIS.PostgreSQL.Classes.YearBuiltDataPostgreSQLConverter
The converter for YearBuiltData objects when interacting with a PostgreSQL database.
administrativeAreal2DPostgreSQLConverter DiGi.GIS.PostgreSQL.Classes.AdministrativeAreal2DPostgreSQLConverter
The converter for administrative areal 2D data when interacting with a PostgreSQL database.
Asynchronously retrieves items based on a provided reference and an optional county identifier.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetItemsByReferenceAsync(string reference, System.Nullable<int> countyId, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));reference System.String
The unique reference string used to identify the year built data items.
countyId System.Nullable<System.Int32>
An optional integer representing the county ID to filter the results.
cancellationToken System.Threading.CancellationToken
The System.Threading.CancellationToken to observe for cancellation requests.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation.
Updates multiple year built data items based on the provided JSON array and identification code.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> UpdateItemsAsync(System.Text.Json.Nodes.JsonArray? jsonArray, string code);jsonArray System.Text.Json.Nodes.JsonArray
The JSON array containing the data items to be updated.
code System.String
The identification code required for the update operation.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
An Microsoft.AspNetCore.Mvc.IActionResult representing the result of the update operation.
Provides functionality to handle the asynchronous posting of DiGi.GIS.Classes.YearBuiltData collections to the PostgreSQL database.
public class YearBuiltDatasPostTask : DiGi.GIS.PostgreSQL.WebAPI.Classes.SerializableObjectsPostTask<DiGi.GIS.Classes.YearBuiltData>Inheritance System.Object → DiGi.Core.Classes.BackgroundTask → DiGi.Core.Classes.CancelableBackgroundTask → DiGi.Core.Classes.ReportableBackgroundTask<System.Int64> → DiGi.GIS.PostgreSQL.WebAPI.Classes.SerializableObjectsPostTask<DiGi.GIS.Classes.YearBuiltData> → YearBuiltDatasPostTask
Initializes a new instance of the YearBuiltDatasPostTask class.
public YearBuiltDatasPostTask(DiGi.GIS.PostgreSQL.WebAPI.Classes.GISPostgreSQLWebAPIManager gISPostgreSQLWebAPIManager);gISPostgreSQLWebAPIManager GISPostgreSQLWebAPIManager
The GIS PostgreSQL Web API manager used to handle data persistence.
Gets or sets the code associated with the year built data post task.
public string? Code { get; set; }