Search
K
[dev] 🇩🇪 Listings Management Germany

structure

object

structure of the property

* Additional properties are NOT allowed.
buildingobject
* Additional properties are NOT allowed.
Show Child Parameters
roomsobject
* Additional properties are NOT allowed.
Show Child Parameters
commercialobject
* Additional properties are NOT allowed.
Show Child Parameters
parkingLotsobject

number of available parking spaces that belong to the property

* Additional properties are NOT allowed.
Show Child Parameters
Example

texts

object

the texts can be transmitted in several languages. The corresponding data element therefore is an object and contains data elements which contain the language abbreviation in ISO 639-1 as a name.

* Additional properties are NOT allowed.
headlineobject

headline of the property

Example:{"de":"Hallo!","en":"Hello!","fr":"Bonjour!","nl":"Hallo!"}

* Additional properties are NOT allowed.
Show Child Parameters
descriptionobject

description of the property

Example:{"de":"Hallo!","en":"Hello!","fr":"Bonjour!","nl":"Hallo!"}

* Additional properties are NOT allowed.
Show Child Parameters
featuresobject

description of the interior, features of the property

Example:{"de":"Hallo!","en":"Hello!","fr":"Bonjour!","nl":"Hallo!"}

* Additional properties are NOT allowed.
Show Child Parameters
extendedInformationobject

additional information of the property

Example:{"de":"Hallo!","en":"Hello!","fr":"Bonjour!","nl":"Hallo!"}

* Additional properties are NOT allowed.
Show Child Parameters
areaobject

area description of the property

Example:{"de":"Hallo!","en":"Hello!","fr":"Bonjour!","nl":"Hallo!"}

* Additional properties are NOT allowed.
Show Child Parameters
Example

management

object

General management information, like if pets are allowed or the max rental time

* Additional properties are NOT allowed.
isImmediatelyAvailableboolean

is ready for immediate use

Example:true

availableFromstring(date)

available for use from this date; the date is an ISO 8601 formatted string. DEPRECATED for projects (use buildingProperty.program.deliveryDate instead)

Example:2023-05-24T00:00:00.000Z

availableUntilstring(date)

only available for use until this date; the date is an ISO 8601 formatted string

Example:2023-05-24T00:00:00.000Z

isForInvestmentboolean

suitable as investment

Example:true

heritageProtectedstring

is the property under a preservation order

Allowed values:YESNONOT_APPLICABLE

Example:NOT_APPLICABLE

marketStatusstring

marketing status of the property, is it currently sold, rented, under offer, etc. Options cannot be combined! fr: UNDER_OFFER si le bien est sous compromis

Allowed values:SOLDRENTEDREFERENCERESERVEDUNDER_OFFER

projectStatusstring

Status of a project property indicating the construction or sales phase

Allowed values:BUILDING_PERMISSIONCOMMERCIAL_LAUNCHCONSTRUCTION_STARTUNDER_CONSTRUCTIONSHELL_WORKSFINISHING_WORKSLAST_CHANCEPROJECT_ENDED

marketLabelstring

additional to marketStatus; can be use eg on the realtor’s website.

<= 512 characters

Example:property of the week

isRentedboolean

is the purchasing property currently rented; de: ist das Kaufobjekt aktuell vermietet; fr: Indique si murs occupés ou murs libres pour un fonds de commerce

Example:true

useForstring

Info on the usage of the property

Allowed values:LIVINGCOMMERCIALMIXEDOFFICEINDUSTRIAL

isForHolidayRentalboolean

can be rented as holiday property to other people

Example:true

rentobject

management info on rental properties

* Additional properties are NOT allowed.
Show Child Parameters
compulsoryAuctionobject
* Additional properties are NOT allowed.
Show Child Parameters
Example

countrySpecific

object
* Additional properties are NOT allowed.
deobject
* Additional properties are NOT allowed.
frobject
* Additional properties are NOT allowed.
Show Child Parameters
Example

links

object
externalLinksarray[object]

links to external resources which are not meant to be downloaded and processed by the portal

* Additional properties are NOT allowed.
Show Child Parameters
virtualToursarray[object]

Agencies or other intermediaries can provide virtual tour links to external players with external privacy agreements

* Additional properties are NOT allowed.
Show Child Parameters
Example