@qualipool/swissrets-json

{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://example.com/product.schema.json", "title": "SwissRETS JSON Schema", "description": "The SwissRETS inventory.", "type": "object", "additionalProperties": false, "properties": { "created": { "type": "string", "minLength": 1, "format": "date-time" }, "generator": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "minLength": 1 }, "version": { "type": "string", "minLength": 1 } }, "required": ["version"] }, "projects": { "type": "array", "title": "Project", "items": { "$ref": "#/$defs/projectType" } }, "properties": { "type": "array", "title": "Property", "items": { "$ref": "#/$defs/propertyType" } } }, "required": ["generator"], "$defs": { "projectType": { "type": "object", "description": "Building project container.", "additionalProperties": false, "properties": { "id": { "type": "string" }, "referenceId": { "type": "string" }, "seller": { "type": "object", "description": "The owner or the owners substitute (for example a broker).", "additionalProperties": false, "properties": { "organization": { "$ref": "#/$defs/organizationType", "description": "The company selling" }, "contactPerson": { "$ref": "#/$defs/personType", "title": "Person", "description": "Contact person for questions and typically responsible for making appointments. This contact is typicaly presented publicly." }, "inquiryEmail": { "title": "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.", "$ref": "#/$defs/emailType" } } }, "availability": { "type": "object", "description": "Mutually exclusive lifecycle state.", "additionalProperties": false, "properties": { "state": { "type": "string", "$ref": "#/$defs/availabilityStateType" }, "start": { "type": "string", "format": "date-time" }, "expiration": { "type": "string", "format": "date-time" } }, "required": ["state"] }, "constructionStatus": { "type": "string", "title": "ConstructionStatusType", "description": "Construction status of project.", "enum": ["planned", "under-construction", "ready", "completed"] }, "address": { "$ref": "#/$defs/addressType", "description": "Location of the property." }, "prices": { "type": "object", "description": "Price ranges for marketing purposes.", "additionalProperties": false, "properties": { "currency": { "$ref": "#/$defs/currencyType" }, "rent": { "description": "Recurring rental price.", "title": "projectPriceRent", "type": "object", "additionalProperties": false, "properties": { "netFrom": { "type": "integer", "minimum": 0 }, "netTo": { "type": "integer", "minimum": 0 }, "interval": { "$ref": "#/$defs/priceIntervalType" }, "referring": { "$ref": "#/$defs/priceReferringType" } }, "required": ["netFrom", "netTo"] }, "buy": { "description": "One time buy prices.", "title": "projectPriceBuy", "type": "object", "additionalProperties": false, "properties": { "priceFrom": { "type": "integer", "minimum": 0 }, "priceTo": { "type": "integer", "minimum": 0 }, "referring": { "$ref": "#/$defs/priceReferringType" } }, "required": ["priceFrom", "priceTo", "referring"] } }, "required": ["currency"] }, "characteristics": { "type": "object", "description": "Characteristics and ranges relevant to entire project.", "additionalProperties": false, "properties": { "areaSiaNfFrom": { "type": "number", "minimum": 0 }, "areaSiaNfTo": { "type": "number", "minimum": 0 }, "areaBwfFrom": { "type": "number", "minimum": 0 }, "areaBwfTo": { "type": "number", "minimum": 0 }, "numberOfRoomsFrom": { "type": "number", "minimum": 0 }, "numberOfRoomsTo": { "type": "number", "minimum": 0 }, "numberOfResidentialUnits": { "type": "number", "minimum": 0 }, "numberOfCommercialUnits": { "type": "number", "minimum": 0 } } }, "localizations": { "type": "array", "description": "Sequence of all language specific content and texts.", "items": { "type": "object", "description": "One for each language, a set of language specific content and texts.", "additionalProperties": false, "properties": { "languageCode": { "$ref": "#/$defs/languageCodeType" }, "title": { "type": "string", "description": "Simple marketing title." }, "excerpt": { "type": "string", "description": "A short extract from description, location and equipment." }, "description": { "type": "string", "description": "Main description." }, "attachments": { "type": "object", "description": "Sequence links, files, embeds and media.", "title": "ProjectAttachment", "additionalProperties": false, "properties": { "images": { "type": "array", "title": "Image", "items": { "$ref": "#/$defs/attachmentImageType" } }, "logos": { "type": "array", "title": "Logo", "items": { "$ref": "#/$defs/attachmentLogoType" } }, "documents": { "type": "array", "title": "Document", "items": { "$ref": "#/$defs/attachmentDocumentType", "description": "Specifications, brochures and other descriptive files." } }, "plans": { "type": "array", "title": "Document", "items": { "$ref": "#/$defs/attachmentDocumentType", "description": "Floorplan image or document." } }, "landRegisterExtracts": { "type": "array", "title": "Document", "items": { "$ref": "#/$defs/attachmentDocumentType", "description": "A document given to political officials (commune) with basic information portraying the property and its registrational validity." } }, "directLinks": { "type": "array", "title": "Link", "items": { "$ref": "#/$defs/attachmentLinkType", "description": "'direct-link' defines a link that will link visitors 'directly' to the offer. For example from a List of properties one will be linked to the project website directly if clicked. This is usually used by websites, and portals tend to ignore that and can opt into simply representing them as normal 'link' types." } }, "links": { "type": "array", "title": "Link", "items": { "$ref": "#/$defs/attachmentLinkType", "description": "An arbitrary related link." } }, "virtualTourLinks": { "type": "array", "title": "Link", "items": { "$ref": "#/$defs/attachmentLinkType", "description": "Virtual tour link, typically used for embeddings and integrations." } }, "youTubeLinks": { "type": "array", "title": "Link", "items": { "$ref": "#/$defs/attachmentLinkType", "description": "Video link, typically used for embeddings and integrations." } } } } }, "required": ["title", "languageCode"] } }, "units": { "type": "array", "description": "List of units.", "items": { "type": "object", "description": "A set of properties", "additionalProperties": false, "properties": { "id": { "type": "string" }, "referenceId": { "type": "string" }, "localizations": { "type": "array", "description": "Sequence of all language specific content and texts.", "items": { "type": "object", "description": "One for each language, a set of language specific content and texts.", "additionalProperties": false, "properties": { "languageCode": { "$ref": "#/$defs/languageCodeType" }, "title": { "type": "string", "description": "Simple marketing title for unit." } }, "required": ["languageCode", "title"] } }, "characteristics": { "type": "array", "title": "UnitCharacteristic", "items": { "$ref": "#/$defs/unitCharacteristicsType" } } }, "required": ["referenceId", "localizations"] }, "uniqueId": "units" } }, "required": ["referenceId", "availability", "units"] }, "propertyType": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "description": "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)" }, "type": { "title": "OfferType", "description": "Specifies rent or buy.", "type": "string", "enum": ["buy", "rent"] }, "referenceId": { "description": "Can be used to track the original creation id (this should usually be unique to the property)", "type": "string", "examples": ["3000123456", "97666adc-d1aa-4591-8d3f-716ad65ee477"] }, "unitReferenceId": { "type": "string", "sameAs": true, "description": "Reference to an existing project - unit within the xml. Used for grouping and representing a 'project-tree'" }, "visualReferenceId": { "type": "string", "description": "Can should only be used for presentational purposes publishers tend to present the referenceId if this one is missing" }, "externalReference": { "type": "object", "description": "Object references based on other than SwissRETS standard (e.g IDX).", "properties": { "refProperty": { "type": "string" }, "refHouse": { "type": "string" }, "refObject": { "type": "string" } }, "additionalProperties": false }, "minergieCertification": { "title": "MinergieCertificationType", "description": "Quality label for new and refurbished low-energy-consumption buildings.", "type": "string", "enum": [ "Minergie", "Minergie-A", "Minergie-A-Eco", "Minergie-Areal", "Minergie-Eco", "Minergie-Mqs-Bau", "Minergie-Mqs-Betrieb", "Minergie-P", "Minergie-P-Eco" ] }, "modified": { "type": "string", "format": "date-time", "description": "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." }, "created": { "type": "string", "format": "date-time", "description": "Creation date and time of the data." }, "parcelNumbers": { "type": "string", "description": "Arbitrary string that holds one or more parcel numbers, either from the swiss cadastral system or from a certain municipality." }, "author": { "type": "string", "description": "The name or username of the author, who created the record." }, "buildingZones": { "type": "string", "description": "Building zones intended for residential buildings or for other buildings intended as long-stay accommodation, those are typically municipal-specific abbreviations." }, "development": { "type": "string", "title": "DevelopmentState", "description": "The development state of the property.", "enum": ["full", "partial", "undeveloped"] }, "bfs": { "$ref": "#/$defs/bfsType", "description": "Federal statistical office specific information" }, "heating": { "$ref": "#/$defs/heatingType", "description": "The main heating system." }, "categories": { "description": "Sequence of ordered categories (main first).", "type": "array", "minItems": 0, "uniqueItems": true, "items": { "type": "string", "title": "PropertyCategory", "enum": [ "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", "shared-apartment", "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" ] } }, "characteristics": { "$ref": "#/$defs/propertyCharacteristicsType", "description": "Main characteristics of properties" }, "availability": { "description": "Mutually exclusive lifecycle state.", "type": "object", "additionalProperties": false, "properties": { "state": { "type": "string", "$ref": "#/$defs/availabilityStateType" }, "start": { "type": "string", "format": "date-time" }, "expiration": { "type": "string", "format": "date-time" } }, "required": ["state"] }, "publishers": { "type": "array", "title": "Publishers", "description": "List of publishers", "items": { "$ref": "#/$defs/publisherType" } }, "address": { "$ref": "#/$defs/addressType", "description": "Location of the property." }, "propertyOwner": { "$ref": "#/$defs/propertyOwnerType", "description": "The owner of the property." }, "seller": { "type": "object", "additionalProperties": false, "properties": { "inquiryEmail": { "title": "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.", "$ref": "#/$defs/emailType" }, "organization": { "$ref": "#/$defs/organizationType", "description": "The company selling" }, "contactPerson": { "$ref": "#/$defs/personType", "title": "Person", "description": "Contact person for questions and typically responsible for making appointments. This contact is typicaly presented publicly." }, "visitPerson": { "$ref": "#/$defs/personType", "title": "Person", "description": "Person responsible opening the door for visiting." } } }, "prices": { "$ref": "#/$defs/pricesType" }, "localizations": { "type": "array", "title": "PropertyLocalization", "items": { "$ref": "#/$defs/localizationType" }, "description": "Sequence of all language specific content and texts." } }, "required": ["id", "referenceId", "type", "availability", "localizations"] }, "languageCodeType": { "description": "Lowercase, two letter representation of a language.", "type": "string", "pattern": "^[a-z]{2}$", "maxLength": 2, "minLength": 2 }, "priceIntervalType": { "title": "PriceIntervalType", "description": "The payment interval, the price stands for.", "type": "string", "enum": ["onetime", "day", "week", "month", "year"] }, "priceReferringType": { "title": "PriceReferringType", "description": "For what area the price stands for.", "type": "string", "enum": ["all", "m2", "km2"] }, "emailType": { "description": "Very loose email like strings, validation basically just checks, if there is an @ sign and a dot after that.", "type": "string", "pattern": "[^@]+@[^\\.]+\\..+" }, "phoneNumberType": { "type": "string", "pattern": "^[+]?([0-9] )*[0-9]{3,}$", "description": "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." }, "attachmentImageType": { "description": "Picture from inside or outside, typically used in image galleries.", "type": "object", "additionalProperties": false, "properties": { "url": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "mimeType": { "type": "string" } }, "required": ["url"] }, "attachmentLogoType": { "description": "Related logo image.", "type": "object", "additionalProperties": false, "properties": { "url": { "type": "string" }, "mimeType": { "type": "string" } }, "required": ["url"] }, "attachmentLinkType": { "description": "Localized link attachment for properties.", "type": "object", "additionalProperties": false, "properties": { "url": { "type": "string" }, "title": { "type": "string" } }, "required": ["url"] }, "attachmentDocumentType": { "description": "Generic non-specific document.", "type": "object", "additionalProperties": false, "properties": { "url": { "type": "string" }, "title": { "type": "string" }, "mimeType": { "type": "string" }, "description": { "type": "string" } }, "required": ["url"] }, "bfsType": { "type": "object", "description": "Federal statistical office specific information", "additionalProperties": false, "properties": { "egid": { "type": "string", "description": "The building identifier of the swiss population register", "examples": ["1254"] }, "ewid": { "type": "string", "description": "The flat identifier of the swiss population register ", "examples": ["1254"] }, "egrid": { "type": "string", "description": "The property (plot) identifier of the swiss population register", "examples": ["1254"] } } }, "heatingType": { "type": "object", "description": "The main heating system.", "additionalProperties": false, "properties": { "generation": { "type": "string", "title": "HeatingGenerationType", "description": "Technology used to create heat.", "enum": [ "district", "electricity", "gas", "geothermal-probe", "heatpump-air-and-water", "heatpump", "oil", "photovoltaics", "solar-thermal", "wood-pellet", "wood", "coal" ] }, "distribution": { "type": "string", "title": "HeatingDistributionType", "description": "How the heating system distributes and maintains temperature.", "enum": ["radiator", "floor"] } } }, "propertyCharacteristicsType": { "type": "object", "description": "The cold facts, to represent the property or offer.", "additionalProperties": false, "properties": { "areaBwf": { "type": "number", "minimum": 0, "description": "Living area in m²" }, "areaNwf": { "type": "number", "minimum": 0, "description": "Net livin area in m²" }, "areaPropertyLand": { "type": "number", "minimum": 0, "description": "Property land area in m²" }, "areaCellar": { "type": "number", "minimum": 0, "description": "Space allocated in cellar included within the offer in m²" }, "areaBalcony": { "type": "number", "minimum": 0, "description": "If there is a balcony (non ground floor outside area) this field would specify the area in m²" }, "areaTerrace": { "type": "number", "minimum": 0, "description": "Usually ground floor outside seating area in m²" }, "areaLoggia": { "type": "number", "minimum": 0, "description": "Usually refers to a covered not necessarily heated area with fresh air, but not opened up to the outside." }, "areaGarden": { "type": "number", "minimum": 0, "description": "Area dedicated to growing plants or a garden. To differentiate from something like a Terrace. In m²" }, "areaSiaAff": { "type": "number", "minimum": 0, "description": "SIA-AFF area in m²" }, "areaSiaAgf": { "type": "number", "minimum": 0, "description": "SIA-AGF area in m²" }, "areaSiaAkf": { "type": "number", "minimum": 0, "description": "SIA-AKF area in m²" }, "areaSiaAkfn": { "type": "number", "minimum": 0, "description": "SIA-AKFN area in m²" }, "areaSiaAkft": { "type": "number", "minimum": 0, "description": "SIA-AKFT area in m²" }, "areaSiaAnf": { "type": "number", "minimum": 0, "description": "SIA-ANF area in m²" }, "areaSiaAngf": { "type": "number", "minimum": 0, "description": "SIA-ANGF area in m²" }, "areaSiaAvf": { "type": "number", "minimum": 0, "description": "SIA-AVF area in m²" }, "areaSiaBuf": { "type": "number", "minimum": 0, "description": "SIA-BUF area in m²" }, "areaSiaFf": { "type": "number", "minimum": 0, "description": "SIA-FF area in m²" }, "areaSiaGf": { "type": "number", "minimum": 0, "description": "SIA-GF area in m²" }, "areaSiaGgf": { "type": "number", "minimum": 0, "description": "SIA-GGF area in m²" }, "areaSiaGsf": { "type": "number", "minimum": 0, "description": "SIA-GSF area in m²" }, "areaSiaHnf": { "type": "number", "minimum": 0, "description": "SIA-HNF area in m²" }, "areaSiaKf": { "type": "number", "minimum": 0, "description": "SIA-KF area in m²" }, "areaSiaKfn": { "type": "number", "minimum": 0, "description": "SIA-KFN area in m²" }, "areaSiaKft": { "type": "number", "minimum": 0, "description": "SIA-KFT area in m²" }, "areaSiaNf": { "type": "number", "minimum": 0, "description": "SIA-NF area in m²" }, "areaSiaNgf": { "type": "number", "minimum": 0, "description": "SIA-NGF area in m²" }, "areaSiaNnf": { "type": "number", "minimum": 0, "description": "SIA-NNF area in m²" }, "areaSiaUf": { "type": "number", "minimum": 0, "description": "SIA-UF area in m²" }, "areaSiaUuf": { "type": "number", "minimum": 0, "description": "SIA-UUF area in m²" }, "areaSiaVf": { "type": "number", "minimum": 0, "description": "SIA-VF area in m²" }, "arePetsAllowed": { "$ref": "#/$defs/applicableType", "title": "applicableType", "description": "Pets are allowed or not tolerated." }, "ceilingHeight": { "type": "number", "minimum": 0, "description": "Height of the rooms in m." }, "craneCapacity": { "type": "number", "minimum": 0, "description": "Carrying capacity for crane in kg." }, "elevatorLoad": { "type": "number", "minimum": 0, "description": "Maximum elevator load in kg." }, "floor": { "type": "integer", "description": "Floor number, ground floor is 0, basement floors are negative." }, "floorLoad": { "type": "number", "minimum": 0, "description": "Maximum floor load in kg/m²" }, "grossPremium": { "type": "number", "minimum": 0, "maximum": 100, "description": "A gross premium is the total premium of an insurance contract before brokerage or discounts have been deducted, in percent." }, "hallHeight": { "type": "number", "minimum": 0, "description": "Hall height in m, usually for commercial properties." }, "hasAttic": { "$ref": "#/$defs/applicableType", "title": "applicableType", "description": "Has an attic." }, "hasBalcony": { "description": "Balcony available.", "title": "applicableType", "$ref": "#/$defs/applicableType" }, "hasBuildingLawRestrictions": { "description": "Restrictions for modifications apply, like monument protection and similar.", "title": "applicableType", "$ref": "#/$defs/applicableType" }, "hasCableTv": { "description": "Availability of cable tv.", "title": "applicableType", "$ref": "#/$defs/applicableType" }, "hasCarPort": { "description": "A covered structure used to offer limited protection from rain and snow, for one car.", "title": "applicableType", "$ref": "#/$defs/applicableType" }, "hasCarPortDouble": { "description": "A covered structure used to offer limited protection from rain and snow, for two cars.", "title": "applicableType", "$ref": "#/$defs/applicableType" }, "hasCellar": { "description": "Availability of a cellar.", "title": "applicableType", "$ref": "#/$defs/applicableType" }, "hasChargingStation": { "description": "Whether or not a charging station for e-Cars is provided.", "title": "applicableType", "$ref": "#/$defs/applicableType" }, "hasConnectedBuildingLand": { "description": "States if the land is fully developed and ready being built on it.", "title": "applicableType", "$ref": "#/$defs/applicableType" }, "hasDemolitionProperty": { "description": "Used for building land, states if there is some demolition property on it (or pieces of it).", "title": "applicableType", "$ref": "#/$defs/applicableType" }, "hasDishwasher": { "$ref": "#/$defs/applicableType", "title": "applicableType", "description": "Availability of a dishwasher." }, "hasElevator": { "$ref": "#/$defs/applicableType", "title": "applicableType", "description": "Availability of an elevator." }, "hasEvChargingStation": { "description": "A charging station for e-Cars is provided.", "title": "applicableType", "$ref": "#/$defs/applicableType" }, "hasFiberOptic": { "description": "Availability of a fiber optic connection.", "title": "applicableType", "$ref": "#/$defs/applicableType" }, "hasFireplace": { "description": "Includes a framed opening to hold an open fire, indoors.", "title": "applicableType", "$ref": "#/$defs/applicableType" }, "hasFlatSharingCommunity": { "$ref": "#/$defs/applicableType", "title": "applicableType", "description": "Whether or not there is a residential community, sharing the living space." }, "hasForeignQuota": { "$ref": "#/$defs/applicableType", "title": "applicableType", "description": "Widely used to control the amount of foreigners buying holiday flats in popular regions." }, "hasGarage": { "$ref": "#/$defs/applicableType", "title": "applicableType", "description": "A shelter for one car." }, "hasGarageDouble": { "$ref": "#/$defs/applicableType", "title": "applicableType", "description": "A shelter for two cars." }, "hasGarageUnderground": { "$ref": "#/$defs/applicableType", "title": "applicableType", "description": "Subterranean garage for cars." }, "hasGardenShed": { "$ref": "#/$defs/applicableType", "title": "applicableType", "description": "A small building for storing garden tools, bicycles, and other equipment." }, "hasLakeView": { "$ref": "#/$defs/applicableType", "title": "applicableType", "description": "Direct visibility of a lake." }, "hasLiftingPlatform": { "$ref": "#/$defs/applicableType", "title": "applicableType", "description": "Provides vertical transportation between building floors, levels or decks, and are commonly found in offices, public buildings and other types of multi-story accommodation." }, "hasMountainView": { "$ref": "#/$defs/applicableType", "title": "applicableType", "description": "Direct visibility of mountains." }, "hasMultimediaWiring": { "$ref": "#/$defs/applicableType", "title": "applicableType", "description": "Has multimedia wiring." }, "hasNiceView": { "$ref": "#/$defs/applicableType", "title": "applicableType", "description": "Has a lovely view, usually from the balcony or the living room." }, "hasParking": { "$ref": "#/$defs/applicableType", "title": "applicableType", "description": "An uncovered space for one car or more cars." }, "hasPhotovoltaic": { "$ref": "#/$defs/applicableType", "title": "applicableType", "description": "Whether or not a photovoltaic system is provided." },