Get list of Address
- 29 Aug 2023
- 3 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Get list of Address
- Updated on 29 Aug 2023
- 3 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/addresses/
Operation is used to get a list of Address. Available from product version 3.0.22.
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.
Min length0
limit
integer
Limit number of results returned. Set to -1 to use maximum limit set in the environment. Default limit will be used if parameter is not specified. Special value -1 is available from product version 3.2.18.
Min length1
srs
string
Coordinate system to transform location to.
Example: srs=epsg:4326
__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))+++Supports exclusive queries by field value using a not-operator preceeding the field lookup: Examples:+++not__type__txt__istartswith=Tie+++,+++not__id=1390+++
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
A result response object.
object
Next
string
Url to next page of Addresses. Null if No next page exist
Prev
string
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
Creation date and time
district
string
Building district
empty
integer
Address with this value as 1 is default address. Modifying or deleting such address is prohibited.
Valid values[0,1]
id
integer
Primary key
location
string
Geographical location
municipality
string
Building municipality
propertyId
string
Property number
province
string
Building province
sourceSystem
object
Source system
groupname
Group name of constant
Valid values["SOURCE_SYSTEM"]
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
txt
string
Human readable textual representation
sourceSystemKey
integer
source system key
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
Last update date time
usagePurpose
object
Building usage purpose
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
Group name of constant
Valid values["BUILDING_USAGE"]
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
usagePurposeAlt
object
Address usage purpose
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
Group name of constant
Valid values["KN_ADDR_SPEC"]
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
zipcode
string
Building zipcode
Total
integer
Total number of Addresses
401
Authentication credentials are missing or invalid
{
"details": "Authentication credentials were not provided"
}object
details
string
Detailed description of error
Was this article helpful?
