Last active
August 29, 2015 14:26
-
-
Save oliyh/381e3a34b0d86c8ab36e to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "swagger": "2.0", | |
| "info": { | |
| "title": "DR API", | |
| "version": "1.0", | |
| "description": "Dr Jan Itor at your service" | |
| }, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "paths": { | |
| "/instruction": { | |
| "post": { | |
| "consumes": [ | |
| "application/json", | |
| "application/edn", | |
| "application/transit+json", | |
| "application/transit+msgpack", | |
| "application/x-www-form-urlencoded", | |
| "multipart/form-data" | |
| ], | |
| "responses": { | |
| "200": { | |
| "schema": { | |
| "$ref": "#/definitions/Response33840" | |
| }, | |
| "description": "OK" | |
| }, | |
| "400": { | |
| "description": "The request contains bad syntax or cannot be fulfilled." | |
| }, | |
| "500": { | |
| "description": "There was an internal server error." | |
| } | |
| }, | |
| "tags": [ | |
| "instruction" | |
| ], | |
| "summary": "Submit an instruction for processing", | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "OverseasLettingsInstruction", | |
| "description": "", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/Instruction" | |
| } | |
| } | |
| ] | |
| } | |
| }, | |
| "/status": { | |
| "get": { | |
| "consumes": [ | |
| "application/json", | |
| "application/edn", | |
| "application/transit+json", | |
| "application/transit+msgpack", | |
| "application/x-www-form-urlencoded", | |
| "multipart/form-data" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK" | |
| }, | |
| "400": { | |
| "description": "The request contains bad syntax or cannot be fulfilled." | |
| }, | |
| "500": { | |
| "description": "There was an internal server error." | |
| } | |
| }, | |
| "tags": [ | |
| "system" | |
| ], | |
| "summary": "Status of the instance" | |
| } | |
| } | |
| }, | |
| "definitions": { | |
| "DomesticLettingsInstruction": { | |
| "type": "object", | |
| "properties": { | |
| "rooms": { | |
| "$ref": "#/definitions/InstructionPredsAndSchemasRooms" | |
| }, | |
| "features": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "create-date": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "land-area": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "published?": { | |
| "type": "boolean" | |
| }, | |
| "address": { | |
| "$ref": "#/definitions/InstructionPredsAndSchemasAddress" | |
| }, | |
| "parking-spaces": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "permit", | |
| "off-street", | |
| "driveway", | |
| "communal", | |
| "private", | |
| "residents", | |
| "gated", | |
| "garage", | |
| "on-street", | |
| "rear", | |
| "allocated", | |
| "covered" | |
| ] | |
| } | |
| }, | |
| "furnishings": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "washing-machine", | |
| "dishwasher", | |
| "burglar-alarm" | |
| ] | |
| } | |
| }, | |
| "update-date": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "feature-tags": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "driveway", | |
| "garden", | |
| "coastal", | |
| "parking" | |
| ] | |
| } | |
| }, | |
| "student?": { | |
| "type": "boolean" | |
| }, | |
| "business-for-sale?": { | |
| "type": "boolean" | |
| }, | |
| "accessibility": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "ramped-access", | |
| "wide-doorways", | |
| "level-access", | |
| "lift-access", | |
| "wet-room", | |
| "not-suitable-for-wheelchairs" | |
| ] | |
| } | |
| }, | |
| "exclusivity-expiry": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "date-available": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "furnished-type": { | |
| "type": "string", | |
| "enum": [ | |
| "part-furnished", | |
| "unfurnished", | |
| "not-specified", | |
| "furnished-unfurnished", | |
| "furnished" | |
| ] | |
| }, | |
| "bill-inclusions": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "electricity", | |
| "gas", | |
| "oil", | |
| "tv-licence", | |
| "all", | |
| "internet", | |
| "tv-subscription", | |
| "water", | |
| "council-tax" | |
| ] | |
| } | |
| }, | |
| "land-area-unit": { | |
| "type": "string", | |
| "enum": [ | |
| "sq-ft", | |
| "acres", | |
| "sq-ms", | |
| "hectares" | |
| ] | |
| }, | |
| "internal-area-unit": { | |
| "type": "string", | |
| "enum": [ | |
| "sq-ft", | |
| "acres", | |
| "sq-ms", | |
| "hectares" | |
| ] | |
| }, | |
| "property-sub-type": { | |
| "type": "string", | |
| "enum": [ | |
| "warehouse", | |
| "convenience-store", | |
| "business-park", | |
| "plot", | |
| "guest-house", | |
| "stone-house", | |
| "finca", | |
| "stately-home", | |
| "off-plan", | |
| "healthcare-facility", | |
| "retail-property-out-of-town", | |
| "sheltered-housing", | |
| "residential-development", | |
| "science-park", | |
| "cluster-house", | |
| "retirement-property", | |
| "hospitality", | |
| "ground-maisonette", | |
| "heavy-industrial", | |
| "hotel-room", | |
| "character-property", | |
| "mobile-home", | |
| "barn", | |
| "commercial-property", | |
| "light-industrial", | |
| "not-specified", | |
| "ruins", | |
| "distribution-warehouse", | |
| "detached-bungalow", | |
| "triplex", | |
| "country-house", | |
| "longere", | |
| "hairdresser-and-barber-shop", | |
| "end-of-terrace", | |
| "shop", | |
| "workshop-and-retail-space", | |
| "childcare-facility", | |
| "mews", | |
| "manor-house", | |
| "research-and-development-facility", | |
| "detached", | |
| "house-boat", | |
| "log-cabin", | |
| "lodge", | |
| "cortijo", | |
| "marine-property", | |
| "cottage", | |
| "garage", | |
| "maisonette", | |
| "private-halls", | |
| "terraced", | |
| "farm-land", | |
| "trulli", | |
| "park-home", | |
| "block-of-apartments", | |
| "smallholding", | |
| "ground-flat", | |
| "house-share", | |
| "place-of-worship", | |
| "studio", | |
| "semi-detached", | |
| "village-house", | |
| "takeaway", | |
| "mill", | |
| "hotel", | |
| "data-centre", | |
| "detached-villa", | |
| "office", | |
| "restaurant", | |
| "parking", | |
| "flat-share", | |
| "factory", | |
| "semi-detached-bungalow", | |
| "serviced-office", | |
| "trade-counter", | |
| "showroom", | |
| "penthouse", | |
| "riad", | |
| "petrol-station", | |
| "duplex", | |
| "villa", | |
| "terraced-bungalow", | |
| "equestrian-facility", | |
| "land", | |
| "post-office", | |
| "bungalow", | |
| "flat", | |
| "leisure-facility", | |
| "bar-and-nightclub", | |
| "commercial-development", | |
| "apartment", | |
| "gite", | |
| "storage", | |
| "farm-house", | |
| "cafe", | |
| "house", | |
| "cave-house", | |
| "chalet", | |
| "coach-house", | |
| "barn-conversion", | |
| "caravan", | |
| "link-detached-house", | |
| "pub", | |
| "serviced-apartments", | |
| "industrial-park", | |
| "town-house", | |
| "semi-detached-villa", | |
| "garages", | |
| "industrial-development", | |
| "retail-property-high-street", | |
| "farm", | |
| "castle", | |
| "mixed-use" | |
| ] | |
| }, | |
| "internal-area": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "tenant-considerations": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "sharers", | |
| "housing-benefit", | |
| "smokers", | |
| "pets" | |
| ] | |
| } | |
| }, | |
| "pov": { | |
| "$ref": "#/definitions/InstructionPredsAndSchemasPov" | |
| }, | |
| "year-built": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "let-type": { | |
| "type": "string", | |
| "enum": [ | |
| "commercial", | |
| "long-term", | |
| "not-specified", | |
| "short-term" | |
| ] | |
| }, | |
| "outside-space": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "communal-garden", | |
| "front-garden", | |
| "back-garden", | |
| "enclosed-garden", | |
| "patio", | |
| "private-garden", | |
| "terrace" | |
| ] | |
| } | |
| }, | |
| "contract-in-months": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "price-information": { | |
| "$ref": "#/definitions/InstructionPredsAndSchemasPriceInformation" | |
| }, | |
| "commercial-use-classes": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "C1", | |
| "sui_generis_1", | |
| "C2", | |
| "C3", | |
| "A2", | |
| "B1", | |
| "A5", | |
| "sui_generis_2", | |
| "A3", | |
| "C2A", | |
| "B2", | |
| "D2", | |
| "B8", | |
| "D1", | |
| "A1", | |
| "A4" | |
| ] | |
| } | |
| }, | |
| "status": { | |
| "type": "string", | |
| "enum": [ | |
| "let", | |
| "sstcm", | |
| "sold", | |
| "under-offer", | |
| "let-agreed", | |
| "sstc", | |
| "reserved", | |
| "available" | |
| ] | |
| }, | |
| "condition": { | |
| "type": "string", | |
| "enum": [ | |
| "some-work-needed", | |
| "good", | |
| "work-required-throughout", | |
| "major-renovation-required" | |
| ] | |
| }, | |
| "floors": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "new-home?": { | |
| "type": "boolean" | |
| }, | |
| "transaction-type": { | |
| "type": "string" | |
| }, | |
| "principal": { | |
| "$ref": "#/definitions/InstructionPredsAndSchemasPrincipal" | |
| }, | |
| "entrance-floor": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "exclusive?": { | |
| "type": "boolean" | |
| }, | |
| "location": { | |
| "$ref": "#/definitions/InstructionPredsAndSchemasLocation" | |
| }, | |
| "media": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/InstructionPredsAndSchemasMedia" | |
| } | |
| }, | |
| "price-per-unit": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "agent-ref": { | |
| "type": "string" | |
| }, | |
| "heating": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "air-conditioning", | |
| "solar", | |
| "night-storage", | |
| "gas", | |
| "oil", | |
| "double-glazing", | |
| "electric", | |
| "central-heating", | |
| "under-floor", | |
| "solar-water", | |
| "eco-friendly" | |
| ] | |
| } | |
| } | |
| }, | |
| "required": [ | |
| "rooms", | |
| "published?", | |
| "address", | |
| "feature-tags", | |
| "student?", | |
| "furnished-type", | |
| "property-sub-type", | |
| "let-type", | |
| "price-information", | |
| "status", | |
| "new-home?", | |
| "transaction-type", | |
| "media", | |
| "agent-ref" | |
| ] | |
| }, | |
| "DomesticSalesInstruction": { | |
| "type": "object", | |
| "properties": { | |
| "rooms": { | |
| "$ref": "#/definitions/InstructionPredsAndSchemasRooms" | |
| }, | |
| "features": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "create-date": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "land-area": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "published?": { | |
| "type": "boolean" | |
| }, | |
| "address": { | |
| "$ref": "#/definitions/InstructionPredsAndSchemasAddress" | |
| }, | |
| "parking-spaces": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "permit", | |
| "off-street", | |
| "driveway", | |
| "communal", | |
| "private", | |
| "residents", | |
| "gated", | |
| "garage", | |
| "on-street", | |
| "rear", | |
| "allocated", | |
| "covered" | |
| ] | |
| } | |
| }, | |
| "tenure-unexpired-years": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "update-date": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "feature-tags": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "driveway", | |
| "garden", | |
| "coastal", | |
| "parking" | |
| ] | |
| } | |
| }, | |
| "business-for-sale?": { | |
| "type": "boolean" | |
| }, | |
| "accessibility": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "ramped-access", | |
| "wide-doorways", | |
| "level-access", | |
| "lift-access", | |
| "wet-room", | |
| "not-suitable-for-wheelchairs" | |
| ] | |
| } | |
| }, | |
| "exclusivity-expiry": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "land-area-unit": { | |
| "type": "string", | |
| "enum": [ | |
| "sq-ft", | |
| "acres", | |
| "sq-ms", | |
| "hectares" | |
| ] | |
| }, | |
| "internal-area-unit": { | |
| "type": "string", | |
| "enum": [ | |
| "sq-ft", | |
| "acres", | |
| "sq-ms", | |
| "hectares" | |
| ] | |
| }, | |
| "property-sub-type": { | |
| "type": "string", | |
| "enum": [ | |
| "warehouse", | |
| "convenience-store", | |
| "business-park", | |
| "plot", | |
| "guest-house", | |
| "stone-house", | |
| "finca", | |
| "stately-home", | |
| "off-plan", | |
| "healthcare-facility", | |
| "retail-property-out-of-town", | |
| "sheltered-housing", | |
| "residential-development", | |
| "science-park", | |
| "cluster-house", | |
| "retirement-property", | |
| "hospitality", | |
| "ground-maisonette", | |
| "heavy-industrial", | |
| "hotel-room", | |
| "character-property", | |
| "mobile-home", | |
| "barn", | |
| "commercial-property", | |
| "light-industrial", | |
| "not-specified", | |
| "ruins", | |
| "distribution-warehouse", | |
| "detached-bungalow", | |
| "triplex", | |
| "country-house", | |
| "longere", | |
| "hairdresser-and-barber-shop", | |
| "end-of-terrace", | |
| "shop", | |
| "workshop-and-retail-space", | |
| "childcare-facility", | |
| "mews", | |
| "manor-house", | |
| "research-and-development-facility", | |
| "detached", | |
| "house-boat", | |
| "log-cabin", | |
| "lodge", | |
| "cortijo", | |
| "marine-property", | |
| "cottage", | |
| "garage", | |
| "maisonette", | |
| "private-halls", | |
| "terraced", | |
| "farm-land", | |
| "trulli", | |
| "park-home", | |
| "block-of-apartments", | |
| "smallholding", | |
| "ground-flat", | |
| "house-share", | |
| "place-of-worship", | |
| "studio", | |
| "semi-detached", | |
| "village-house", | |
| "takeaway", | |
| "mill", | |
| "hotel", | |
| "data-centre", | |
| "detached-villa", | |
| "office", | |
| "restaurant", | |
| "parking", | |
| "flat-share", | |
| "factory", | |
| "semi-detached-bungalow", | |
| "serviced-office", | |
| "trade-counter", | |
| "showroom", | |
| "penthouse", | |
| "riad", | |
| "petrol-station", | |
| "duplex", | |
| "villa", | |
| "terraced-bungalow", | |
| "equestrian-facility", | |
| "land", | |
| "post-office", | |
| "bungalow", | |
| "flat", | |
| "leisure-facility", | |
| "bar-and-nightclub", | |
| "commercial-development", | |
| "apartment", | |
| "gite", | |
| "storage", | |
| "farm-house", | |
| "cafe", | |
| "house", | |
| "cave-house", | |
| "chalet", | |
| "coach-house", | |
| "barn-conversion", | |
| "caravan", | |
| "link-detached-house", | |
| "pub", | |
| "serviced-apartments", | |
| "industrial-park", | |
| "town-house", | |
| "semi-detached-villa", | |
| "garages", | |
| "industrial-development", | |
| "retail-property-high-street", | |
| "farm", | |
| "castle", | |
| "mixed-use" | |
| ] | |
| }, | |
| "internal-area": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "pov": { | |
| "$ref": "#/definitions/InstructionPredsAndSchemasPov" | |
| }, | |
| "year-built": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "outside-space": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "communal-garden", | |
| "front-garden", | |
| "back-garden", | |
| "enclosed-garden", | |
| "patio", | |
| "private-garden", | |
| "terrace" | |
| ] | |
| } | |
| }, | |
| "price-information": { | |
| "$ref": "#/definitions/InstructionPredsAndSchemasPriceInformation" | |
| }, | |
| "commercial-use-classes": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "C1", | |
| "sui_generis_1", | |
| "C2", | |
| "C3", | |
| "A2", | |
| "B1", | |
| "A5", | |
| "sui_generis_2", | |
| "A3", | |
| "C2A", | |
| "B2", | |
| "D2", | |
| "B8", | |
| "D1", | |
| "A1", | |
| "A4" | |
| ] | |
| } | |
| }, | |
| "status": { | |
| "type": "string", | |
| "enum": [ | |
| "let", | |
| "sstcm", | |
| "sold", | |
| "under-offer", | |
| "let-agreed", | |
| "sstc", | |
| "reserved", | |
| "available" | |
| ] | |
| }, | |
| "condition": { | |
| "type": "string", | |
| "enum": [ | |
| "some-work-needed", | |
| "good", | |
| "work-required-throughout", | |
| "major-renovation-required" | |
| ] | |
| }, | |
| "tenure-type": { | |
| "type": "string", | |
| "enum": [ | |
| "share-of-freehold", | |
| "freehold", | |
| "leasehold", | |
| "feudal", | |
| "commonhold" | |
| ] | |
| }, | |
| "floors": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "new-home?": { | |
| "type": "boolean" | |
| }, | |
| "transaction-type": { | |
| "type": "string" | |
| }, | |
| "principal": { | |
| "$ref": "#/definitions/InstructionPredsAndSchemasPrincipal" | |
| }, | |
| "entrance-floor": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "exclusive?": { | |
| "type": "boolean" | |
| }, | |
| "location": { | |
| "$ref": "#/definitions/InstructionPredsAndSchemasLocation" | |
| }, | |
| "media": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/InstructionPredsAndSchemasMedia" | |
| } | |
| }, | |
| "price-per-unit": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "agent-ref": { | |
| "type": "string" | |
| }, | |
| "heating": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "air-conditioning", | |
| "solar", | |
| "night-storage", | |
| "gas", | |
| "oil", | |
| "double-glazing", | |
| "electric", | |
| "central-heating", | |
| "under-floor", | |
| "solar-water", | |
| "eco-friendly" | |
| ] | |
| } | |
| } | |
| }, | |
| "required": [ | |
| "rooms", | |
| "published?", | |
| "address", | |
| "feature-tags", | |
| "property-sub-type", | |
| "price-information", | |
| "status", | |
| "new-home?", | |
| "transaction-type", | |
| "media", | |
| "agent-ref" | |
| ] | |
| }, | |
| "InstructionPredsAndSchemasAddress": { | |
| "type": "object" | |
| }, | |
| "InstructionPredsAndSchemasLocation": { | |
| "type": "object", | |
| "properties": { | |
| "lat": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "lon": { | |
| "type": "number", | |
| "format": "double" | |
| } | |
| }, | |
| "required": [ | |
| "lat", | |
| "lon" | |
| ] | |
| }, | |
| "InstructionPredsAndSchemasMedia": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "audio-tour", | |
| "floor-plan", | |
| "epc", | |
| "virtual-tour", | |
| "document", | |
| "image", | |
| "epc-graph" | |
| ] | |
| }, | |
| "source-url": { | |
| "type": "string" | |
| }, | |
| "caption": { | |
| "type": "string" | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "last-updated": { | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| }, | |
| "required": [ | |
| "type", | |
| "source-url" | |
| ] | |
| }, | |
| "InstructionPredsAndSchemasPov": { | |
| "type": "object", | |
| "properties": { | |
| "disabled": { | |
| "type": "boolean" | |
| }, | |
| "lat": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "lon": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "pitch": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "heading": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "zoom": { | |
| "type": "number", | |
| "format": "double" | |
| } | |
| } | |
| }, | |
| "InstructionPredsAndSchemasPriceInformation": { | |
| "type": "object", | |
| "properties": { | |
| "price": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "price-qualifier": { | |
| "type": "string", | |
| "enum": [ | |
| "shared-ownership", | |
| "fixed-price", | |
| "default", | |
| "poa", | |
| "from", | |
| "part-buy-part-rent", | |
| "guide-price", | |
| "shared-equity", | |
| "sale-by-tender", | |
| "offers-in-excess-of", | |
| "equity-loan", | |
| "offers-over", | |
| "offers-in-region-of", | |
| "offers-invited" | |
| ] | |
| }, | |
| "auction?": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "required": [ | |
| "price", | |
| "price-qualifier" | |
| ] | |
| }, | |
| "InstructionPredsAndSchemasPrincipal": { | |
| "type": "object", | |
| "properties": { | |
| "principal-email": { | |
| "type": "string" | |
| }, | |
| "email-on-go-live?": { | |
| "type": "boolean" | |
| }, | |
| "email-on-updates?": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "required": [ | |
| "principal-email", | |
| "email-on-go-live?", | |
| "email-on-updates?" | |
| ] | |
| }, | |
| "InstructionPredsAndSchemasRooms": { | |
| "type": "object", | |
| "properties": { | |
| "bedrooms": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "bathrooms": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "reception-rooms": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "descriptions": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/InstructionPredsAndSchemasRoomsDescriptions" | |
| } | |
| } | |
| }, | |
| "required": [ | |
| "bedrooms" | |
| ] | |
| }, | |
| "InstructionPredsAndSchemasRoomsDescriptions": { | |
| "type": "object", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "length": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "width": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "dimension-unit": { | |
| "type": "string", | |
| "enum": [ | |
| "mm", | |
| "m", | |
| "cm", | |
| "ft", | |
| "in" | |
| ] | |
| }, | |
| "photo-urls": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "required": [ | |
| "name", | |
| "description", | |
| "length", | |
| "width", | |
| "dimension-unit", | |
| "photo-urls" | |
| ] | |
| }, | |
| "OverseasLettingsInstruction": { | |
| "type": "object", | |
| "properties": { | |
| "rooms": { | |
| "$ref": "#/definitions/InstructionPredsAndSchemasRooms" | |
| }, | |
| "features": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "create-date": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "land-area": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "published?": { | |
| "type": "boolean" | |
| }, | |
| "address": { | |
| "$ref": "#/definitions/InstructionPredsAndSchemasAddress" | |
| }, | |
| "parking-spaces": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "permit", | |
| "off-street", | |
| "driveway", | |
| "communal", | |
| "private", | |
| "residents", | |
| "gated", | |
| "garage", | |
| "on-street", | |
| "rear", | |
| "allocated", | |
| "covered" | |
| ] | |
| } | |
| }, | |
| "furnishings": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "washing-machine", | |
| "dishwasher", | |
| "burglar-alarm" | |
| ] | |
| } | |
| }, | |
| "update-date": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "feature-tags": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "driveway", | |
| "garden", | |
| "coastal", | |
| "parking" | |
| ] | |
| } | |
| }, | |
| "student?": { | |
| "type": "boolean" | |
| }, | |
| "business-for-sale?": { | |
| "type": "boolean" | |
| }, | |
| "accessibility": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "ramped-access", | |
| "wide-doorways", | |
| "level-access", | |
| "lift-access", | |
| "wet-room", | |
| "not-suitable-for-wheelchairs" | |
| ] | |
| } | |
| }, | |
| "exclusivity-expiry": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "date-available": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "furnished-type": { | |
| "type": "string", | |
| "enum": [ | |
| "part-furnished", | |
| "unfurnished", | |
| "not-specified", | |
| "furnished-unfurnished", | |
| "furnished" | |
| ] | |
| }, | |
| "bill-inclusions": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "electricity", | |
| "gas", | |
| "oil", | |
| "tv-licence", | |
| "all", | |
| "internet", | |
| "tv-subscription", | |
| "water", | |
| "council-tax" | |
| ] | |
| } | |
| }, | |
| "land-area-unit": { | |
| "type": "string", | |
| "enum": [ | |
| "sq-ft", | |
| "acres", | |
| "sq-ms", | |
| "hectares" | |
| ] | |
| }, | |
| "internal-area-unit": { | |
| "type": "string", | |
| "enum": [ | |
| "sq-ft", | |
| "acres", | |
| "sq-ms", | |
| "hectares" | |
| ] | |
| }, | |
| "property-sub-type": { | |
| "type": "string", | |
| "enum": [ | |
| "warehouse", | |
| "convenience-store", | |
| "business-park", | |
| "plot", | |
| "guest-house", | |
| "stone-house", | |
| "finca", | |
| "stately-home", | |
| "off-plan", | |
| "healthcare-facility", | |
| "retail-property-out-of-town", | |
| "sheltered-housing", | |
| "residential-development", | |
| "science-park", | |
| "cluster-house", | |
| "retirement-property", | |
| "hospitality", | |
| "ground-maisonette", | |
| "heavy-industrial", | |
| "hotel-room", | |
| "character-property", | |
| "mobile-home", | |
| "barn", | |
| "commercial-property", | |
| "light-industrial", | |
| "not-specified", | |
| "ruins", | |
| "distribution-warehouse", | |
| "detached-bungalow", | |
| "triplex", | |
| "country-house", | |
| "longere", | |
| "hairdresser-and-barber-shop", | |
| "end-of-terrace", | |
| "shop", | |
| "workshop-and-retail-space", | |
| "childcare-facility", | |
| "mews", | |
| "manor-house", | |
| "research-and-development-facility", | |
| "detached", | |
| "house-boat", | |
| "log-cabin", | |
| "lodge", | |
| "cortijo", | |
| "marine-property", | |
| "cottage", | |
| "garage", | |
| "maisonette", | |
| "private-halls", | |
| "terraced", | |
| "farm-land", | |
| "trulli", | |
| "park-home", | |
| "block-of-apartments", | |
| "smallholding", | |
| "ground-flat", | |
| "house-share", | |
| "place-of-worship", | |
| "studio", | |
| "semi-detached", | |
| "village-house", | |
| "takeaway", | |
| "mill", | |
| "hotel", | |
| "data-centre", | |
| "detached-villa", | |
| "office", | |
| "restaurant", | |
| "parking", | |
| "flat-share", | |
| "factory", | |
| "semi-detached-bungalow", | |
| "serviced-office", | |
| "trade-counter", | |
| "showroom", | |
| "penthouse", | |
| "riad", | |
| "petrol-station", | |
| "duplex", | |
| "villa", | |
| "terraced-bungalow", | |
| "equestrian-facility", | |
| "land", | |
| "post-office", | |
| "bungalow", | |
| "flat", | |
| "leisure-facility", | |
| "bar-and-nightclub", | |
| "commercial-development", | |
| "apartment", | |
| "gite", | |
| "storage", | |
| "farm-house", | |
| "cafe", | |
| "house", | |
| "cave-house", | |
| "chalet", | |
| "coach-house", | |
| "barn-conversion", | |
| "caravan", | |
| "link-detached-house", | |
| "pub", | |
| "serviced-apartments", | |
| "industrial-park", | |
| "town-house", | |
| "semi-detached-villa", | |
| "garages", | |
| "industrial-development", | |
| "retail-property-high-street", | |
| "farm", | |
| "castle", | |
| "mixed-use" | |
| ] | |
| }, | |
| "internal-area": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "tenant-considerations": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "sharers", | |
| "housing-benefit", | |
| "smokers", | |
| "pets" | |
| ] | |
| } | |
| }, | |
| "pov": { | |
| "$ref": "#/definitions/InstructionPredsAndSchemasPov" | |
| }, | |
| "year-built": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "let-type": { | |
| "type": "string", | |
| "enum": [ | |
| "commercial", | |
| "long-term", | |
| "not-specified", | |
| "short-term" | |
| ] | |
| }, | |
| "outside-space": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "communal-garden", | |
| "front-garden", | |
| "back-garden", | |
| "enclosed-garden", | |
| "patio", | |
| "private-garden", | |
| "terrace" | |
| ] | |
| } | |
| }, | |
| "contract-in-months": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "price-information": { | |
| "$ref": "#/definitions/InstructionPredsAndSchemasPriceInformation" | |
| }, | |
| "commercial-use-classes": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "C1", | |
| "sui_generis_1", | |
| "C2", | |
| "C3", | |
| "A2", | |
| "B1", | |
| "A5", | |
| "sui_generis_2", | |
| "A3", | |
| "C2A", | |
| "B2", | |
| "D2", | |
| "B8", | |
| "D1", | |
| "A1", | |
| "A4" | |
| ] | |
| } | |
| }, | |
| "status": { | |
| "type": "string", | |
| "enum": [ | |
| "let", | |
| "sstcm", | |
| "sold", | |
| "under-offer", | |
| "let-agreed", | |
| "sstc", | |
| "reserved", | |
| "available" | |
| ] | |
| }, | |
| "condition": { | |
| "type": "string", | |
| "enum": [ | |
| "some-work-needed", | |
| "good", | |
| "work-required-throughout", | |
| "major-renovation-required" | |
| ] | |
| }, | |
| "floors": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "new-home?": { | |
| "type": "boolean" | |
| }, | |
| "transaction-type": { | |
| "type": "string" | |
| }, | |
| "principal": { | |
| "$ref": "#/definitions/InstructionPredsAndSchemasPrincipal" | |
| }, | |
| "entrance-floor": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "exclusive?": { | |
| "type": "boolean" | |
| }, | |
| "location": { | |
| "$ref": "#/definitions/InstructionPredsAndSchemasLocation" | |
| }, | |
| "media": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/InstructionPredsAndSchemasMedia" | |
| } | |
| }, | |
| "price-per-unit": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "agent-ref": { | |
| "type": "string" | |
| }, | |
| "heating": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "air-conditioning", | |
| "solar", | |
| "night-storage", | |
| "gas", | |
| "oil", | |
| "double-glazing", | |
| "electric", | |
| "central-heating", | |
| "under-floor", | |
| "solar-water", | |
| "eco-friendly" | |
| ] | |
| } | |
| } | |
| }, | |
| "required": [ | |
| "rooms", | |
| "published?", | |
| "address", | |
| "feature-tags", | |
| "student?", | |
| "furnished-type", | |
| "property-sub-type", | |
| "let-type", | |
| "price-information", | |
| "status", | |
| "new-home?", | |
| "transaction-type", | |
| "media", | |
| "agent-ref" | |
| ] | |
| }, | |
| "OverseasSalesInstruction": { | |
| "type": "object", | |
| "properties": { | |
| "rooms": { | |
| "$ref": "#/definitions/InstructionPredsAndSchemasRooms" | |
| }, | |
| "features": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "create-date": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "land-area": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "published?": { | |
| "type": "boolean" | |
| }, | |
| "address": { | |
| "$ref": "#/definitions/InstructionPredsAndSchemasAddress" | |
| }, | |
| "parking-spaces": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "permit", | |
| "off-street", | |
| "driveway", | |
| "communal", | |
| "private", | |
| "residents", | |
| "gated", | |
| "garage", | |
| "on-street", | |
| "rear", | |
| "allocated", | |
| "covered" | |
| ] | |
| } | |
| }, | |
| "tenure-unexpired-years": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "update-date": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "feature-tags": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "driveway", | |
| "garden", | |
| "coastal", | |
| "parking" | |
| ] | |
| } | |
| }, | |
| "business-for-sale?": { | |
| "type": "boolean" | |
| }, | |
| "accessibility": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "ramped-access", | |
| "wide-doorways", | |
| "level-access", | |
| "lift-access", | |
| "wet-room", | |
| "not-suitable-for-wheelchairs" | |
| ] | |
| } | |
| }, | |
| "exclusivity-expiry": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "land-area-unit": { | |
| "type": "string", | |
| "enum": [ | |
| "sq-ft", | |
| "acres", | |
| "sq-ms", | |
| "hectares" | |
| ] | |
| }, | |
| "internal-area-unit": { | |
| "type": "string", | |
| "enum": [ | |
| "sq-ft", | |
| "acres", | |
| "sq-ms", | |
| "hectares" | |
| ] | |
| }, | |
| "property-sub-type": { | |
| "type": "string", | |
| "enum": [ | |
| "warehouse", | |
| "convenience-store", | |
| "business-park", | |
| "plot", | |
| "guest-house", | |
| "stone-house", | |
| "finca", | |
| "stately-home", | |
| "off-plan", | |
| "healthcare-facility", | |
| "retail-property-out-of-town", | |
| "sheltered-housing", | |
| "residential-development", | |
| "science-park", | |
| "cluster-house", | |
| "retirement-property", | |
| "hospitality", | |
| "ground-maisonette", | |
| "heavy-industrial", | |
| "hotel-room", | |
| "character-property", | |
| "mobile-home", | |
| "barn", | |
| "commercial-property", | |
| "light-industrial", | |
| "not-specified", | |
| "ruins", | |
| "distribution-warehouse", | |
| "detached-bungalow", | |
| "triplex", | |
| "country-house", | |
| "longere", | |
| "hairdresser-and-barber-shop", | |
| "end-of-terrace", | |
| "shop", | |
| "workshop-and-retail-space", | |
| "childcare-facility", | |
| "mews", | |
| "manor-house", | |
| "research-and-development-facility", | |
| "detached", | |
| "house-boat", | |
| "log-cabin", | |
| "lodge", | |
| "cortijo", | |
| "marine-property", | |
| "cottage", | |
| "garage", | |
| "maisonette", | |
| "private-halls", | |
| "terraced", | |
| "farm-land", | |
| "trulli", | |
| "park-home", | |
| "block-of-apartments", | |
| "smallholding", | |
| "ground-flat", | |
| "house-share", | |
| "place-of-worship", | |
| "studio", | |
| "semi-detached", | |
| "village-house", | |
| "takeaway", | |
| "mill", | |
| "hotel", | |
| "data-centre", | |
| "detached-villa", | |
| "office", | |
| "restaurant", | |
| "parking", | |
| "flat-share", | |
| "factory", | |
| "semi-detached-bungalow", | |
| "serviced-office", | |
| "trade-counter", | |
| "showroom", | |
| "penthouse", | |
| "riad", | |
| "petrol-station", | |
| "duplex", | |
| "villa", | |
| "terraced-bungalow", | |
| "equestrian-facility", | |
| "land", | |
| "post-office", | |
| "bungalow", | |
| "flat", | |
| "leisure-facility", | |
| "bar-and-nightclub", | |
| "commercial-development", | |
| "apartment", | |
| "gite", | |
| "storage", | |
| "farm-house", | |
| "cafe", | |
| "house", | |
| "cave-house", | |
| "chalet", | |
| "coach-house", | |
| "barn-conversion", | |
| "caravan", | |
| "link-detached-house", | |
| "pub", | |
| "serviced-apartments", | |
| "industrial-park", | |
| "town-house", | |
| "semi-detached-villa", | |
| "garages", | |
| "industrial-development", | |
| "retail-property-high-street", | |
| "farm", | |
| "castle", | |
| "mixed-use" | |
| ] | |
| }, | |
| "internal-area": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "pov": { | |
| "$ref": "#/definitions/InstructionPredsAndSchemasPov" | |
| }, | |
| "year-built": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "outside-space": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "communal-garden", | |
| "front-garden", | |
| "back-garden", | |
| "enclosed-garden", | |
| "patio", | |
| "private-garden", | |
| "terrace" | |
| ] | |
| } | |
| }, | |
| "price-information": { | |
| "$ref": "#/definitions/InstructionPredsAndSchemasPriceInformation" | |
| }, | |
| "commercial-use-classes": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "C1", | |
| "sui_generis_1", | |
| "C2", | |
| "C3", | |
| "A2", | |
| "B1", | |
| "A5", | |
| "sui_generis_2", | |
| "A3", | |
| "C2A", | |
| "B2", | |
| "D2", | |
| "B8", | |
| "D1", | |
| "A1", | |
| "A4" | |
| ] | |
| } | |
| }, | |
| "status": { | |
| "type": "string", | |
| "enum": [ | |
| "let", | |
| "sstcm", | |
| "sold", | |
| "under-offer", | |
| "let-agreed", | |
| "sstc", | |
| "reserved", | |
| "available" | |
| ] | |
| }, | |
| "condition": { | |
| "type": "string", | |
| "enum": [ | |
| "some-work-needed", | |
| "good", | |
| "work-required-throughout", | |
| "major-renovation-required" | |
| ] | |
| }, | |
| "tenure-type": { | |
| "type": "string", | |
| "enum": [ | |
| "share-of-freehold", | |
| "freehold", | |
| "leasehold", | |
| "feudal", | |
| "commonhold" | |
| ] | |
| }, | |
| "floors": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "new-home?": { | |
| "type": "boolean" | |
| }, | |
| "transaction-type": { | |
| "type": "string" | |
| }, | |
| "principal": { | |
| "$ref": "#/definitions/InstructionPredsAndSchemasPrincipal" | |
| }, | |
| "entrance-floor": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "exclusive?": { | |
| "type": "boolean" | |
| }, | |
| "location": { | |
| "$ref": "#/definitions/InstructionPredsAndSchemasLocation" | |
| }, | |
| "media": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/InstructionPredsAndSchemasMedia" | |
| } | |
| }, | |
| "price-per-unit": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "agent-ref": { | |
| "type": "string" | |
| }, | |
| "heating": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "air-conditioning", | |
| "solar", | |
| "night-storage", | |
| "gas", | |
| "oil", | |
| "double-glazing", | |
| "electric", | |
| "central-heating", | |
| "under-floor", | |
| "solar-water", | |
| "eco-friendly" | |
| ] | |
| } | |
| } | |
| }, | |
| "required": [ | |
| "rooms", | |
| "published?", | |
| "address", | |
| "feature-tags", | |
| "property-sub-type", | |
| "price-information", | |
| "status", | |
| "new-home?", | |
| "transaction-type", | |
| "media", | |
| "agent-ref" | |
| ] | |
| }, | |
| "Response33840": { | |
| "type": "object" | |
| } | |
| } | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment