badRequestErrorResponse
The URI reference that identifies the problem type. The “about:blank” URI, when used as a problem type, indicates that the problem has no additional semantics beyond that of the HTTP status code.
The HTTP status code generated for this occurrence of the problem
A human-readable summary of the problem type
Example:Some example
A human-readable explanation specific to this occurrence of the problem
A URI reference that identifies the specific occurrence of the problem
The source of the error
conflictErrorResponse
Represents a Conflict error
The URI reference that identifies the problem type. The “about:blank” URI, when used as a problem type, indicates that the problem has no additional semantics beyond that of the HTTP status code.
The HTTP status code generated for this occurrence of the problem
A human-readable summary of the problem type
Example:Some example
A human-readable explanation specific to this occurrence of the problem
A URI reference that identifies the specific occurrence of the problem
The source of the error
warning
objectThe warning type
Example:LOCATION_IMPRECISE
The warning message
Example:The location for the listing is not precise enough. The listing may not be accurately represented on the map.
data
objectthe 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
One Ofsubtypes to specify the selected estateType in detail
Show Child Parameters
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
geographical information of the real estate property
Show Child Parameters
contains different prices and price types for a property
Show Child Parameters
contains different space types for a property. you can submit multiple spaces here (e.g. livingSpace, atticSpace and gardenSpace)
Show Child Parameters
Condition information of the property.
Show Child Parameters
Energy and heating information of the property.
Show Child Parameters
Feature information for the property
Show Child Parameters
structure of the property
Show Child Parameters
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.
Show Child Parameters
General management information, like if pets are allowed or the max rental time
Show Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
apiRequest
objectRequest wrapper for Data
Show Child Parameters
metadatas associated to listing in Aviv system
Show Child Parameters
Array of media items to attach to the listing.