Get address alias details

28 Aug 2024
3 Minutes to read
Contributors

Print
Dark
Light
PDF

Get address alias details

Updated on 28 Aug 2024
3 Minutes to read
Contributors

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get

/address-aliases/{id}/

Operation is used to retrieve full details of given address alias id

Security

API Key

Header parameter nameAuthorization

Token issued for API consumer.

Path parameters

integerRequired

Id of address alias

Responses

200

Address alias

{
  "address": {
    "apartments": [
      "https://keycore.example.fi/api/v2/apartments/1790078/"
    ],
    "buildingId": "",
    "city": "TEST-CITY1",
    "cityAlt": "",
    "country": "",
    "createdBy": "keycom.user@keypro.fi",
    "createdTs": "2020-08-20T01:39:18Z",
    "district": "",
    "empty": 0,
    "id": 21685370,
    "listUrl": "https://keycore.example.fi/api/v2/addresses/",
    "location": null,
    "municipality": "",
    "propertyId": "",
    "province": "",
    "sourceSystem": null,
    "sourceSystemKey": null,
    "streetname": "TEST_STREET_NAME1",
    "streetnameAlt": "",
    "streetno": "1",
    "subdivision": "",
    "updatedBy": "keycom.user@keypro.fi",
    "updatedTs": "2020-08-20T01:39:18Z",
    "usagePurpose": null,
    "usagePurposeAlt": null,
    "zipcode": ""
  },
  "city": "city",
  "cityAlt": "",
  "id": 21,
  "orderno": null,
  "sourceSystem": null,
  "sourceSystemKey": null,
  "streetname": "street",
  "streetnameAlt": "",
  "streetno": "2",
  "zipcode": ""
}

Expand All

object

address

object (Address)

buildingId

string

Building id

buildingName

string

Building name

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

empty

integer

Address with this value as 1 is default address. Modifying or deleting such address is prohibited.

Valid values[ 0, 1 ]

integer

Primary key

location

string (ewkt)

Geographical location

municipality

string

Building municipality

propertyId

string

Property number

province

string

Building province

sourceSystem

object (SourceSystem)

External source system

availability_end_ts

string (date-time)

Ending date time for availability

availability_start_ts

string (date-time)

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[ "SOURCE_SYSTEM" ]

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number (float)

Numeric value

num_value2

number (float)

Numeric value 2

num_value3

number (float)

Numeric value 3

num_value4

number (float)

Numeric value 4

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 (date-time)

Last update date time

usagePurpose

object (BuildingUsage)

Building usage purpose

availability_end_ts

string (date-time)

Ending date time for availability

availability_start_ts

string (date-time)

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" ]

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number (float)

Numeric value

num_value2

number (float)

Numeric value 2

num_value3

number (float)

Numeric value 3

num_value4

number (float)

Numeric value 4

txt

string

Human readable textual representation

usagePurposeAlt

object (AddressSecondaryUsage)

Address usage purpose

availability_end_ts

string (date-time)

Ending date time for availability

availability_start_ts

string (date-time)

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" ]

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number (float)

Numeric value

num_value2

number (float)

Numeric value 2

num_value3

number (float)

Numeric value 3

num_value4

number (float)

Numeric value 4

txt

string

Human readable textual representation

zipcode

string

Building zipcode

city

string

Building city name

cityAlt

string

Building city name in alternative language

integer

Primary key

orderno

integer

Order number

sourceSystem

object (SourceSystem)

External source system

availability_end_ts

string (date-time)

Ending date time for availability

availability_start_ts

string (date-time)

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[ "SOURCE_SYSTEM" ]

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number (float)

Numeric value

num_value2

number (float)

Numeric value 2

num_value3

number (float)

Numeric value 3

num_value4

number (float)

Numeric value 4

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

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?

What's Next

Get list of Address aliases