Operation is used to get a list of Address aliases.
Address aliases can be filtered by giving filtering parameters at HTTP querystring (see parameters).
Offset to start returning results.
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.
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+++
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
A result response object.
[
{
"address": {
"apartments": [
"https://keycore.example.fi/api/v2/apartments/1790078/"
],
"buildingId": "",
"city": "TEST-CITY1",
"cityAlt": "",
"country": "",
"createdBy": "keycom.user@keypro.fi",
"createdTs": "2020-08-20T13: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-20T13:39:18Z",
"usagePurpose": null,
"usagePurposeAlt": null,
"zipcode": ""
},
"city": "test-city-automated1",
"cityAlt": "",
"id": 1,
"orderno": null,
"sourceSystem": null,
"sourceSystemKey": null,
"streetname": "test_street_name",
"streetnameAlt": "",
"streetno": "1",
"zipcode": ""
},
{
"address": {
"apartments": [
"https://keycore.example.fi/api/v2/apartments/1790078/"
],
"buildingId": "",
"city": "TEST-CITY1",
"cityAlt": "",
"country": "",
"createdBy": "keycom.user@keypro.fi",
"createdTs": "2020-08-20T13: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-20T13:39:18Z",
"usagePurpose": null,
"usagePurposeAlt": null,
"zipcode": ""
},
"city": "city",
"cityAlt": "",
"id": 21,
"orderno": null,
"sourceSystem": null,
"sourceSystemKey": null,
"streetname": "street",
"streetnameAlt": "",
"streetno": "2",
"zipcode": ""
}
]Url to next page of Address aliases. Null if No next page exist
Url to previous page of Addresses aliases. Null if No previous page exist
List of fetched Address aliases
Building id
Building city name
Building city name in alternative language
Building country
creator
Creation date and time
Building district
Address with this value as 1 is default address. Modifying or deleting such address is prohibited.
Primary key
Geographical location
Building municipality
Property number
Building province
Source system
Group name of constant
Unique id of constant
Url to fetch all contants from this group
Logical textual value
Human readable textual representation
source system key
Building street name
Building street name in alternative language
Building number
Building municipality subdivision
Last updater
Last update date time
Building usage purpose
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant
Unique id of constant
Url to fetch all contants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
Address usage purpose
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant
Unique id of constant
Url to fetch all contants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
Building zipcode
Building city name
Building city name in alternative language
Primary key
Order number
Source system
Group name of constant
Unique id of constant
Url to fetch all contants from this group
Logical textual value
Human readable textual representation
source system key
Building street name
Building street name in alternative language
Building number
Building zipcode
Total number of Address aliases
Authentication credentials are missing or invalid
{
"details": "Authentication credentials were not provided"
}Detailed description of error