{"swagger":"2.0","info":{"version":"v4-advertising","title":"agentOS Api V4, Advertising Call Group"},"host":"live-api.letmc.com","schemes":["https"],"paths":{"/v4/advertising/{shortName}/company/areas/{areaID}":{"get":{"tags":["CompanyController"],"summary":"Get a specific area given its unique Object ID(OID)","operationId":"CompanyController_GetArea","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"areaID","in":"path","description":"The unique ID of the Area","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AdvertisingAreaModel"}}}}},"/v4/advertising/{shortName}/company/areas/{offset}/{count}":{"get":{"tags":["CompanyController"],"summary":"A collection of all the areas for a company","operationId":"CompanyController_GetAreas","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"offset","in":"path","description":"The index of the first item to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"path","description":"The maximum number of items to return (up to 1000 per request)","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AdvertisingAreaModelResults"}}}}},"/v4/advertising/{shortName}/company/branches/{branchID}":{"get":{"tags":["CompanyController"],"summary":"Get a specific branch given its unique Object ID (OID)","operationId":"CompanyController_GetBranches","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"branchID","in":"path","description":"The unique ID of the Branch","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BaseBranchModel"}}}}},"/v4/advertising/{shortName}/company/branches/{offset}/{count}":{"get":{"tags":["CompanyController"],"summary":"All branches defined for a company","operationId":"CompanyController_GetBranches","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"offset","in":"path","description":"The index of the first item to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"path","description":"The maximum number of items to return (up to 1000 per request)","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BaseBranchModelResults"}}}}},"/v4/advertising/{shortName}/company/company":{"get":{"tags":["CompanyController"],"summary":"Information about a specific company","operationId":"CompanyController_GetCompany","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BaseCompanyModel"}}}}},"/v4/advertising/{shortName}/company/counties/{countyID}":{"get":{"tags":["CompanyController"],"summary":"Get a specific county given its unique Object ID (OID)","operationId":"CompanyController_GetCounties","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"countyID","in":"path","description":"The unique ID of the County","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AdvertisingCountyModel"}}}}},"/v4/advertising/{shortName}/company/counties/{offset}/{count}":{"get":{"tags":["CompanyController"],"summary":"A collection of all counties available for a company","operationId":"CompanyController_GetCounties","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"offset","in":"path","description":"The index of the first item to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"path","description":"The maximum number of items to return (up to 1000 per request)","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AdvertisingCountyModelResults"}}}}},"/v4/advertising/{shortName}/company/object/{objectID}/customfield":{"get":{"tags":["CompanyController"],"summary":"Get Custom Field by ObjectID:-","operationId":"CompanyController_GetCustomfieldbyID","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"objectID","in":"path","description":"The Unique Object ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BaseCustomField"}}}}},"/v4/advertising/{shortName}/company/objects/{objectID}/{fieldID}/customfield":{"post":{"tags":["CompanyController"],"summary":"Set Custom Field Value:-","operationId":"CompanyController_SetCustomFieldValue","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"objectID","in":"path","description":"The Unique Object ID","required":true,"type":"string"},{"name":"fieldID","in":"path","description":"The Unique Field ID","required":true,"type":"string"},{"name":"value","in":"body","description":"Value to enter (string)","required":true,"schema":{"$ref":"#/definitions/BaseCustomFieldSubmissionModel"}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}},"/v4/advertising/{shortName}/company/objects/{objectID}/{fieldID}/value":{"get":{"tags":["CompanyController"],"summary":"Get Custom Field Value:-","operationId":"CompanyController_GetCustomFieldValue","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"objectID","in":"path","description":"The Unique Object ID","required":true,"type":"string"},{"name":"fieldID","in":"path","description":"The Unique Field ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/v4/advertising/{shortName}/download/{OID}/brochure":{"get":{"tags":["DownloadController"],"summary":"Downloads the brochure relating to the latest advertised rental of a property:-","operationId":"DownloadController_GetBrochureDownload","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"OID","in":"path","description":"The unique ID of the tenancy or sales instruction","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/v4/advertising/{shortName}/download/{OID}/epc/{graphType}":{"get":{"tags":["DownloadController"],"summary":"Downloads EPC graphs for a property or sales instruction:-","operationId":"DownloadController_GetEPCDownload","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"OID","in":"path","description":"ID of property or sales instruction","required":true,"type":"string"},{"name":"graphType","in":"path","description":"The type of EPC form to download (Environmental Impact or Energy Efficiency)","required":true,"type":"string","enum":["EnergyEfficiency","EnvironmentalImpact"]}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/v4/advertising/{shortName}/download/{photoID}":{"get":{"tags":["DownloadController"],"summary":"Downloads the photo of a property given the photo ID:-","operationId":"DownloadController_GetPhotoDownload","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"photoID","in":"path","description":"The unique ID of the photo on the property","required":true,"type":"string"},{"name":"width","in":"query","description":"An optional parameter specifying the image width","required":false,"type":"integer","format":"int32"},{"name":"height","in":"query","description":"An optional parameter specifying the image height","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/v4/advertising/{shortname}/lettings/{propertyID}/portalmedia/{offset}/{count}":{"get":{"tags":["LettingsController"],"summary":"Get Portal Media belonging to a property","operationId":"LettingsController_getPortalMedia","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortname","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"propertyID","in":"path","description":"The unique ID of the Property","required":true,"type":"string"},{"name":"offset","in":"path","description":"The index of the first item to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"path","description":"The maximum number of items to return (up to 1000 per request)","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AdvertisingPortalMediaResults"}}}}},"/v4/advertising/{shortName}/lettings/advertised/{offset}/{count}":{"get":{"tags":["LettingsController"],"summary":"Search for summary of available advertised tenancies","operationId":"LettingsController_SearchLettingsAdvertised","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"branchID","in":"query","description":"The unique ID of the Branch","required":true,"type":"string"},{"name":"offset","in":"path","description":"The index of the first item to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"path","description":"The maximum number of items to return (up to 1000 per request)","required":true,"type":"integer","format":"int32"},{"name":"areaID","in":"query","description":"The unique ID of the Area","required":false,"type":"string"},{"name":"rentMinimum","in":"query","description":"The minimum advertised rent to search for","required":false,"type":"number","format":"double"},{"name":"rentMaximum","in":"query","description":"The maximum advertised rent to search for","required":false,"type":"number","format":"double"},{"name":"maximumTenants","in":"query","description":"The maximum number of tenants a property can accommodate","required":false,"type":"integer","format":"int32"},{"name":"wantSharedProperties","in":"query","description":"Search for shared properties?","required":false,"type":"boolean"},{"name":"wantStudentProperties","in":"query","description":"Search for student properties?","required":false,"type":"boolean"},{"name":"wantRenewalTenancies","in":"query","description":"Include renewal properties in search?","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AdvertisingTenancySummaryModelResults"}}}}},"/v4/advertising/{shortname}/lettings/advertised/{tenancyID}":{"get":{"tags":["LettingsController"],"summary":"Retrieve detailed advertised tenancy model by ID","operationId":"LettingsController_GetTenancyByID","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortname","in":"path","description":"Unique company shortname","required":true,"type":"string"},{"name":"tenancyID","in":"path","description":"ID of tenancy to retrieve","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AdvertisingTenancyModel"}}}}},"/v4/advertising/{shortname}/lettings/properties/{propertyID}":{"get":{"tags":["LettingsController"],"summary":"Retrieve property by ID","operationId":"LettingsController_GetPropertyByID","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortname","in":"path","description":"Unique company shortname","required":true,"type":"string"},{"name":"propertyID","in":"path","description":"ID of property to retrieve","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AdvertisingPropertyModel"}}}}},"/v4/advertising/{shortname}/lettings/properties/{propertyID}/facilities/{offset}/{count}":{"get":{"tags":["LettingsController"],"summary":"Retrieve property facilities by property","operationId":"LettingsController_GetPropertyFacilities","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortname","in":"path","description":"Unique company shortname","required":true,"type":"string"},{"name":"propertyID","in":"path","description":"ID of property","required":true,"type":"string"},{"name":"count","in":"path","description":"The maximum number of items to return (up to 1000 per request)","required":true,"type":"integer","format":"int32"},{"name":"offset","in":"path","description":"The index of the first item to return","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AdvertisingPropertyFacilityModelResults"}}}}},"/v4/advertising/{shortName}/lettings/properties/{propertyID}/photos/{offset}/{count}":{"get":{"tags":["LettingsController"],"summary":"A collection showing all the photos linked to a specific block, property or room","operationId":"LettingsController_GetPropertiesPhotos","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"propertyID","in":"path","description":"The unique ID of the Property","required":true,"type":"string"},{"name":"offset","in":"path","description":"The index of the first item to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"path","description":"The maximum number of items to return (up to 1000 per request)","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AdvertisingPhotoModelResults"}}}}},"/v4/advertising/{shortName}/lettings/properties/{propertyID}/rooms/{offset}/{count}":{"get":{"tags":["LettingsController"],"summary":"A collection of the rooms that belong to this property or block","operationId":"LettingsController_GetPropertiesRooms","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"propertyID","in":"path","description":"The unique ID of the Property","required":true,"type":"string"},{"name":"offset","in":"path","description":"The index of the first item to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"path","description":"The maximum number of items to return (up to 1000 per request)","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AdvertisingPropertyRoomModelResults"}}}}},"/v4/advertising/{shortName}/sales/{salesInstructionID}/portalmedia/{offset}/{count}":{"get":{"tags":["SalesController"],"summary":"Get Portal Media belonging to a property","operationId":"SalesController_getPortalMedia","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"salesInstructionID","in":"path","description":"The unique ID of the Sales Instruction","required":true,"type":"string"},{"name":"offset","in":"path","description":"The index of the first item to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"path","description":"The maximum number of items to return (up to 1000 per request)","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AdvertisingPortalMediaResults"}}}}},"/v4/advertising/{shortName}/sales/advertised/{offset}/{count}":{"get":{"tags":["SalesController"],"summary":"Search and retrieve a summary of all sales properties available given a range of search criteria:-","operationId":"SalesController_GetSalesInstructions","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"branchID","in":"query","description":"The unique ID of the Branch","required":true,"type":"string"},{"name":"offset","in":"path","description":"The index of the first item to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"path","description":"The maximum number of items to return (up to 1000 per request)","required":true,"type":"integer","format":"int32"},{"name":"onlyDevelopement","in":"query","description":"Show only development properties?","required":true,"type":"boolean"},{"name":"onlyInvestements","in":"query","description":"Show only investment properties?","required":true,"type":"boolean"},{"name":"minimumPrice","in":"query","description":"The minimum price to search for","required":false,"type":"number","format":"double"},{"name":"maximumPrice","in":"query","description":"The maximum price to search for","required":false,"type":"number","format":"double"},{"name":"minimumBeds","in":"query","description":"The minimum beds to search for","required":false,"type":"integer","format":"int32"},{"name":"minimumBathrooms","in":"query","description":"The minimum bathrooms to search for","required":false,"type":"integer","format":"int32"},{"name":"minimumEnsuites","in":"query","description":"The minimum ensuite bathrooms to search for","required":false,"type":"integer","format":"int32"},{"name":"minimumToilets","in":"query","description":"The minimum toilets to search for","required":false,"type":"integer","format":"int32"},{"name":"minimumReception","in":"query","description":"The minimum reception rooms to search for","required":false,"type":"integer","format":"int32"},{"name":"state","in":"query","description":"The optional Sales State","required":false,"type":"string","enum":["Advertised","UnderOffer"]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AdvertisingSalesInstructionSummaryModelResults"}}}}},"/v4/advertising/{shortName}/sales/salesfeaturetypes/{offset}/{count}":{"get":{"tags":["SalesController"],"summary":"A collection of all sales feature types linked to a company:-","operationId":"SalesController_GetSalesFeatureTypes","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"offset","in":"path","description":"The index of the first item to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"path","description":"The maximum number of items to return (up to 1000 per request)","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AdvertisingSalesFeatureTypeModelResults"}}}}},"/v4/advertising/{shortName}/sales/salesfeaturetypes/{salesFeatureTypeID}":{"get":{"tags":["SalesController"],"summary":"Get a specific sales feature type given its unique Object ID (OID):-","operationId":"SalesController_GetSalesFeatureTypeByID","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"salesFeatureTypeID","in":"path","description":"The unique ID of the SalesFeatureType","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AdvertisingSalesFeatureTypeModel"}}}}},"/v4/advertising/{shortName}/sales/salesinstructions/{salesInstructionID}":{"get":{"tags":["SalesController"],"summary":"Get a specific sales instruction given its unique Object ID (OID):-","operationId":"SalesController_GetSalesInstructionByID","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"salesInstructionID","in":"path","description":"The unique ID of the SalesInstruction","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AdvertisingSalesInstructionModel"}}}}},"/v4/advertising/{shortName}/sales/salesinstructions/{salesInstructionID}/features/{offset}/{count}":{"get":{"tags":["SalesController"],"summary":"A collection of all features linked to a sales instruction:-","operationId":"SalesController_GetSalesInstructionsFeatures","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"salesInstructionID","in":"path","description":"The unique ID of the SalesInstruction","required":true,"type":"string"},{"name":"offset","in":"path","description":"The index of the first item to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"path","description":"The maximum number of items to return (up to 1000 per request)","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AdvertisingSalesFeatureModelResults"}}}}},"/v4/advertising/{shortName}/sales/salesinstructions/{salesInstructionID}/floorplans/{offset}/{count}":{"get":{"tags":["SalesController"],"summary":"A collection of floor plans linked to an instruction:-","operationId":"SalesController_GetSalesInstructionsFloorPlans","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"salesInstructionID","in":"path","description":"The unique ID of the SalesInstruction","required":true,"type":"string"},{"name":"offset","in":"path","description":"The index of the first item to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"path","description":"The maximum number of items to return (up to 1000 per request)","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AdvertisingPhotoModelResults"}}}}},"/v4/advertising/{shortName}/sales/salesinstructions/{salesInstructionID}/photos/{offset}/{count}":{"get":{"tags":["SalesController"],"summary":"A collection showing all the photos linked to this sales instruction:-","operationId":"SalesController_GetSalesInstructionPhotos","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"salesInstructionID","in":"path","description":"The unique ID of the sales instruction","required":true,"type":"string"},{"name":"offset","in":"path","description":"The index of the first item to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"path","description":"The maximum number of items to return (up to 1000 per request)","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AdvertisingPhotoModelResults"}}}}},"/v4/advertising/{shortName}/sales/salesinstructions/{salesInstructionID}/rooms/{offset}/{count}":{"get":{"tags":["SalesController"],"summary":"A collection of the rooms that belong to this sales instruction:-","operationId":"SalesController_GetSalesInstructionRooms","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"salesInstructionID","in":"path","description":"The unique ID of the sales instruction","required":true,"type":"string"},{"name":"offset","in":"path","description":"The index of the first item to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"path","description":"The maximum number of items to return (up to 1000 per request)","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AdvertisingPropertyRoomModelResults"}}}}}},"definitions":{"AdvertisingAreaModelResults":{"description":"Holds results from a paged query returning AreaModel values","type":"object","properties":{"Data":{"description":"The resulting data returned from the paged query range","type":"array","items":{"$ref":"#/definitions/AdvertisingAreaModel"}},"Count":{"format":"int32","description":"The total number of results available for all pages","type":"integer"},"Links":{"description":"Base hypermedia links","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"AdvertisingAreaModel":{"description":"Stores the information about a single property area.","type":"object","properties":{"OID":{"description":"The unique Object ID (OID).","type":"string"},"ETag":{"description":"A unique identifier defining the object and change revision.","type":"string"},"Name":{"description":"The property area name.","type":"string"},"BranchOID":{"description":"The branch that manages this area.","type":"string"},"ShowOnSites":{"description":"Show the area on sites?","type":"boolean"},"Links":{"description":"Base hypermedia links","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"BaseHypermediaLink":{"description":"Hypermedia Link Class","type":"object","properties":{"Relationship":{"description":"The hypermedia link relationship to current result object.","type":"string"},"Href":{"description":"The hypermedia href","type":"string"},"Method":{"description":"The http method type","type":"string"}}},"AdvertisingCountyModelResults":{"description":"Holds results from a paged query returning CountyModel values","type":"object","properties":{"Data":{"description":"The resulting data returned from the paged query range","type":"array","items":{"$ref":"#/definitions/AdvertisingCountyModel"}},"Count":{"format":"int32","description":"The total number of results available for all pages","type":"integer"},"Links":{"type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"AdvertisingCountyModel":{"description":"Stores the information about a single property County. A County can have a number of areas linked to it.","type":"object","properties":{"OID":{"description":"The unique Object ID (OID).","type":"string"},"ETag":{"description":"A unique identifier defining the object and change revision.","type":"string"},"Name":{"description":"The property county name.","type":"string"},"Links":{"description":"Base hypermedia links","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"BaseBranchModelResults":{"description":"Holds results from a paged query returning BranchModel values","type":"object","properties":{"Data":{"description":"The resulting data returned from the paged query range","type":"array","items":{"$ref":"#/definitions/BaseBranchModel"}},"Count":{"format":"int32","description":"The total number of results available for all pages","type":"integer"},"Links":{"description":"Base Hypermedia Links","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"BaseBranchModel":{"description":"Defines a single branch of a client.","type":"object","properties":{"OID":{"description":"The unique Object ID (OID).","type":"string"},"ETag":{"description":"A unique identifier defining the object and change revision.","type":"string"},"Name":{"description":"The branch name.","type":"string"},"CompanyName":{"description":"The relevant company name, if not the one specified on the branch then the one on company.","type":"string"},"Address1":{"description":"Branch address line 1.","type":"string"},"Address2":{"description":"Branch address line 2.","type":"string"},"Address3":{"description":"Branch address line 3.","type":"string"},"Address4":{"description":"Branch address line 4.","type":"string"},"Postcode":{"description":"Branch address postcode.","type":"string"},"WebAddress":{"description":"Branch web address.","type":"string"},"EMailAddress":{"description":"Branch email address.","type":"string"},"LandPhone":{"description":"Branch land phone number.","type":"string"},"FaxPhone":{"description":"Branch fax phone number.","type":"string"},"County":{"description":"County","type":"string"},"Links":{"description":"Hypermedia links","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"BaseCompanyModel":{"description":"The search code for the ApplicationCompany storage object.","type":"object","properties":{"OID":{"description":"The unique Object ID (OID).","type":"string"},"ETag":{"description":"A unique identifier defining the object and change revision.","type":"string"},"ShortName":{"description":"The unique identifier assigned to the client","type":"string"},"CompanyName":{"description":"Company name","type":"string"},"MarketingCompanyName":{"description":"Company Marketing Name","type":"string"},"CompanyRegistration":{"description":"Company registration number","type":"string"}}},"BaseCustomField":{"type":"object","properties":{"CustomFields":{"description":"Dynamic Custom Field:-","type":"array","items":{"$ref":"#/definitions/CustomFieldDataModel"}}}},"CustomFieldDataModel":{"type":"object","properties":{"ID":{"description":"Field ID:-","type":"string"},"TabName":{"description":"Tab on OS custom field belongs to:-","type":"string"},"GroupName":{"description":"The grouping on OS the custom field belongs to:-","type":"string"},"FieldName":{"description":"Name of the custom field:-","type":"string"},"Retired":{"description":"Is field retired:-","type":"boolean"},"Value":{"description":"Custom Field Value:-","type":"object"}}},"BaseCustomFieldSubmissionModel":{"type":"object","properties":{"customfieldValue":{"description":"Custom Field Value","type":"string"}}},"AdvertisingTenancySummaryModelResults":{"description":"Advertised Tenancy Results Model","type":"object","properties":{"Data":{"description":"Result Data","type":"array","items":{"$ref":"#/definitions/AdvertisingTenancySummaryModel"}},"Count":{"format":"int32","description":"Result Count","type":"integer"},"Links":{"description":"HypermediaLinks","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"AdvertisingTenancySummaryModel":{"description":"Advertising Tenancy Summary Model:-","type":"object","properties":{"OID":{"description":"Tenancy ID:-","type":"string","readOnly":true},"ETag":{"description":"ETag:-","type":"string","readOnly":true},"GlobalReference":{"description":"Global Reference:-","type":"string","readOnly":true},"BranchOID":{"description":"Branch ID of tenancy:-","type":"string","readOnly":true},"AreaOID":{"description":"Area ID:-","type":"string","readOnly":true},"PropertyID":{"description":"Property ID:-","type":"string","readOnly":true},"IsTenancyProposed":{"description":"Is Tenancy proposed?:-","type":"boolean","readOnly":true},"TermStart":{"format":"date-time","description":"Term Start of Tenancy","type":"string","readOnly":true},"RentAdvertised":{"format":"double","description":"Advertised Rent amount:-","type":"number","readOnly":true},"TenantSystemTypes":{"description":"Acceptable Tenant Types:-","type":"array","items":{"enum":["Employed","SelfEmployed","Unemployed","Student","OwnMeans","Retired","Company","Council"],"type":"string"},"readOnly":true},"Furnished":{"description":"Furnishings:-","enum":["Unfurnished","PartFurnished","Furnished"],"type":"string","readOnly":true},"IsShareProperty":{"description":"Is shared property?","type":"boolean","readOnly":true},"IsStudentProperty":{"description":"Is student property?","type":"boolean","readOnly":true},"MaximumTenants":{"format":"int32","description":"Maximum Tenants:-","type":"integer","readOnly":true},"TermMinimum":{"format":"int32","description":"Term Minimum:-","type":"integer","readOnly":true},"Address1":{"description":"Address 1:-","type":"string","readOnly":true},"Address2":{"description":"Address 2:-","type":"string","readOnly":true},"Address3":{"description":"Address 3:-","type":"string","readOnly":true},"Address4":{"description":"Address 4:-","type":"string","readOnly":true},"Postcode":{"description":"Address Postcode:-","type":"string","readOnly":true},"MainPhotoOID":{"description":"Main Photo ID:-","type":"string","readOnly":true},"RentSchedule":{"description":"Rent Schedule:-","enum":["Once","Daily","Weekly","Monthly","Yearly"],"type":"string","readOnly":true},"RentRecurrence":{"format":"int32","description":"Rent Recurrence interval:-","type":"integer","readOnly":true},"TenancyType":{"description":"Tenancy Type:-","type":"string","readOnly":true},"IsShortTermLet":{"description":"is short term let?:-","type":"boolean","readOnly":true},"PoA":{"description":"Price on Application:-","type":"boolean","readOnly":true},"InstructionTermType":{"description":"Instruction Term Type:-","enum":["Days","Weeks","Months","Years"],"type":"string","readOnly":true},"Links":{"description":"Hypermedia Links:-","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"},"readOnly":true}}},"AdvertisingTenancyModel":{"description":"Advertised Tenancy Model","type":"object","properties":{"OID":{"description":"The unique Object ID (OID)","type":"string"},"ETag":{"description":"A unique identifier defining the object and change revision","type":"string"},"GlobalReference":{"description":"The global reference for a tenancy","type":"string"},"BranchOID":{"description":"Branch ID:-","type":"string"},"AreaOID":{"description":"Area ID:-","type":"string"},"PropertyID":{"description":"Property ID:-","type":"string"},"Address1":{"description":"Tenancy address 1","type":"string"},"Address2":{"description":"Tenancy address 2","type":"string"},"Address3":{"description":"Tenancy address 3","type":"string"},"Address4":{"description":"Tenancy address 4","type":"string"},"Postcode":{"description":"Tenancy postcode","type":"string"},"MainPhotoOID":{"description":"ID of the main property photo :-","type":"string"},"RentSchedule":{"description":"Rent Schedule:-","enum":["Once","Daily","Weekly","Monthly","Yearly"],"type":"string","readOnly":true},"RentRecurrence":{"format":"int32","description":"Rent Recurrence:-","type":"integer","readOnly":true},"IsTenancyAdvertised":{"description":"Gets a value indicating whether this tenancy is being advertised. Note\r\nthat this will only return true while the tenancy has a valid advertise\r\ndate. It will not return true in the proposed phase","type":"boolean"},"IsTenancyProposed":{"description":"Is the tenancy a proposed tenancy?","type":"boolean"},"TermStart":{"format":"date-time","description":"The instruction start date.","type":"string"},"ServiceTypeName":{"description":"Service Type Name","type":"string"},"RentAdvertised":{"format":"double","description":"The advertised amount of rent for the property","type":"number"},"AdvertiseFrom":{"format":"date-time","description":"The date to advertise this tenancy from (Required for Training Standards)","type":"string"},"ManageRent":{"description":"Is the rent managed for this tenancy? ('true' = fully managed, 'false' = let only)","type":"boolean"},"BondRequired":{"format":"double","description":"The total bond required (Required for Training Standards)","type":"number"},"TenantSystemTypes":{"description":"The specific tenant type list, or empty if for all types","type":"array","items":{"enum":["Employed","SelfEmployed","Unemployed","Student","OwnMeans","Retired","Company","Council"],"type":"string"}},"Furnished":{"description":"The property furnished type","enum":["Unfurnished","PartFurnished","Furnished"],"type":"string"},"IsShareProperty":{"description":"Is this property a shared property","type":"boolean"},"IsStudentProperty":{"description":"Is this property a student property","type":"boolean"},"MinimumTenants":{"format":"int32","description":"The minimum number of tenants to advertise for","type":"integer"},"MaximumTenants":{"format":"int32","description":"The maximum number of tenants to advertise for","type":"integer"},"TermMinimum":{"format":"int32","description":"The minimum term","type":"integer"},"TermMaximum":{"format":"int32","description":"The minimum term","type":"integer"},"CouncilTaxResponsibility":{"description":"Responsibility of paying Council Tax:-","enum":["Tenant","Landlord"],"type":"string"},"ElectricityResponsibility":{"description":"Responsibility of paying Electricity Bill:-","enum":["Tenant","Landlord"],"type":"string"},"GasResponsibility":{"description":"Responsibility of paying Gas Bill:-","enum":["Tenant","Landlord"],"type":"string"},"TelephoneResponsibility":{"description":"Responsibility of paying Phone Bill:-","enum":["Tenant","Landlord"],"type":"string"},"BroadbandResponsibility":{"description":"Responsibility of Paying for Broadband Bill:-","enum":["Tenant","Landlord"],"type":"string","readOnly":true},"WaterResponsibility":{"description":"Responsibility of paying Water Bill:-","enum":["Tenant","Landlord"],"type":"string"},"TVLicenceResponsibility":{"description":"Responsibility of paying TV Licence:-","enum":["Tenant","Landlord"],"type":"string","readOnly":true},"TenancyType":{"description":"Tenancy Type:-","type":"string"},"IsShortTermLet":{"description":"Is short term letting:-","type":"boolean"},"PoA":{"description":"Price on Application:-","type":"boolean","readOnly":true},"CouncilTaxBand":{"description":"Displays Council Tax Band (Required in England, Wales and Scotland)","enum":["A","B","C","D","E","F","G","H","I","TBC"],"type":"string","readOnly":true},"CouncilTaxRates":{"description":"Displays Council Tax Rates (Required in Northern Ireland)","type":"string","readOnly":true},"CouncilTaxExempt":{"description":"Council Tax Exempt (Required by Trading Standards)","type":"boolean","readOnly":true},"DomesticRates":{"format":"double","description":"Tenancy Domestic Rates (Required for Trading Standards):-","type":"number","readOnly":true},"IsHMOProperty":{"description":"Is the Property a HMO Property:-","type":"boolean","readOnly":true},"MicrositeURl":{"description":"The Microsite URL:-","type":"string","readOnly":true},"InstructionTermType":{"description":"Instruction Term Type:-","enum":["Days","Weeks","Months","Years"],"type":"string","readOnly":true},"Links":{"description":"Hypermedia Links","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"AdvertisingPropertyModel":{"description":"Stores the 'Sales' type fields for property ownable as a stepping stone to a full on BO when we finally get the go ahead to write sales!!","type":"object","properties":{"OID":{"description":"The unique Object ID (OID).","type":"string"},"ETag":{"description":"A unique identifier defining the object and change revision.","type":"string"},"GlobalReference":{"description":"The global reference for the block or property","type":"string"},"AddressNumber":{"description":"The block, property or room address number","type":"string"},"RoomNumber":{"description":"The room number linked to the block, property or room","type":"string"},"RoomName":{"description":"The name linked to the block, property or room","type":"string"},"Address1":{"description":"The first line of the block, property or room address","type":"string"},"Address2":{"description":"The second line of the block, property or room address","type":"string"},"Address3":{"description":"The third line of the block, property or room address","type":"string"},"Address4":{"description":"The fourth line of the block, property or room address","type":"string"},"Postcode":{"description":"The block, property or room postcode","type":"string"},"PropertyType":{"description":"The property type linked to the block, property or room","enum":["House","FlatApartment","Bungalow","Land","HouseFlatShare","GarageParking","CommercialProperty","Block","TerracedHouse","EndTerraceHouse","SemiDetachedHouse","DetachedHouse","SemiDetachedBungalow","TownHouse","Cottage","ServicedApartment","Studio","Apartment","Barn","FarmHouse","Penthouse","BuildingPlot","DetachedBungalow","LinkDetached","MidTerracedBungalow","LandResidential","Mews","ClusterHouse","GroundFlat","GroundMaisonette","Maisonette","Chalet","Villa","Finca","ShelteredHousing","RetirementProperty","FlatShare","Garages","Duplex","Triplex","VillageHouse","SemiDetachedVilla","DetachedVilla","HotelRoom","BlockOfApartments","PrivateHalls","CoachHouse","MobileHome","CharacterProperty","HouseUnspecified","ParkHome","BarnStandAlone","Mill","Restaurant","Cafe","Castle","FarmLand","CountryHouse","BarNightClub","Shop","Office","BusinessPark","Hotel","Pub","Storage","Warehouse","ResidentialDevelopment","Farm","MixedUse","HouseofMultipleOccupation","LightIndustrial"],"type":"string"},"VideoURL":{"description":"The block, property or room video URL","type":"string"},"Description":{"description":"The block, property or room description","type":"string"},"Summary":{"description":"The property summary","type":"string"},"Directions":{"description":"Directions linked to the block, property or room","type":"string"},"EPCCurrentEER":{"description":"EER Current Rating","type":"string"},"EPCPotentialEER":{"description":"EER Potential Rating","type":"string"},"EPCCurrentEI":{"description":"EIR Current Rating","type":"string"},"EPCPotentialEI":{"description":"EIR Potential Rating","type":"string"},"PropertySource":{"description":"The block, property or room source type","type":"string"},"MainPhoto":{"description":"The identifier of the main photo (If applicable)","type":"string"},"ManagedByStaff":{"description":"The staff memeber that manages the block, property or room","type":"string"},"BathroomCount":{"format":"int32","description":"Number of bathrooms in the property","type":"integer"},"EnsuiteCount":{"format":"int32","description":"Number of ensuite bathrooms in the property","type":"integer"},"ReceptionCount":{"format":"int32","description":"Number of reception rooms in the property","type":"integer"},"BedroomCount":{"format":"int32","description":"Number of bedrooms in the property:-","type":"integer"},"CouncilTaxBand":{"description":"Council tax band of the property","enum":["A","B","C","D","E","F","G","H","I","TBC"],"type":"string"},"ParkingType":{"description":"Array of Parking types available at the property","type":"array","items":{"type":"string"}},"OutsideSpaceType":{"description":"Array of outside space types available at the property","type":"array","items":{"type":"string"}},"FloorArea":{"format":"int32","description":"Property Floor Area","type":"integer"},"FloorAreaUnits":{"description":"Property Floor Area Unit","enum":["Feet","Meters","Acres","Hectares"],"type":"string"},"HeatingType":{"description":"What kind of heating the property has:-","enum":["GasCentralHeating","OilCentralHeating","ElectricHeating","ElectricStorageHeating","UnderfloorHeating","SolarHeating","LPGCentralHeating","SolidFuel","AirConditioning","Central","DoubleGlazing","EcoFriendly","NightStorage","SolarWater","WoodBurner","OpenFire","BiomassBoiler","GroundSourceHeatPump","AirSourceHeatPump","SolarPhotovoltaicThermal","SolarThermal"],"type":"string"},"BurglarAlarm":{"description":"Property has Burglar Alarm?:-","type":"boolean"},"WashingMachine":{"description":"Property Has Washing Machine:-","type":"boolean"},"Dishwasher":{"description":"Property has dishwasher?:-","type":"boolean"},"PetsAllowed":{"description":"Property allows pets?:-","type":"boolean"},"GasSupply":{"description":"Propety has a gas supply?:-","type":"boolean"},"ElectricitySupply":{"description":"Property has an electricity supply:-","type":"boolean"},"WaterSupply":{"description":"Property has water supply:-","type":"boolean"},"PrimaryElectricitySupply":{"description":"Array of primary electricity supply types for the property","type":"array","items":{"type":"string"},"readOnly":true},"PrimarySewerageSupply":{"description":"Primary sewerage supply type for the property","type":"array","items":{"type":"string"},"readOnly":true},"PrimaryWaterSupply":{"description":"Primary water supply type for the property","type":"array","items":{"type":"string"},"readOnly":true},"Broadband":{"description":"Available broadband types at the property","type":"array","items":{"type":"string"},"readOnly":true},"Accessibility":{"description":"Array of accessibility features available at the property","type":"array","items":{"type":"string"},"readOnly":true},"YearBuilt":{"format":"int32","description":"Year the property was built","type":"integer","readOnly":true},"SourcesOfFlooding":{"description":"Array of flooding sources that affect the property","type":"array","items":{"type":"string"},"readOnly":true},"FloodDefences":{"description":"Indicates if the property has flood defences","type":"boolean","readOnly":true},"FloodedLastFiveYears":{"description":"Indicates if the property has been flooded in the last five years","type":"boolean","readOnly":true},"ListedProperty":{"description":"Indicates if the property is listed","type":"boolean","readOnly":true},"RightsOfWay":{"description":"Indicates if there are rights of way affecting the property","type":"boolean","readOnly":true},"RequiredAccess":{"description":"Indicates if access is required over neighboring land","type":"boolean","readOnly":true},"PropertyRestrictions":{"description":"Indicates if there are restrictions on the property","type":"boolean","readOnly":true},"Links":{"description":"Hypermedia Links","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"AdvertisingPropertyFacilityModelResults":{"description":"Holds results from a paged query returning PropertyFacilityModel values","type":"object","properties":{"Data":{"description":"The resulting data returned from the paged query range","type":"array","items":{"$ref":"#/definitions/AdvertisingPropertyFacilityModel"}},"Count":{"format":"int32","description":"The total number of results available for all pages","type":"integer"},"Links":{"description":"Hypermedia links","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"AdvertisingPropertyFacilityModel":{"description":"Stores the information about a single property facility.","type":"object","properties":{"OID":{"description":"The unique Object ID (OID).","type":"string"},"ETag":{"description":"A unique identifier defining the object and change revision.","type":"string"},"Name":{"description":"Display Name","type":"string"}}},"AdvertisingPhotoModelResults":{"description":"Holds results from a paged query returning PhotoModel values","type":"object","properties":{"Data":{"description":"The resulting data returned from the paged query range","type":"array","items":{"$ref":"#/definitions/AdvertisingPhotoModel"}},"Count":{"format":"int32","description":"The total number of results available for all pages","type":"integer"},"Links":{"description":"Hypermedia links","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"AdvertisingPhotoModel":{"description":"Stores a photo related to a property structure.","type":"object","properties":{"OID":{"description":"The unique Object ID (OID).","type":"string"},"ETag":{"description":"A unique identifier defining the object and change revision.","type":"string"},"Name":{"description":"The photo name.","type":"string"},"PhotoNumber":{"format":"int32","description":"The photo ordering number","type":"integer"},"PhotoType":{"description":"The photo type","enum":["Photo","Map","FloorPlan","SiteMap","AerialPhoto","StreetView","FloodMap"],"type":"string"},"Links":{"description":"Hypermedia links","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"AdvertisingPropertyRoomModelResults":{"description":"Holds results from a paged query returning PropertyRoomModel values","type":"object","properties":{"Data":{"description":"The resulting data returned from the paged query range","type":"array","items":{"$ref":"#/definitions/AdvertisingPropertyRoomModel"}},"Count":{"format":"int32","description":"The total number of results available for all pages","type":"integer"},"Links":{"description":"Hypermedia Links","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"AdvertisingPropertyRoomModel":{"description":"A single room (bedroom) property structure.","type":"object","properties":{"OID":{"description":"The unique Object ID (OID)","type":"string"},"ETag":{"description":"A unique identifier defining the object and change revision","type":"string"},"RoomName":{"description":"The room name (if applicable)","type":"string"},"Description":{"description":"The block, property or room description","type":"string"},"RoomFloor":{"description":"Gets and sets the room floor","enum":["Basement","Ground","First","Second","Third","Fourth","Fifth","SixthPlus","Unknown"],"type":"string"},"HeightMeters":{"format":"int32","description":"Gets the Meter part of the room Height","type":"integer"},"HeightCentimeters":{"format":"int32","description":"Gets the Centimeter part of the room height","type":"integer"},"LengthMeters":{"format":"int32","description":"Gets the Meter part of the room Length","type":"integer"},"LengthCentimeters":{"format":"int32","description":"Gets the ceintmeter part of the room length","type":"integer"},"WidthMeters":{"format":"int32","description":"Gets the Meter part of the room width","type":"integer"},"WidthCentimeters":{"format":"int32","description":"Gets the centimeter part of the room width","type":"integer"},"MainPhoto":{"description":"The main photo linked to the room","type":"string"},"Links":{"description":"Base Hypermedia Links","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"AdvertisingPortalMediaResults":{"description":"Advertising Portal Media Results Model","type":"object","properties":{"Data":{"description":"Result Data","type":"array","items":{"$ref":"#/definitions/AdvertisingPortalMedia"}},"Count":{"format":"int32","description":"Result Count","type":"integer"},"Links":{"description":"HypermediaLinks","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"AdvertisingPortalMedia":{"description":"Advertising Portal Media:-","type":"object","properties":{"OID":{"description":"Portal Media OID:-","type":"string"},"MediaType":{"description":"Portal Media Type:-","type":"string"},"MediaSource":{"description":"Portal Media Source:-","type":"string"},"FileName":{"description":"Portal Media File Name:-","type":"string"},"MediaCaption":{"description":"Portal Media Caption :-","type":"string"},"URL":{"description":"Portal Media URL:-","type":"string"},"IsArchived":{"description":"Is Portal Media Item Archived:-","type":"boolean"},"Documents":{"description":"Portal Media Documents Model:-","type":"array","items":{"$ref":"#/definitions/PortalMediaDocuments"}}}},"PortalMediaDocuments":{"type":"object","properties":{"OID":{"description":"Document ID:-","type":"string"},"Name":{"description":"Document Name:-","type":"string"},"Note":{"description":"Document Note:-","type":"string"},"Type":{"description":"Document Type:-","type":"string"},"IsPublic":{"description":"Is Document Public?:-","type":"boolean"},"IsExternal":{"description":"Is Document External:-","type":"boolean"},"UploadedDate":{"format":"date-time","description":"Document Uploaded Date:-","type":"string"},"BelongsTo":{"description":"Document Belongs To:-","type":"string"},"IsArchived":{"description":"Is Document Archived:-","type":"boolean"},"URL":{"description":"Document URL:-","type":"string"}}},"AdvertisingSalesInstructionSummaryModelResults":{"description":"Holds results from a paged query returning SalesInstructionModel values","type":"object","properties":{"Data":{"description":"The resulting data returned from the paged query range","type":"array","items":{"$ref":"#/definitions/AdvertisingSalesInstructionSummaryModel"}},"Count":{"format":"int32","description":"The total number of results available for all pages","type":"integer"},"Links":{"description":"Hypermedia Links","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"AdvertisingSalesInstructionSummaryModel":{"description":"Advertising Sales Summary Model:-","type":"object","properties":{"OID":{"description":"Sales ID:-","type":"string"},"ETag":{"description":"ETag:-","type":"string"},"GlobalReference":{"description":"Global Reference:-","type":"string"},"MainPhotoOID":{"description":"Main photo ID:-","type":"string"},"AddressNumber":{"description":"Address Number:-","type":"string"},"Address1":{"description":"Address 1:-","type":"string"},"Address2":{"description":"Address 2:-","type":"string"},"Address3":{"description":"Address 3:-","type":"string"},"Address4":{"description":"Address 4:-","type":"string"},"Postcode":{"description":"Address Postcode:-","type":"string"},"Price":{"format":"double","description":"Sale Price:-","type":"number"},"Description":{"description":"Description:-","type":"string"},"Area":{"description":"Sales Area:-","type":"string"},"State":{"description":"/// The current instruction state\r\n///","enum":["MarketAppraisal","LostAppraisal","Instructed","Advertised","UnderOffer","ContractsExchanged","Completed","FallenThrough","Withdrawn"],"type":"string"},"PropertyOwnableType":{"description":"Sales property type:-","enum":["House","FlatApartment","Bungalow","Land","HouseFlatShare","GarageParking","CommercialProperty","Block","TerracedHouse","EndTerraceHouse","SemiDetachedHouse","DetachedHouse","SemiDetachedBungalow","TownHouse","Cottage","ServicedApartment","Studio","Apartment","Barn","FarmHouse","Penthouse","BuildingPlot","DetachedBungalow","LinkDetached","MidTerracedBungalow","LandResidential","Mews","ClusterHouse","GroundFlat","GroundMaisonette","Maisonette","Chalet","Villa","Finca","ShelteredHousing","RetirementProperty","FlatShare","Garages","Duplex","Triplex","VillageHouse","SemiDetachedVilla","DetachedVilla","HotelRoom","BlockOfApartments","PrivateHalls","CoachHouse","MobileHome","CharacterProperty","HouseUnspecified","ParkHome","BarnStandAlone","Mill","Restaurant","Cafe","Castle","FarmLand","CountryHouse","BarNightClub","Shop","Office","BusinessPark","Hotel","Pub","Storage","Warehouse","ResidentialDevelopment","Farm","MixedUse","HouseofMultipleOccupation","LightIndustrial"],"type":"string"},"VideoURL":{"description":"Video URL:-","type":"string"},"POA":{"description":"POA","type":"boolean"},"SalesBy":{"description":"Sales By","enum":["PrivateTreaty","ByAuction","Confidential","ByTender","OffersInvited","POA","GuidePrice","FixedPrice","OffersInExcessOf","OffersInRegionOf","SharedOwnership","PartBuyPartRent","SharedEquity","EquityLoan"],"type":"string"},"PlotNumber":{"description":"Plot Number:-","type":"string"},"FullPrice":{"format":"double","description":"Full Sales Price:-","type":"number"},"SharePercent":{"format":"double","description":"Share Percentage of Sale:-","type":"number"},"RentAmount":{"format":"double","description":"Rent Potential Of Sale:-","type":"number"},"Links":{"description":"Hypermedia Links:-","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"AdvertisingSalesInstructionModel":{"description":"Advertising sales instruction model","type":"object","properties":{"OID":{"description":"The unique Object ID (OID).","type":"string"},"ETag":{"description":"A unique identifier defining the object and change revision.","type":"string"},"GlobalReference":{"description":"The global reference for a sales instruction","type":"string"},"MainPhotoOID":{"description":"OID of main sales instruction photo:-","type":"string"},"AddressNumber":{"description":"Address number of the property to be sold","type":"string"},"Address1":{"description":"Address 1 of the property to be sold","type":"string"},"Address2":{"description":"Address 2 of the property to be sold","type":"string"},"Address3":{"description":"Address 3 of the property to be sold","type":"string"},"Address4":{"description":"Address 4 of the property to be sold","type":"string"},"Postcode":{"description":"Postcode of the property to be sold","type":"string"},"Country":{"description":"Address country of the property to be sold","enum":["Afghanistan","Albania","Algeria","Andorra","Angola","AntiguaAndBarbuda","Argentina","Armenia","Australia","Austria","Azerbaijan","Bahamas","Bahrain","Bangladesh","Barbados","Belarus","Belgium","Belize","Benin","Bhutan","Bolivia","BosniaAndHerzegovina","Botswana","Brazil","Brunei","Bulgaria","BurkinaFaso","Burundi","Cambodia","Cameroon","Canada","CapeVerde","CentralAfricanRepublic","Chad","Chile","China","Colombia","Comoros","CongoBrazzaville","CongoDemocraticRepublicOfThe","CostaRica","CoteDIvoire","Croatia","Cuba","Cyprus","CzechRepublic","Denmark","Djibouti","Dominica","DominicanRepublic","EastTimorTimorTimur","Ecuador","Egypt","ElSalvador","EquatorialGuinea","Eritrea","Estonia","Ethiopia","Fiji","Finland","France","Gabon","GambiaThe","Georgia","Germany","Ghana","Greece","Grenada","Guatemala","Guinea","GuineaBissau","Guyana","Haiti","Honduras","Hungary","Iceland","India","Indonesia","Iran","Iraq","Ireland","Israel","Italy","Jamaica","Japan","Jordan","Kazakhstan","Kenya","Kiribati","KoreaNorth","KoreaSouth","Kuwait","Kyrgyzstan","Laos","Latvia","Lebanon","Lesotho","Liberia","Libya","Liechtenstein","Lithuania","Luxembourg","MacedoniaFormerYugoslavRepublicOf","Madagascar","Malawi","Malaysia","Maldives","Mali","Malta","MarshallIslands","Mauritania","Mauritius","Mexico","MicronesiaFederatedStatesOf","Moldova","Monaco","Mongolia","Morocco","Mozambique","Myanmar","Namibia","Nauru","Nepal","Netherlands","NewZealand","Nicaragua","Niger","Nigeria","Norway","Oman","Pakistan","Palau","Panama","PapuaNewGuinea","Paraguay","Peru","Philippines","Poland","Portugal","Qatar","Romania","Russia","Rwanda","SaintKittsAndNevis","SaintLucia","SaintVincentAndTheGrenadines","Samoa","SanMarino","SaoTomeAndPrincipe","SaudiArabia","Senegal","SerbiaAndMontenegro","Seychelles","SierraLeone","Singapore","Slovakia","Slovenia","SolomonIslands","Somalia","SouthAfrica","Spain","SriLanka","Sudan","Suriname","Swaziland","Sweden","Switzerland","Syria","Taiwan","Tajikistan","Tanzania","Thailand","Togo","Tonga","TrinidadAndTobago","Tunisia","Turkey","Turkmenistan","Tuvalu","Uganda","Ukraine","UnitedArabEmirates","UnitedKingdom","UnitedStates","Uruguay","Uzbekistan","Vanuatu","VaticanCity","Venezuela","Vietnam","WesternSahara","Yemen","Zambia","Zimbabwe","UnknownCountry","HongKong","Jersey","ChannelIslands","Bermuda","BritishOverseasTerritory"],"type":"string"},"Price":{"format":"double","description":"The price of the property to be sold","type":"number"},"Tenure":{"description":"Instruction tenure","enum":["Freehold","Leasehold","Commonhold","ShareOfFreehold","FlyingFreehold","ShareTransfer","Unknown"],"type":"string"},"Description":{"description":"The instruction description","type":"string"},"ReceptionRooms":{"format":"int32","description":"Number of reception rooms linked to the instruction","type":"integer"},"Kitchens":{"format":"int32","description":"Number of kitchens linked to the property instruction","type":"integer"},"Bedrooms":{"format":"int32","description":"Number of bedrooms linked to the instruction","type":"integer"},"Bathrooms":{"format":"int32","description":"Number of bathrooms linked to the instruction","type":"integer"},"BathroomsEnsuite":{"format":"int32","description":"How many of the bathrooms are ensuite?","type":"integer"},"Area":{"description":"The area linked to the instruction","type":"string"},"Directions":{"description":"Directions linked to the instruction","type":"string"},"ContractType":{"description":"The contract type","enum":["Pending","SoleAgency","SoleSellingRights","JointSoleAgency","MultiAgency","SubAgent"],"type":"string"},"State":{"description":"The current instruction state","enum":["MarketAppraisal","LostAppraisal","Instructed","Advertised","UnderOffer","ContractsExchanged","Completed","FallenThrough","Withdrawn"],"type":"string"},"OutsideSpaceBalcony":{"description":"Does the instruction have an outside balcony linked to it?","type":"boolean"},"OutsideSpaceCommunalGarden":{"description":"Does the instruction have a communal garden linked to it?","type":"boolean"},"OutsideSpaceConservatory":{"description":"Does the instruction have a conservatory linked to it?","type":"boolean"},"OutsideSpaceGarden":{"description":"Does the instruction have a garden linked to it?","type":"boolean"},"OutsideSpaceLargeGarden":{"description":"Does the instruction have a large garden linked to it?","type":"boolean"},"OutsideSpacePatio":{"description":"Does the instruction have a patio linked to it?","type":"boolean"},"OutsideSpaceRoofTerrace":{"description":"Does the instruction have a roof terrace linked to it?","type":"boolean"},"OutsideSpaceSouthFacingGarden":{"description":"Does the instruction have a south facing garden?","type":"boolean"},"ParkingAllocated":{"description":"Is there any parking allocation linked to the instruction?","type":"boolean"},"ParkingCarport":{"description":"Does the instruction have a carport linked to it?","type":"boolean"},"ParkingDoubleGarage":{"description":"Does the instruction have a double garage linked to it?","type":"boolean"},"ParkingGarage":{"description":"Does the instruction have a garage linked to it?","type":"boolean"},"ParkingOffRoad":{"description":"Is there off road parking linked to the instruction?","type":"boolean"},"ParkingOnRoad":{"description":"Is there on road parking linked to the instruction?","type":"boolean"},"ParkingPermit":{"description":"Is a parking permit required?","type":"boolean"},"ParkingSecureGated":{"description":"Is there any secured gate parking linked to the instruction?","type":"boolean"},"ParkingTripleGarage":{"description":"Does the instruction have a triple garage linked to it?","type":"boolean"},"HasElectricitySupply":{"description":"Does the instruction have an electrical supply linked to it?","type":"boolean"},"HasGasSupply":{"description":"Does the instruction have an gas supply linked to it?","type":"boolean"},"HasWaterMeter":{"description":"Does the instruction have a water meter linked to it?","type":"boolean"},"DevelopmentOpp":{"description":"Is the instruction a development opportunity?","type":"boolean"},"InvestmentOpp":{"description":"Is the instruction a investment opportunity?","type":"boolean"},"EPCCurrentEER":{"format":"int32","description":"Current EER value","type":"integer"},"EPCPotentialEER":{"format":"int32","description":"Potential EER value","type":"integer"},"EPCCurrentEI":{"format":"int32","description":"Current EI value","type":"integer"},"EPCPotentialEI":{"format":"int32","description":"Potential EI value","type":"integer"},"PropertyOwnableType":{"description":"The property type","enum":["House","FlatApartment","Bungalow","Land","HouseFlatShare","GarageParking","CommercialProperty","Block","TerracedHouse","EndTerraceHouse","SemiDetachedHouse","DetachedHouse","SemiDetachedBungalow","TownHouse","Cottage","ServicedApartment","Studio","Apartment","Barn","FarmHouse","Penthouse","BuildingPlot","DetachedBungalow","LinkDetached","MidTerracedBungalow","LandResidential","Mews","ClusterHouse","GroundFlat","GroundMaisonette","Maisonette","Chalet","Villa","Finca","ShelteredHousing","RetirementProperty","FlatShare","Garages","Duplex","Triplex","VillageHouse","SemiDetachedVilla","DetachedVilla","HotelRoom","BlockOfApartments","PrivateHalls","CoachHouse","MobileHome","CharacterProperty","HouseUnspecified","ParkHome","BarnStandAlone","Mill","Restaurant","Cafe","Castle","FarmLand","CountryHouse","BarNightClub","Shop","Office","BusinessPark","Hotel","Pub","Storage","Warehouse","ResidentialDevelopment","Farm","MixedUse","HouseofMultipleOccupation","LightIndustrial"],"type":"string"},"VideoURL":{"description":"The URL of the video linked to the Sales Instruction","type":"string"},"POA":{"description":"POA","type":"boolean"},"SalesBy":{"description":"Sales By","enum":["PrivateTreaty","ByAuction","Confidential","ByTender","OffersInvited","POA","GuidePrice","FixedPrice","OffersInExcessOf","OffersInRegionOf","SharedOwnership","PartBuyPartRent","SharedEquity","EquityLoan"],"type":"string"},"PlotNumber":{"description":"Plot Number:-","type":"string"},"FullPrice":{"format":"double","description":"Full Price:- (Required for Trading Standards)","type":"number"},"RentAmount":{"format":"double","description":"Rent Amount:-","type":"number"},"Summary":{"description":"Summary:-","type":"string"},"CouncilTaxBand":{"description":"Display Council Tax Band (Required in England, Wales and Scotland)","enum":["A","B","C","D","E","F","G","H","I","TBC"],"type":"string","readOnly":true},"CouncilTaxCost":{"format":"double","description":"Display Council Tax Rates (Required in Northen Ireland)","type":"number","readOnly":true},"TenureDetails":{"$ref":"#/definitions/TenureModel","description":"Detailed Tenure Information (Required for Trading Standards)","readOnly":true},"DomesticRates":{"format":"double","description":"Domestic Rates (Required for Trading Standards, NI only)","type":"number","readOnly":true},"GroundRentReviewPeriod":{"format":"int32","description":"Ground Rent View Period in Years (Required for Trading Standards)","type":"integer"},"GroundRentPercentageIncrease":{"format":"double","description":"Ground Rent Percentage Increase (Required for Trading Standards)","type":"number"},"SharePercent":{"format":"double","description":"Share Percent:-","type":"number"},"IsNewHome":{"description":"Is New Home:-","type":"boolean","readOnly":true},"MicrositeURl":{"description":"Microsite URL:-","type":"string","readOnly":true},"PrimaryElectricitySupply":{"description":"Array of primary electricity supply types for the property","type":"array","items":{"type":"string"},"readOnly":true},"PrimarySewerageSupply":{"description":"Primary sewerage supply type for the property","type":"array","items":{"type":"string"},"readOnly":true},"PrimaryWaterSupply":{"description":"Primary water supply type for the property","type":"array","items":{"type":"string"},"readOnly":true},"Broadband":{"description":"Available broadband types at the property","type":"array","items":{"type":"string"},"readOnly":true},"Accessibility":{"description":"Array of accessibility features available at the property","type":"array","items":{"type":"string"},"readOnly":true},"YearBuilt":{"format":"int32","description":"Year the property was built","type":"integer","readOnly":true},"SourcesOfFlooding":{"description":"Array of flooding sources that affect the property","type":"array","items":{"type":"string"},"readOnly":true},"FloodDefences":{"description":"Indicates if the property has flood defences","type":"boolean","readOnly":true},"FloodedLastFiveYears":{"description":"Indicates if the property has been flooded in the last five years","type":"boolean","readOnly":true},"ListedProperty":{"description":"Indicates if the property is listed","type":"boolean","readOnly":true},"RightsOfWay":{"description":"Indicates if there are rights of way affecting the property","type":"boolean","readOnly":true},"RequiredAccess":{"description":"Indicates if access is required over neighboring land","type":"boolean","readOnly":true},"PropertyRestrictions":{"description":"Indicates if there are restrictions on the property","type":"boolean","readOnly":true},"Links":{"description":"Hypermedia Links","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"TenureModel":{"description":"Tenure Model (Required by Trading Standards)","type":"object","properties":{"Tenure":{"description":"Display Sales Tenure","enum":["Freehold","Leasehold","Commonhold","ShareOfFreehold","FlyingFreehold","ShareTransfer","Unknown"],"type":"string"},"GroundRent":{"format":"double","description":"Display Ground Rent","type":"number"},"ServiceCharge":{"format":"double","description":"Display Service Charge","type":"number"},"LeaseRemaining":{"format":"int32","description":"Display Lease Remaining","type":"integer"},"GroundRentReviewPeriod":{"format":"int32","description":"Ground Rent View Period in Years (Required for Trading Standards)","type":"integer"},"GroundRentPercentageIncrease":{"format":"double","description":"Ground Rent Percentage Increase (Required for Trading Standards)","type":"number"}}},"AdvertisingSalesFeatureTypeModelResults":{"description":"Holds results from a paged query returning SalesFeatureTypeModel values","type":"object","properties":{"Data":{"description":"The resulting data returned from the paged query range","type":"array","items":{"$ref":"#/definitions/AdvertisingSalesFeatureTypeModel"}},"Count":{"format":"int32","description":"The total number of results available for all pages","type":"integer"},"Links":{"description":"Hypermedia Links","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"AdvertisingSalesFeatureTypeModel":{"type":"object","properties":{"OID":{"description":"The unique Object ID (OID).","type":"string"},"ETag":{"description":"A unique identifier defining the object and change revision.","type":"string"},"Name":{"description":"The name of the feature type","type":"string"},"Links":{"description":"Hypermedia Links","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"AdvertisingSalesFeatureModelResults":{"description":"Holds results from a paged query returning SalesFeatureModel values","type":"object","properties":{"Data":{"description":"The resulting data returned from the paged query range","type":"array","items":{"$ref":"#/definitions/AdvertisingSalesFeatureModel"}},"Count":{"format":"int32","description":"The total number of results available for all pages","type":"integer"},"Links":{"description":"Hypermedia links","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"AdvertisingSalesFeatureModel":{"description":"","type":"object","properties":{"OID":{"description":"The unique Object ID (OID).","type":"string"},"ETag":{"description":"A unique identifier defining the object and change revision.","type":"string"},"TypeOID":{"description":"The feature type","type":"string"},"Comment":{"description":"The feature comment","type":"string"},"Links":{"description":"Hypermedia links","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}}},"securityDefinitions":{"basic":{"type":"basic","description":"Basic HTTP Authentication"},"apiKey":{"type":"apiKey","description":"ApiKey Authentication","name":"ApiKey","in":"header"}}}