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