|
Http Verb |
GET |
|---|---|
|
Url |
/territory/locations/r1/addresses |
|
Permissions required |
|
|
Personally Identifiable Information (PII) |
Yes |
|
Sensitive Information |
No |
|
Last Modified Version |
r1 |
|
Released since |
2024 W1 (FSM 16.0) |
|
Deprecated since |
|
|
Removed since |
|
|
Tech Tags |
PAGINATION ORDERING-SERVER-SIDE |
Business Logic
This API returns a list of Addresses filtered by input criteria.
To verify whether the address is correctly normalized, it is possible to use the information saved in the geocodingStatusId attribute and eventually also the geocodingAccuracyId.
To normalize the address, the geocoding API is available POST /territory/locations/r1/addresses/{addressId}/geocoding.
Query String Parameters
Filter ℹ️
|
Field |
Description |
Note |
|---|---|---|
|
id |
PK |
Collection of Ids |
|
targetId |
Asset / Account |
Asset: Revision 1 (2024 W1) or Accounts: Revision 1 (2024 W1) Collection of Ids |
|
typeId |
Type |
Address Types: Revision 1 (2024 W1) Collection of Ids |
|
description |
Description |
|
|
countryCode |
Country |
Countries: Revision 1 (2024 W1) Collection of Ids |
|
districtCode |
District |
Districts: Revision 1 (2024 W1) Collection of Ids |
|
normalizedMunicipality |
Normalized Municipality |
Search done by case insensitive |
|
normalizedLocality |
Normalized locality |
|
|
normalizedPostalCode |
Normalized Postal Code |
Search done by case insensitive |
|
normalizedStreet |
Normalized Street |
Search done by case insensitive |
|
normalizedStreetNumber |
Normalized Street Number |
|
|
normalizedToponym |
Normalized Toponym |
|
|
street |
Initial Street |
Search done by case insensitive |
|
streetNumber |
Initial Street Number |
|
|
apartment |
Initial apartment number |
|
|
streetNumberExtension |
Extended customer street |
|
|
floor |
Floor |
|
|
lot |
Lot |
|
|
staircase |
Stair case |
|
|
xCoordinate |
Longitude |
|
|
yCoordinate |
Latitude |
|
|
note |
Notes |
|
|
directions |
Directions |
|
|
code |
Code |
|
|
municipality |
Initial municipality |
|
|
locality |
Initial locality |
|
|
postalCode |
Initial postcode |
|
|
geocodingAccuracy |
Geocoding Accuracy |
Collection of Ids |
|
geocodingStatusId |
Geocoding Status |
Collection of Ids |
|
municipalityId |
Municipality |
Collection of Ids |
Order ℹ️
Default Order
id (ASC)
Possible order values
all response payload fields
Page ℹ️
Default.
Fields ℹ️
Default.
Language ℹ️
Default.
Header Parameters
Default.
Response documentation
Response payload fields
|
Field |
Note |
|---|---|
|
id |
|
|
targetId |
|
|
typeId |
|
|
description |
|
|
countryCode |
|
|
districtCodeId |
|
|
normalizedMunicipality |
|
|
normalizedLocality |
|
|
normalizedPostalCode |
|
|
normalizedStreet |
|
|
normalizedStreetNumber |
|
|
street |
|
|
streetNumber |
|
|
apartment |
|
|
streetNumberExtension |
|
|
floor |
|
|
lot |
|
|
staircase |
|
|
xCoordinate |
|
|
yCoordinate |
|
|
municipalityCode |
|
|
note |
|
|
normalizedToponym |
|
|
directions |
|
|
code |
|
|
municipality |
|
|
locality |
|
|
postalCode |
|
|
geocodingAccuracy |
|
|
geocodingStatusId |
|
|
municipalityId |
TODO |
Response error codes