Search
K
[dev] 🇩🇪 Listings Management Germany

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

estateSubType

subtypes to specify the selected estateType in detail

One Of
housestringrequired

subtypes of a house to describe the selected estate type in detail. descriptions for the enums above: - APARTMENT_HOUSE: a building containing multiple apartments
with a common entrance and sometimes services

  • BUNGALOW: a house that usually has only one storey, sometimes
    with an attic, with a flat or a low-pitched roof
  • CASTLE: a historical massive and imposing building
    usually fortified, built by the nobility, royalty or
    by military orders.
  • MANOR_HOUSE: magnificent country house, often dating from the late middle
    ages, in which the landed gentry used to live.
  • CHALET: a wooden house with a sloping roof and widely
    overhanging eaves, common in Switzerland and other Alpine
    regions in Europe.
  • FARMHOUSE: a house attached to a farm, especially the main
    house in which the farmer lives.
  • FINCA: spanish-style country house with a large garden in
    rural environment
  • GARDEN_HOUSE: a small dwelling usually built of wood located
    in the garden of a large property or in garden allotments
  • GITE: a furnished holiday home in France that is available
    for rent, especially in a rural environment.
  • LIVING_AND_COMMERCIAL: a building that contains units for
    living and for commercial, eg apartments, shops, offices
  • MOUNTAIN_HUT: a building located high in the mountains,
    usually accessible only by foot. When they are managed, they
    provide food and shelter to mountaineers
  • MULTI_FAMILY_HOUSE: a single building that is set up to
    accommodate more than one family living separately.
  • RESIDENTIAL_COMPLEX: a set of buildings containing multiple apartments
    often with common services, shared garden, pool, playground
  • RUSTICO: originally a cottage or farm building traditionally
    built with granite, typical for Ticino in Switzerland
  • SEMIDETACHED_HOUSE: a house that is joined to another similar
    house on one side by a shared wall
  • SINGLE_FAMILY_HOUSE: a freestanding house, with one dwelling
    unit for a person, couple or a family, set alone on its own
    parcel of land
  • SPECIAL_REAL_ESTATE: a special kind of property that can not
    be listing by another subtype, eg like a church
  • TERRACE_HOUSE: row of similar houses joined together
    by their side walls; row houses
    de: Achtung! entspricht nicht einem Terrassenhaus im Deutschen!
  • CORNER_TERRACE_HOUSE: is located at the corner or staggered
    in a row of terrace houses; one side wall is shared with
    another terrace house
  • END_TERRACE_HOUSE: is located at the end of a row of terrace
    houses, one side wall is shared with another terrace house
  • MID_TERRACE_HOUSE: is located in the middle of a row of
    terrace houses, both side walls are shared with another
    terrace house each.
  • TOWN_HOUSE: a tall, narrow house generally having three or
    more floors, usually in a row of similar houses which are
    connected together, sometimes even by a common sidewall.
  • VILLA: a prestigious house, that is very spacious and may
    include luxurious amenities such as a pool, etc.

Allowed values:APARTMENT_HOUSEBUNGALOWCASTLEMANOR_HOUSECHALETFARMHOUSEFINCAGARDEN_HOUSEGITELIVING_AND_COMMERCIALMULTI_FAMILY_HOUSEMOUNTAIN_HUTRESIDENTIAL_COMPLEXRUSTICOSEMIDETACHED_HOUSESINGLE_FAMILY_HOUSESPECIAL_REAL_ESTATETERRACE_HOUSECORNER_TERRACE_HOUSEEND_TERRACE_HOUSEMID_TERRACE_HOUSETOWN_HOUSEVILLA

>= 1 characters<= 50 characters

Example:SINGLE_FAMILY_HOUSE

Example