SwissRETS JSON Schema

Type: object

The SwissRETS inventory.

No Additional Properties

Type: stringFormat: date-time

Must be at least 1 characters long

Type: object
No Additional Properties

Type: string

Must be at least 1 characters long

Type: string

Must be at least 1 characters long

Project

Type: array
No Additional Items

Each item of this array must be:

Type: object

Building project container.

No Additional Properties

Type: string

Type: object

The owner or the owners substitute (for example a broker).

No Additional Properties

Type: object

The company selling

No Additional Properties

Type: object

Postal address.

No Additional Properties

Type: string

Uppercase two letter country code.

Must match regular expression: [A-Z]{2}

Type: object

Geo coordinates and elevation

No Additional Properties

Type: string

Very loose email like strings, validation basically just checks, if there is an @ sign and a dot after that.

Must match regular expression: [^@]+@[^\.]+\..+

Type: string

This field is depricated and will be removed in a future major version!

Same definition as email

Type: string

Strings of at least three digits, may start with a plus sign and can have single spaces between digits, leading and trailing whitespace are not allowed.

Must match regular expression: ^[+]?([0-9] )*[0-9]{3,}$

Type: string

Strings of at least three digits, may start with a plus sign and can have single spaces between digits, leading and trailing whitespace are not allowed.

Same definition as phone

Type: object

Sellers URL, typically the company website.

No Additional Properties

Person

Type: object

Contact person for questions and typically responsible for making appointments. This contact is typicaly presented publicly.

No Additional Properties

Type: string

Very loose email like strings, validation basically just checks, if there is an @ sign and a dot after that.

Same definition as email

Type: string

Strings of at least three digits, may start with a plus sign and can have single spaces between digits, leading and trailing whitespace are not allowed.

Same definition as phone

Type: string

Strings of at least three digits, may start with a plus sign and can have single spaces between digits, leading and trailing whitespace are not allowed.

Same definition as phone

The emailaddress dedicated for receiving inquiries and applications. This email address should not be presented publicly and is only intended as an indirect recipient using an online form or similar.

Type: string

Very loose email like strings, validation basically just checks, if there is an @ sign and a dot after that.

Must match regular expression: [^@]+@[^\.]+\..+

Type: object

Mutually exclusive lifecycle state.

No Additional Properties

Type: string

Lifecycle state of properties.

Must be one of:

  • "active"
  • "private"
  • "reference"
  • "reserved"
  • "taken"

Type: stringFormat: date-time

Type: stringFormat: date-time

ConstructionStatusType

Type: enum (of string)

Construction status of project.

Must be one of:

  • "planned"
  • "under-construction"
  • "ready"
  • "completed"

Type: object

Location of the property.

Same definition as address

Type: object

Price ranges for marketing purposes.

No Additional Properties

Type: string
Must match regular expression: ^[A-Z]{3}$

projectPriceRent

Type: object

Recurring rental price.

No Additional Properties

Type: integer

Value must be greater or equal to 0

Type: integer

Value must be greater or equal to 0

Type: enum (of string)

The payment interval, the price stands for.

Must be one of:

  • "onetime"
  • "day"
  • "week"
  • "month"
  • "year"

Type: enum (of string)

For what area the price stands for.

Must be one of:

  • "all"
  • "m2"
  • "km2"

projectPriceBuy

Type: object

One time buy prices.

No Additional Properties

Type: integer

Value must be greater or equal to 0

Type: integer

Value must be greater or equal to 0

Type: enum (of string)

For what area the price stands for.

Same definition as referring

Type: object

Characteristics and ranges relevant to entire project.

No Additional Properties

Type: number

Value must be greater or equal to 0

Type: number

Value must be greater or equal to 0

Type: number

Value must be greater or equal to 0

Type: number

Value must be greater or equal to 0

Type: number

Value must be greater or equal to 0

Type: number

Value must be greater or equal to 0

Type: number

Value must be greater or equal to 0

Type: number

Value must be greater or equal to 0

Type: array of object

Sequence of all language specific content and texts.

