Update address partially
- 28 Aug 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Update address partially
- Updated on 28 Aug 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Patch
/addresses/{id}/
Operation is used to update specific fields in existing address. Available from product version 3.0.22.
Security
API Key
Header parameter nameAuthorization
Token issued for API consumer.
Path parameters
id
integerRequired
Id of address to update
Body parameters
Address attributes and values to be updated
object
buildingId
string
Building id
buildingName
string
Building name
city
string Required
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
location
string (ewkt)
Geographical location
municipality
string
Building municipality
propertyId
string
Property number
province
string
Building province
sourceSystem
integer
Source system id
sourceSystemKey
integer
Source system key
streetname
string Required
Building street name
streetnameAlt
string
Building street name in alternative language
streetno
string Required
Building number
subdivision
string
Building municipality subdivision
updatedBy
string
Last updater
updatedTs
string (date-time)
Last update date time
usagePurpose
integer
Building Usage id
usagePurposeAlt
integer
Address Secondary Usage id
zipcode
string
Building zipcode
Responses
200
Object was updated successfully
object
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 ]
id
integer
Primary key
location
string (ewkt)
Geographical location
municipality
string
Building municipality
propertyId
string
Property number
province
string
Building province
sourceSystem
integer
Source system id
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
integer
Building Usage id
usagePurposeAlt
integer
Address Secondary Usage id
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?
