Search
K
[dev] 🇩🇪 Listings Management Germany

warning

object
typestring

The warning type

Example:LOCATION_IMPRECISE

messagestring

The warning message

Example:The location for the listing is not precise enough. The listing may not be accurately represented on the map.

Example

data

object
* Additional properties are NOT allowed.
estateTypestringrequired

the general type of the property.
changing this value is NOT permitted during an update transaction.
to classify it in detail, please use the subtypes.
descriptions for the enums above:

  • HOUSE: a building where people live in
  • APARTMENT: a set of rooms for living in within a building; a flat
  • PLOT: a piece of land
  • OFFICE: a room, set of rooms, or building where the business of a
    commercial or industrial organization or of a professional
    person is conducted. also medical offices are included here.
  • TRADING: all kind of properties concerning trading, retail
    and whole sale
  • GASTRONOMY_HOTEL: all kind of properties concerning the hotel
    and catering industry
  • STORAGE_PRODUCTION: an industrial or production site, warehouse,
    storage unit or building
  • AGRICULTURE_FORESTRY: all kind of properties concerning
    agriculture and forestry in the broadest sense
  • PARKING: all parking relevant properties for any kind of vehicles
  • SENIOR: senior-oriented living properties
  • PROJECT: usually a project is made up of more single properties,
    like a multi family house and often it is not finished yet but
    planned or under construction
  • MISCELLANEOUS: every other kind of property that can not be
    classified into the other estateTypes

Allowed values:HOUSEAPARTMENTPLOTOFFICETRADINGGASTRONOMY_HOTELSTORAGE_PRODUCTIONAGRICULTURE_FORESTRYPARKINGSENIORPROJECTMISCELLANEOUS

>= 1 characters<= 50 characters

Example:HOUSE

estateSubTypeOne Of

subtypes to specify the selected estateType in detail

Variant 1object
* Additional properties are NOT allowed.
Show Child Parameters
distributionTypestringrequired

the distribution type of the property.

  • BUY: regular type of property for sale
    de: Kauf
  • RENT: regular type of property for rent
    de: Miete
  • COMPULSORY_AUCTION: auction ordered by the courts
    de: Zwangsversteigerung
  • BUY_AUCTION: bids for the property can be submitted within a
    limited time period. The seller can accept, reject or negotiate
    the bid. Most important difference to a classic auction: the
    highest bid does not necessarily have to win.
    de: Bieterverfahren

Allowed values:BUYRENTCOMPULSORY_AUCTIONBUY_AUCTION

>= 1 characters

Example:BUY

locationobjectrequired

geographical information of the real estate property

* Additional properties are NOT allowed.
Show Child Parameters
pricesobjectrequired

contains different prices and price types for a property

* Additional properties are NOT allowed.
Show Child Parameters
spacesobject

contains different space types for a property. you can submit multiple spaces here (e.g. livingSpace, atticSpace and gardenSpace)

* Additional properties are NOT allowed.
Show Child Parameters
conditionsobject

Condition information of the property.

* Additional properties are NOT allowed.
Show Child Parameters
energyobject

Energy and heating information of the property.

* Additional properties are NOT allowed.
Show Child Parameters
featuresobject

Feature information for the property

* Additional properties are NOT allowed.
Show Child Parameters
structureobject

structure of the property

* Additional properties are NOT allowed.
Show Child Parameters
textsobject

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.
Show Child Parameters
managementobject

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

* Additional properties are NOT allowed.
Show Child Parameters
countrySpecificobject
* Additional properties are NOT allowed.
Show Child Parameters
contactobject
* Additional properties are NOT allowed.
Show Child Parameters
linksobject
Show Child Parameters
Example

apiRequest

object

Request wrapper for Data

* Additional properties are NOT allowed.
dataobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
metadataobjectrequired

metadatas associated to listing in Aviv system

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

Array of media items to attach to the listing.

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

listingResponse

object

Listing

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

estateType

string

the general type of the property.
changing this value is NOT permitted during an update transaction.
to classify it in detail, please use the subtypes.
descriptions for the enums above:

  • HOUSE: a building where people live in
  • APARTMENT: a set of rooms for living in within a building; a flat
  • PLOT: a piece of land
  • OFFICE: a room, set of rooms, or building where the business of a
    commercial or industrial organization or of a professional
    person is conducted. also medical offices are included here.
  • TRADING: all kind of properties concerning trading, retail
    and whole sale
  • GASTRONOMY_HOTEL: all kind of properties concerning the hotel
    and catering industry
  • STORAGE_PRODUCTION: an industrial or production site, warehouse,
    storage unit or building
  • AGRICULTURE_FORESTRY: all kind of properties concerning
    agriculture and forestry in the broadest sense
  • PARKING: all parking relevant properties for any kind of vehicles
  • SENIOR: senior-oriented living properties
  • PROJECT: usually a project is made up of more single properties,
    like a multi family house and often it is not finished yet but
    planned or under construction
  • MISCELLANEOUS: every other kind of property that can not be
    classified into the other estateTypes

Allowed values:HOUSEAPARTMENTPLOTOFFICETRADINGGASTRONOMY_HOTELSTORAGE_PRODUCTIONAGRICULTURE_FORESTRYPARKINGSENIORPROJECTMISCELLANEOUS

>= 1 characters<= 50 characters

Example