No Additional Items

Each item of this array must be:

Type: object

One for each language, a set of language specific content and texts.

No Additional Properties

Type: string

Lowercase, two letter representation of a language.

Must match regular expression: ^[a-z]{2}$

Must be at least 2 characters long

Must be at most 2 characters long

Type: string

Simple marketing title.

Type: string

A short extract from description, location and equipment.

ProjectAttachment

Type: object

Sequence links, files, embeds and media.

No Additional Properties

Document

Type: array
No Additional Items

Each item of this array must be:

Type: object

A document given to political officials (commune) with basic information portraying the property and its registrational validity.

Same definition as projects_items_localizations_items_attachments_documents_items

Type: array of object

List of units.

No Additional Items

Each item of this array must be:

Type: object

A set of properties

No Additional Properties

Type: array of object

Sequence of all language specific content and texts.

No Additional Items

Each item of this array must be:

Type: object

One for each language, a set of language specific content and texts.

No Additional Properties

Type: string

Lowercase, two letter representation of a language.

Same definition as languageCode

Type: string

Simple marketing title for unit.

UnitCharacteristic

Type: array
No Additional Items

Each item of this array must be:

Type: object

The cold facts, to represent a unit.

No Additional Properties

Type: number

Value must be greater or equal to 0

Property

Type: array
No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: string

This ID needs to be unique and represents the id from the exporter (this can be the same as referenceId if the exporter is the original creator)

OfferType

Type: enum (of string)

Specifies rent or buy.

Must be one of:

  • "buy"
  • "rent"

Type: string

Can be used to track the original creation id (this should usually be unique to the property)


Examples:

"3000123456"
"97666adc-d1aa-4591-8d3f-716ad65ee477"

Type: string

Reference to an existing project - unit within the xml. Used for grouping and representing a 'project-tree'

Type: string

Can should only be used for presentational purposes publishers tend to present the referenceId if this one is missing

Type: object

Object references based on other than SwissRETS standard (e.g IDX).

No Additional Properties

MinergieCertificationType

Type: enum (of string)

Quality label for new and refurbished low-energy-consumption buildings.

Must be one of:

  • "Minergie"
  • "Minergie-A"
  • "Minergie-A-Eco"
  • "Minergie-Areal"
  • "Minergie-Eco"
  • "Minergie-Mqs-Bau"
  • "Minergie-Mqs-Betrieb"
  • "Minergie-P"
  • "Minergie-P-Eco"

Type: stringFormat: date-time

Date and time of the last modification. This field should only be used for presentational purposes and should not be relied upon for import cache-busting.

Type: stringFormat: date-time

Creation date and time of the data.

Type: string

Arbitrary string that holds one or more parcel numbers, either from the swiss cadastral system or from a certain municipality.

Type: string

The name or username of the author, who created the record.

Type: string

Building zones intended for residential buildings or for other buildings intended as long-stay accommodation, those are typically municipal-specific abbreviations.

DevelopmentState

Type: enum (of string)

The development state of the property.

Must be one of:

  • "full"
  • "partial"
  • "undeveloped"

Type: object

Federal statistical office specific information

No Additional Properties

Type: string

The building identifier of the swiss population register


Example:

"1254"

Type: string

The flat identifier of the swiss population register


Example:

"1254"

Type: string

The property (plot) identifier of the swiss population register


Example:

"1254"

Type: object

The main heating system.

No Additional Properties

HeatingGenerationType

Type: enum (of string)

Technology used to create heat.

Must be one of:

  • "district"
  • "electricity"
  • "gas"
  • "geothermal-probe"
  • "heatpump-air-and-water"
  • "heatpump"
  • "oil"
  • "photovoltaics"
  • "solar-thermal"
  • "wood-pellet"
  • "wood"
  • "coal"

HeatingDistributionType

Type: enum (of string)

How the heating system distributes and maintains temperature.

Must be one of:

  • "radiator"
  • "floor"

Type: array of enum (of string)

Sequence of ordered categories (main first).

Must contain a minimum of 0 items

All items must be unique

