Get address details
  • 17 Jan 2024
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Get address details

  • Dark
    Light
  • PDF

Article summary

Get
/addresses/{id}/

Operation is used to retrieve full details of given address id

Security
API Key
Header parameter nameAuthorization

Token issued for API consumer.

Path parameters
id
integerRequired

Id of address

Responses
200

Address

Expand All
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

groupname

Group name of constant

Valid values[ "BUILDING_USAGE" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all contants from this group

logical_txt
string

Logical textual value

txt
string

Human readable textual representation

usagePurposeAlt
object (AddressSecondaryUsage)

Address usage purpose

groupname

Group name of constant

Valid values[ "KN_ADDR_SPEC" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all contants from this group

logical_txt
string

Logical textual value

txt
string

Human readable textual representation

zipcode
string

Building zipcode

401

Authentication credentials are missing or invalid

{
  "details": "Authentication credentials were not provided"
}
object
details
string

Detailed description of error

404

Object was not found

{
  "details": "Not found."
}
object
details
string

Detailed description of error


Was this article helpful?