Create new apartment
  • 17 Jan 2024
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Create new apartment

  • Dark
    Light
  • PDF

Article summary

Post
/apartments/
Security
API Key
Header parameter nameAuthorization

Token issued for API consumer.

Body parameters

apartment to be created

object
buildingId
string

Building id

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

id
integer

Primary key

location
string (ewkt)

Geographical location

municipality
string

Building municipality

propertyId
string

Property number

province
string

Building province

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
201

A created Apartment

object
buildingId
string

Building id

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

id
integer

Primary key

location
string (ewkt)

Geographical location

municipality
string

Building municipality

propertyId
string

Property number

province
string

Building province

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

400

There was an error in request. Usually field validation failed.

object

Fields which failed validation

401

Authentication credentials are missing or invalid

{
  "details": "Authentication credentials were not provided"
}
object
details
string

Detailed description of error


Was this article helpful?