No Additional Items

Each item of this array must be:

PropertyCategory

Type: enum (of string)

Must be one of:

  • "advertising-area"
  • "agricultural-lot"
  • "allotment-garden"
  • "apartment"
  • "arcade"
  • "atelier"
  • "attic-compartment"
  • "attic-flat"
  • "bakery"
  • "bar"
  • "boat-dry-dock"
  • "boat-landing-stage"
  • "boat-mooring"
  • "building-lot"
  • "butcher"
  • "cafe"
  • "campground"
  • "car-park"
  • "car-repair-shop"
  • "carpentry-shop"
  • "casino"
  • "castle"
  • "cellar-compartment"
  • "chalet"
  • "cheese-factory"
  • "club-disco"
  • "commercial-lot"
  • "commercial-space"
  • "covered-motorbike-parking-space"
  • "covered-parking-space"
  • "department-store"
  • "detached-house"
  • "display-window"
  • "doctors-office"
  • "double-garage"
  • "duplex-house"
  • "earth-sheltered-dwelling"
  • "factory"
  • "farm-house"
  • "fuel-station"
  • "furnished-flat"
  • "golf-course"
  • "granny-flat"
  • "hairdresser"
  • "hobby-room"
  • "hospital"
  • "hotel"
  • "horse-box"
  • "indoor-swimming-pool"
  • "indoor-tennis-court"
  • "industrial-lot"
  • "industrial-object"
  • "kiosk"
  • "laboratory"
  • "library"
  • "loft"
  • "maisonette"
  • "market-garden"
  • "mini-golf-course"
  • "motel"
  • "movie-theater"
  • "multiplex-house"
  • "multistorey-car-park"
  • "nursing-home"
  • "office"
  • "one-room-flat"
  • "open-motorbike-parking-space"
  • "open-parking-space"
  • "orphanage"
  • "outdoor-swimming-pool"
  • "parking-space"
  • "party-room"
  • "plot"
  • "pub"
  • "residential-commercial-building"
  • "restaurant"
  • "retail-location"
  • "retirement-home"
  • "riding-hall"
  • "roof-flat"
  • "row-house"
  • "rustico"
  • "sanatorium"
  • "sauna"
  • "shopping-center"
  • "single-garage"
  • "single-room"
  • "solarium"
  • "sports-hall"
  • "squash-badminton"
  • "stepped-flat"
  • "stepped-house"
  • "stoeckli"
  • "storage-room"
  • "tennis-court"
  • "underground-parking-space"
  • "villa"
  • "workshop"

Type: object

Main characteristics of properties

No Additional Properties

Type: number

Living area in m²

Value must be greater or equal to 0

Type: number

Net livin area in m²

Value must be greater or equal to 0

Type: number

Property land area in m²

Value must be greater or equal to 0

Type: number

Space allocated in cellar included within the offer in m²

Value must be greater or equal to 0

Type: number

If there is a balcony (non ground floor outside area) this field would specify the area in m²

Value must be greater or equal to 0

Type: number

Usually ground floor outside seating area in m²

Value must be greater or equal to 0

Type: number

Usually refers to a covered not necessarily heated area with fresh air, but not opened up to the outside.

Value must be greater or equal to 0

Type: number

Area dedicated to growing plants or a garden. To differentiate from something like a Terrace. In m²

Value must be greater or equal to 0

Type: number

SIA-AFF area in m²

Value must be greater or equal to 0

Type: number

SIA-AGF area in m²

Value must be greater or equal to 0

Type: number

SIA-AKF area in m²

Value must be greater or equal to 0

Type: number

SIA-AKFN area in m²

Value must be greater or equal to 0

Type: number

SIA-AKFT area in m²

Value must be greater or equal to 0

Type: number

SIA-ANF area in m²

Value must be greater or equal to 0

Type: number

SIA-ANGF area in m²

Value must be greater or equal to 0

Type: number

SIA-AVF area in m²

Value must be greater or equal to 0

Type: number

SIA-BUF area in m²

Value must be greater or equal to 0

Type: number

