|
Http Verb |
PATCH |
|---|---|
|
Url |
/territory/locations/r1/addresses/{addressId} |
|
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 |
|
Business Logic
This API updates an existing address.
Path Parameters
|
Field |
Note |
|---|---|
|
addressId |
|
Header Parameters
Default.
Request Body Parameters
|
Field |
Description |
Validations |
Note |
|---|---|---|---|
|
municipality |
Initial municipality |
Not null Max Length: 40 |
|
|
countryCode |
Country |
Not null Max Length: 3 Referenced resource code existence check |
|
|
targetId |
Technical object |
Max Length: 11 |
Asset: Revision 1 (2024 W1) or Accounts: Revision 1 (2024 W1) |
|
typeId |
Type |
Max Length: 11 Referenced resource id existence check |
|
|
code |
Code |
Max Length: 100 |
|
|
description |
Description |
Max Length: 40 |
|
|
districtCode |
District |
Max Length: 10 Referenced resource code existence check |
|
|
street |
Initial Street |
Max Length: 254 |
|
|
streetNumber |
Initial Street Number |
Max Length: 11 |
|
|
apartment |
Initial apartment number |
Max Length: 10 |
|
|
streetNumberExtension |
Extended customer street |
Max Length: 10 |
|
|
floor |
Floor |
Max Length: 10 |
|
|
lot |
Lot |
Max Length: 10 |
|
|
staircase |
Stair case |
Max Length: 10 |
|
|
xCoordinate |
X coordinate |
Max Length: 13 |
|
|
yCoordinate |
Y coordinate |
Max Length: 13 |
|
|
municipalityCode |
Municipality Code |
Max Length: 6 |
|
|
note |
Notes |
Max Length: 255 |
|
|
directions |
Directions |
Max Length: 255 |
|
|
locality |
Initial locality |
Max Length: 50 |
|
|
postalCode |
Initial postcode |
Max Length: 9 |
|
|
toponym |
Toponym |
|
|
|
municipalityId |
Municipality |
Max Length: 11 Referenced resource id existence check |
TODO |
Response documentation
Response error codes