Update apartment partially
- 28 Aug 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Update apartment 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
/apartments/{id}/
Operation is used to update specific fields in existing apartment. Available from product version 3.0.22.
Security
API Key
Header parameter nameAuthorization
Token issued for API consumer.
Path parameters
id
integerRequired
Id of apartment to update
Body parameters
Apartment attributes and values to be updated
object
address
integer Required
apartment address id
apartmentDivision
string
apartment division
apartmentLetter
string
apartment letter
apartmentNumber
string
apartment number
originProperty
string
apartment original property id
originalStreetno
string
apartment original street number
sourceSystem
integer
Source system id
sourceSystemKey
integer
Source system key
usagePurpose
integer
Apartment usage purpose id
usagePurposeAlt
integer
Address Secondary Usage purpose id
usageState
integer
Apartment status id
Responses
200
Object was updated successfully
object
address
integer
apartment address id
apartmentDivision
string
apartment division
apartmentLetter
string
apartment letter
apartmentNumber
string
apartment number
empty
integer
Apartment with this value as 1 is default apartment. Modifying or deleting such apartment is prohibited.
Valid values[ 0, 1 ]
id
integer
Primary key
originProperty
string
apartment original property id
originalStreetno
string
apartment original street number
sourceSystem
integer
Source system id
sourceSystemKey
integer
Source system key
usagePurpose
integer
Apartment usage purpose id
usagePurposeAlt
integer
Address Secondary Usage purpose id
usageState
integer
Apartment status id
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?