SIA-FF area in m²

Value must be greater or equal to 0

Type: number

SIA-GF area in m²

Value must be greater or equal to 0

Type: number

SIA-GGF area in m²

Value must be greater or equal to 0

Type: number

SIA-GSF area in m²

Value must be greater or equal to 0

Type: number

SIA-HNF area in m²

Value must be greater or equal to 0

Type: number

SIA-KF area in m²

Value must be greater or equal to 0

Type: number

SIA-KFN area in m²

Value must be greater or equal to 0

Type: number

SIA-KFT area in m²

Value must be greater or equal to 0

Type: number

SIA-NF area in m²

Value must be greater or equal to 0

Type: number

SIA-NGF area in m²

Value must be greater or equal to 0

Type: number

SIA-NNF area in m²

Value must be greater or equal to 0

Type: number

SIA-UF area in m²

Value must be greater or equal to 0

Type: number

SIA-UUF area in m²

Value must be greater or equal to 0

Type: number

SIA-VF area in m²

Value must be greater or equal to 0

applicableType

Type: enum (of string)

Pets are allowed or not tolerated.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

Type: number

Height of the rooms in m.

Value must be greater or equal to 0

Type: number

Carrying capacity for crane in kg.

Value must be greater or equal to 0

Type: number

Maximum elevator load in kg.

Value must be greater or equal to 0

Type: integer

Floor number, ground floor is 0, basement floors are negative.

Type: number

Maximum floor load in kg/m²

Value must be greater or equal to 0

Type: number

A gross premium is the total premium of an insurance contract before brokerage or discounts have been deducted, in percent.

Value must be greater or equal to 0 and lesser or equal to 100

Type: number

Hall height in m, usually for commercial properties.

Value must be greater or equal to 0

applicableType

Type: enum (of string)

Has an attic.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Balcony available.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Restrictions for modifications apply, like monument protection and similar.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Availability of cable tv.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

A covered structure used to offer limited protection from rain and snow, for one car.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

A covered structure used to offer limited protection from rain and snow, for two cars.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Availability of a cellar.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Whether or not a charging station for e-Cars is provided.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

States if the land is fully developed and ready being built on it.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Used for building land, states if there is some demolition property on it (or pieces of it).

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Availability of a dishwasher.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Availability of an elevator.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

A charging station for e-Cars is provided.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Availability of a fiber optic connection.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Includes a framed opening to hold an open fire, indoors.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Whether or not there is a residential community, sharing the living space.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Widely used to control the amount of foreigners buying holiday flats in popular regions.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

A shelter for one car.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

A shelter for two cars.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Subterranean garage for cars.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

A small building for storing garden tools, bicycles, and other equipment.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Direct visibility of a lake.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Provides vertical transportation between building floors, levels or decks, and are commonly found in offices, public buildings and other types of multi-story accommodation.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Direct visibility of mountains.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Has multimedia wiring.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Has a lovely view, usually from the balcony or the living room.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

An uncovered space for one car or more cars.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Whether or not a photovoltaic system is provided.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Has a playground for children nearby.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

A sloping floor, walk, or roadway leading from one level to another, usually to make a place accessible for wheels.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Has a steamer.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Storeroom, stowage room.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Availability of a gas connection, usually for heating and cooking.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

A connection to the public electric grid.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

A connection to the public waste water system.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

A connection to the public water supply.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Personal swimming pool.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Whether or not a thermal solar collector system is provided.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

A masonry heater or ceramic stove, is a device for warming an interior space usually fed with wood.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Dryer for clothes after washing them.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

For washing clothes and other cloth.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Indicates that prospects can visit the property virtually (e.g. with a video-call or guided virtual-tour hosted by the real estate agent)

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Suitable for families.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

A house situated on the corner of two streets.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

If it's a tear-down property or a site of demolished structures.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Old and in poor condition, in a state of decay.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

