Get list of Address

Prev Next
Get
/addresses/

Operation is used to get a list of Address.

Addresses can be filtered by giving filtering parameters at HTTP querystring (see parameters).

Security
API Key
Header parameter nameAuthorization

Token issued for API consumer.

Query parameters
offset
integer

Offset to start returning results.

Minimum0
limit
integer

Limit number of results returned.

Minimum1
srs
string

Coordinate system to transform location to.

Example: srs=epsg:4326

precision
integer

Number of decimals to be returned with object location. If parameter is not specified the number of decimals is as precise as possible for current running instance. Available from product version 2024.4.

Minimum1
dimensions
integer

number of dimensions to be returned. Acceptable values are 2 and 3. If parameter is not specified the number of dimensions are as default for current product. Available from product version 2024.4.

Minimum1
__any of the object fields__
string

Filters list by selected object field value. Supports structured queries via +__+ delimiter. Supports ending keywords via +__+ delimiter:

  • For string fields: istartswith, startswith, iendswith, endswith, contains, icontains, isnull
  • For numerics: gt, lt, gte, lte, isnull
  • For spatial fields: contains, isnull, within, intersects, disjoint, touches, overlaps, covers, coveredby Examples: +++usage_state__txt__istartswith=in+++ , +++plan__state__txt__startswith=In+++ , +++creation_date__gte=2019-01-02T15:32:01+++, +++location__within=POLYGON ((641503.89 6944059.81, 641406.52 6943933.87, 641369.48 6943772.48, 641474.25 6943704.74, 641873.78 6943735.96, 641848.38 6943975.15, 641607.08 6944167.76, 641653.11 6944102.15, 641503.89 6944059.81))+++
orderby
string

Selects the object field to order the returned objects by. Can be used to sort in reverse order with '-' prefix. Can have several ordering rules separated by comma. Can be used only for object own fields and does not supports structured queries. Example: orderby=creator,-creation_date

Responses
200
401

A result response object.

Collapse all
object
Next
string (url)

Url to next page of Addresses. Null if No next page exist

Prev
string (url)

Url to previous page of Addresses. Null if No previous page exist

Results
Array of object (Address)

List of fetched Addresses

object
buildingId
string

Building id

city
string

Building city name

cityAlt
string

Building city name in alternative language

country
string

Building country

createdBy
string

creator

createdTs
string (date-time)

Creation date and time

district
string

Building district

id
integer

Primary key

location
string (ewkt)

Geographical location

municipality
string

Building municipality

propertyId
string

Property number

province
string

Building province

streetname
string

Building street name

streetnameAlt
string

Building street name in alternative language

streetno
string

Building number

subdivision
string

Building municipality subdivision

updatedBy
string

Last updater

updatedTs
string (date-time)

Last update date time

usagePurpose
object (BuildingUsage)

Building usage purpose

usagePurposeAlt
object (AddressSecondaryUsage)

Address usage purpose

zipcode
string

Building zipcode

Total
integer

Total number of Addresses