Create new apartment
- 28 Aug 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Create new apartment
- 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
Post
/apartments/
Operation is used to create new apartment. Available from product version 3.0.22.
Security
API Key
Header parameter nameAuthorization
Token issued for API consumer.
Body parameters
apartment to be created
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
201
A created Apartment
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
400
There was an error in request. Usually field validation failed.
object
Fields which failed validation
property*
Array of string additionalProperties
List of validation errors for this fieldname
string
Validation error
401
Authentication credentials are missing or invalid
{
"details": "Authentication credentials were not provided"
}object
details
string
Detailed description of error
Was this article helpful?