No one used the flat or the building before, since it was built or heavily renovated from ground up.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Nearly on a level with the ground.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Half of a stair elevated story, in a building.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Preparation for demolition or a part-demolition, all contaminants, doors, windows, floors and non-load bearing walls were removed.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Needs to be renewed in order to be fully usable again.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Needs to be renewed partially in order to be fully usable again.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Used, but as good as new.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Situated between two other houses or buildings.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Modernized means improved, things like a better insulated roof and walls, modern heating system and similar improvements.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Newly built house or building.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Refers to the construction method used until 60-80 years ago.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Planned for the future.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Part of a quiet surrounding or neighbourhood.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Fully renovated, neat, clean and restored.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Partially renovated or restored.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Where a person lives part time or less than the majority of the calendar year, typically a holiday flat, some laws and landlords do not allow this.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Intentionally missing interior finish in order to allow customization.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Smoking allowed inside.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Sunny surroundings, nor trees, mountains or other buildings do shadow.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Is of temporary use.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Mainly used for parking slots.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Properly looked after.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

All aspects are accessible for wheelchair users.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

Type: integer

Number of apartments contained.

Value must be greater or equal to 0

Type: integer

Number of bathrooms.

Value must be greater or equal to 0

Type: integer

Total amount of floors.

Value must be greater or equal to 0

Type: integer

Number of parcels.

Value must be greater or equal to 0

Type: number

Total number of rooms.

Value must be greater or equal to 0

Type: integer

The number of showers

Value must be greater or equal to 0

Type: integer

The number of toilets

Value must be greater or equal to 0

Type: integer

The number of guest and additional toilets

Value must be greater or equal to 0

applicableType

Type: enum (of string)

Built on even grounds.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Built on a sloping hillside.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

applicableType

Type: enum (of string)

Built on a sloping hillside towards the south.

Must be one of:

  • "applies"
  • "does-not-apply"
  • "unknown"

Type: number

Plot area built on, the ratio between plot area and gross floor area.

Value must be greater or equal to 0

Type: number

Plot area to be built on, the ratio between plot area and gross floor area.

Value must be greater or equal to 0

Type: number

Building volume in m³

Value must be greater or equal to 0

Type: number

DEPRICATED! please use volumeSia116Gv instead

Value must be greater or equal to 0

Type: number

olume SIA in m³ – Older Standard (SIA 116) with the Abbreviation 'GV'. This is still in use specifically for legacy properties.

Value must be greater or equal to 0

Type: number

Volume SIA-AFV in m³

Value must be greater or equal to 0

Type: number

Volume SIA-AKV in m³

Value must be greater or equal to 0

Type: number

Volume SIA-ANGV in m³

Value must be greater or equal to 0

Type: number

Volume SIA-ANV in m³

Value must be greater or equal to 0

Type: number

Volume SIA-AVV in m³

Value must be greater or equal to 0

Type: number

Volume SIA-GV in m³

Value must be greater or equal to 0

Type: integer

Year of construction, in four digits.

Value must be greater or equal to 0 and lesser or equal to 9999

Type: integer

Year of last renovation, in four digits.

Value must be greater or equal to 0 and lesser or equal to 9999

Type: object

Mutually exclusive lifecycle state.

No Additional Properties

Type: string

Lifecycle state of properties.

Must be one of:

  • "active"
  • "private"
  • "reference"
  • "reserved"
  • "taken"

Type: stringFormat: date-time

Type: stringFormat: date-time

Publishers

Type: array

List of publishers

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

PublisherOption

Type: array

List of publisher specific custom fields

No Additional Items

Each item of this array must be:

Type: object

Custom key-value pair, or generic data field, used for non-standardized data transaction, between two entities.

No Additional Properties

Type: string

Lowercase, two letter representation of a language.

Same definition as languageCode

PublisherPromotions

Type: array

List of promotions

No Additional Items

Each item of this array must be:

Type: object

Custom key-value pair, or generic data field, used for non-standardized data transaction, between two entities.

No Additional Properties

Type: object

Location of the property.

Same definition as address

Type: object
No Additional Properties

The emailaddress dedicated for receiving inquiries and applications. This email address should not be presented publicly and is only intended as an indirect recipient using an online form or similar.

Type: string

Very loose email like strings, validation basically just checks, if there is an @ sign and a dot after that.

Must match regular expression: [^@]+@[^\.]+\..+

Person

Type: object

Contact person for questions and typically responsible for making appointments. This contact is typicaly presented publicly.

No Additional Properties

Type: string

Very loose email like strings, validation basically just checks, if there is an @ sign and a dot after that.

Same definition as email

Type: string

Strings of at least three digits, may start with a plus sign and can have single spaces between digits, leading and trailing whitespace are not allowed.

Same definition as phone

Type: string

Strings of at least three digits, may start with a plus sign and can have single spaces between digits, leading and trailing whitespace are not allowed.

Same definition as phone

Person

Type: object

Person responsible opening the door for visiting.

No Additional Properties

Type: string

Very loose email like strings, validation basically just checks, if there is an @ sign and a dot after that.

Same definition as email

Type: string

Strings of at least three digits, may start with a plus sign and can have single spaces between digits, leading and trailing whitespace are not allowed.

Same definition as phone

Type: string

Strings of at least three digits, may start with a plus sign and can have single spaces between digits, leading and trailing whitespace are not allowed.

Same definition as phone

Type: object

Sell, rent, deposit and auction prices.

No Additional Properties

propertyPriceRent

Type: object

Recurring rental price.

No Additional Properties

Type: integer

Gross rental price.

Value must be greater or equal to 0

Type: integer

Net rental price.

Value must be greater or equal to 0

Type: integer

Extra rental price.

Value must be greater or equal to 0

Type: enum (of string)

The payment interval, the price stands for.

Same definition as interval

Type: enum (of string)

For what area the price stands for.

Same definition as referring

propertyPriceBuy

Type: object

One time buy prices.

No Additional Properties

Type: integer

Price for buying.

Value must be greater or equal to 0

Type: integer

Extra buying price.

Value must be greater or equal to 0

Type: number

The percentage of the gross price which has to paid in WIR Franc electronic currency.

Value must be greater or equal to 0 and lesser or equal to 100

Type: enum (of string)

For what area the price stands for.

Same definition as referring

Type: object

Starting price for an auction.

No Additional Properties

Type: integer

Starting price for an auction.

Value must be greater or equal to 0

Type: stringFormat: date-time

Starting time of auction.

Type: stringFormat: date-time

Expiration time of auction.

Type: object

Required amount of deposit.

No Additional Properties

Type: integer

Amount of deposit.

Value must be greater or equal to 0

DepositType

Type: enum (of string)

Type of deposit.

Must be one of:

  • "bank-guarantee"
  • "deposit-guarantee"

AdditionalOffers

Type: array

List of extras.

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

AdditionalOfferType

Type: enum (of string)

Must be one of:

  • "parking-exterior-space"
  • "parking-carport"
  • "parking-garage"
  • "parking-garage-connected"
  • "parking-garage-box"
  • "parking-garage-underground"
  • "parking-house"
  • "parking-duplex"
  • "parking-double-garage"
  • "room-workroom"
  • "room-storage-basement"

Type: enum (of string)

The payment interval, the price stands for.

Same definition as interval

PropertyLocalization

Type: array

Sequence of all language specific content and texts.

No Additional Items

Each item of this array must be:

Type: object

One for each language, a set of language specific content and texts.

No Additional Properties

Type: string

Lowercase, two letter representation of a language.

Same definition as languageCode

Type: string

Simple marketing title.

Type: string

A short extract from description, location and equipment.

Type: string

Description of the surrounding and location.

Type: string

Description of available and included equipment.

PropertyAttachment

Type: object

Sequence links, files, embeds and media.

No Additional Properties

Image

Type: array
No Additional Items

Each item of this array must be:

Document

Type: array
No Additional Items

Each item of this array must be:

Type: object

A document given to political officials (commune) with basic information portraying the property and its registrational validity.

Same definition as projects_items_localizations_items_attachments_documents_items

Type: string

Specific visiting instructions or information, where to get the key, when to contact and similar.