openapi-directory/api/letmc.com/basic-tier.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"contact":{"x-twitter":"LetMC"},"title":"LetMC Api V2, Basic (Tier 2)","version":"v2-basic-tier","x-apisguru-categories":["ecommerce"],"x-logo":{"url":"https://twitter.com/agentOSSoftware/profile_image?size=original"},"x-origin":[{"format":"swagger","url":"https://live-api.letmc.com/swagger/docs/v2-basic-tier","version":"2.0"}],"x-providerName":"letmc.com","x-serviceName":"basic-tier"},"paths":{"/v2/tier2/{shortName}/area/areas":{"get":{"deprecated":false,"parameters":[{"description":"The unique client short-name","in":"path","name":"shortName","required":true,"schema":{"type":"string"}},{"description":"The index of the first item to return","in":"query","name":"offset","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The maximum number of items to return (up to 1000 per request)","in":"query","name":"count","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AreaModelResults"}},"text/json":{"schema":{"$ref":"#/components/schemas/AreaModelResults"}},"application/xml":{"schema":{"$ref":"#/components/schemas/AreaModelResults"}},"text/xml":{"schema":{"$ref":"#/components/schemas/AreaModelResults"}}}}},"summary":"A collection of all the areas for a company","tags":["AreaController"]}},"/v2/tier2/{shortName}/area/areas/{areaID}":{"get":{"deprecated":false,"parameters":[{"description":"The unique client short-name","in":"path","name":"shortName","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the Area","in":"path","name":"areaID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AreaModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/AreaModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/AreaModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/AreaModel"}}}}},"summary":"Get a specific area given its unique Object ID (OID)","tags":["AreaController"]}},"/v2/tier2/{shortName}/branch/branches":{"get":{"deprecated":false,"parameters":[{"description":"The unique client short-name","in":"path","name":"shortName","required":true,"schema":{"type":"string"}},{"description":"The index of the first item to return","in":"query","name":"offset","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The maximum number of items to return (up to 1000 per request)","in":"query","name":"count","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BranchModelResults"}},"text/json":{"schema":{"$ref":"#/components/schemas/BranchModelResults"}},"application/xml":{"schema":{"$ref":"#/components/schemas/BranchModelResults"}},"text/xml":{"schema":{"$ref":"#/components/schemas/BranchModelResults"}}}}},"summary":"All branches defined for a company","tags":["BranchController"]}},"/v2/tier2/{shortName}/branch/branches/{branchID}":{"get":{"deprecated":false,"parameters":[{"description":"The unique client short-name","in":"path","name":"shortName","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the Branch","in":"path","name":"branchID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BranchModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/BranchModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/BranchModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/BranchModel"}}}}},"summary":"Get a specific branch given its unique Object ID (OID)","tags":["BranchController"]}},"/v2/tier2/{shortName}/company":{"get":{"deprecated":false,"operationId":"CompanyController_GetCompany","parameters":[{"description":"The unique client short-name","in":"path","name":"shortName","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/CompanyModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CompanyModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/CompanyModel"}}}}},"summary":"Information about a specific company","tags":["CompanyController"]}},"/v2/tier2/{shortName}/county/counties":{"get":{"deprecated":false,"parameters":[{"description":"The unique client short-name","in":"path","name":"shortName","required":true,"schema":{"type":"string"}},{"description":"The index of the first item to return","in":"query","name":"offset","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The maximum number of items to return (up to 1000 per request)","in":"query","name":"count","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CountyModelResults"}},"text/json":{"schema":{"$ref":"#/components/schemas/CountyModelResults"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CountyModelResults"}},"text/xml":{"schema":{"$ref":"#/components/schemas/CountyModelResults"}}}}},"summary":"A collection of all counties available for a company","tags":["CountyController"]}},"/v2/tier2/{shortName}/county/counties/{countyID}":{"get":{"deprecated":false,"parameters":[{"description":"The unique client short-name","in":"path","name":"shortName","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the County","in":"path","name":"countyID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CountyModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/CountyModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CountyModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/CountyModel"}}}}},"summary":"Get a specific county given its unique Object ID (OID)","tags":["CountyController"]}},"/v2/tier2/{shortName}/county/counties/{countyID}/branches":{"get":{"deprecated":false,"operationId":"CountyController_GetCountiesBranches","parameters":[{"description":"The unique client short-name","in":"path","name":"shortName","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the County","in":"path","name":"countyID","required":true,"schema":{"type":"string"}},{"description":"The index of the first item to return","in":"query","name":"offset","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The maximum number of items to return (up to 1000 per request)","in":"query","name":"count","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BranchModelResults"}},"text/json":{"schema":{"$ref":"#/components/schemas/BranchModelResults"}},"application/xml":{"schema":{"$ref":"#/components/schemas/BranchModelResults"}},"text/xml":{"schema":{"$ref":"#/components/schemas/BranchModelResults"}}}}},"summary":"A collection of branches that manage a specific county","tags":["CountyController"]}},"/v2/tier2/{shortName}/diary/allocations":{"get":{"deprecated":false,"parameters":[{"description":"The unique client short-name","in":"path","name":"shortName","required":true,"schema":{"type":"string"}},{"description":"The index of the first item to return","in":"query","name":"offset","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The maximum number of items to return (up to 1000 per request)","in":"query","name":"count","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiaryAllocationModelResults"}},"text/json":{"schema":{"$ref":"#/components/schemas/DiaryAllocationModelResults"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DiaryAllocationModelResults"}},"text/xml":{"schema":{"$ref":"#/components/schemas/DiaryAllocationModelResults"}}}}},"summary":"A collection of all diary allocations","tags":["DiaryController"]}},"/v2/tier2/{shortName}/diary/allocations/{diaryAllocationID}":{"get":{"deprecated":false,"parameters":[{"description":"The unique client short-name","in":"path","name":"shortName","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the DiaryAllocation","in":"path","name":"diaryAllocationID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiaryAllocationModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/DiaryAllocationModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DiaryAllocationModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/DiaryAllocationModel"}}}}},"summary":"Get a specific diary allocation given its unique Object ID (OID)","tags":["DiaryController"]}},"/v2/tier2/{shortName}/diary/appointments":{"get":{"deprecated":false,"parameters":[{"description":"The unique client short-name","in":"path","name":"shortName","required":true,"schema":{"type":"string"}},{"description":"The index of the first item to return","in":"query","name":"offset","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The maximum number of items to return (up to 1000 per request)","in":"query","name":"count","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiaryAppointmentModelResults"}},"text/json":{"schema":{"$ref":"#/components/schemas/DiaryAppointmentModelResults"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DiaryAppointmentModelResults"}},"text/xml":{"schema":{"$ref":"#/components/schemas/DiaryAppointmentModelResults"}}}}},"summary":"A collection of all diary appointments","tags":["DiaryController"]}},"/v2/tier2/{shortName}/diary/appointments/{diaryAppointmentID}":{"get":{"deprecated":false,"parameters":[{"description":"The unique client short-name","in":"path","name":"shortName","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the DiaryAppointment","in":"path","name":"diaryAppointmentID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiaryAppointmentModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/DiaryAppointmentModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DiaryAppointmentModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/DiaryAppointmentModel"}}}}},"summary":"Get a specific diary appointment given its unique Object ID (OID)","tags":["DiaryController"]}},"/v2/tier2/{shortName}/diary/appointmenttypes":{"get":{"deprecated":false,"parameters":[{"description":"The unique client short-name","in":"path","name":"shortName","required":true,"schema":{"type":"string"}},{"description":"The index of the first item to return","in":"query","name":"offset","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The maximum number of items to return (up to 1000 per request)","in":"query","name":"count","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiaryAppointmentTypeModelResults"}},"text/json":{"schema":{"$ref":"#/components/schemas/DiaryAppointmentTypeModelResults"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DiaryAppointmentTypeModelResults"}},"text/xml":{"schema":{"$ref":"#/components/schemas/DiaryAppointmentTypeModelResults"}}}}},"summary":"A collection of all diary appointment types","tags":["DiaryController"]}},"/v2/tier2/{shortName}/diary/appointmenttypes/{diaryAppointmentTypeID}":{"get":{"deprecated":false,"parameters":[{"description":"The unique client short-name","in":"path","name":"shortName","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the DiaryAppointmentType","in":"path","name":"diaryAppointmentTypeID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiaryAppointmentTypeModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/DiaryAppointmentTypeModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DiaryAppointmentTypeModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/DiaryAppointmentTypeModel"}}}}},"summary":"Get a specific diary appointment type given its unique Object ID (OID)","tags":["DiaryController"]}},"/v2/tier2/{shortName}/lettings/advertised":{"get":{"deprecated":false,"operationId":"LettingsController_GetAdvertised","parameters":[{"description":"The unique client short-name","in":"path","name":"shortName","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the Branch","in":"query","name":"branchID","required":true,"schema":{"type":"string"}},{"description":"The index of the first item to return","in":"query","name":"offset","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The maximum number of items to return (up to 1000 per request)","in":"query","name":"count","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The unique ID of the Area","in":"query","name":"areaID","required":false,"schema":{"type":"string"}},{"description":"The minimum advertised rent to search for","in":"query","name":"rentMinimum","required":false,"schema":{"type":"number","format":"double"}},{"description":"The maximum advertised rent to search for","in":"query","name":"rentMaximum","required":false,"schema":{"type":"number","format":"double"}},{"description":"The maximum number of tenants a property can accommodate","in":"query","name":"maximumTenants","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Search for shared properties?","in":"query","name":"wantSharedProperties","required":false,"schema":{"type":"boolean"}},{"description":"Search for student properties?","in":"query","name":"wantStudentProperties","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TenancyModelResults"}},"text/json":{"schema":{"$ref":"#/components/schemas/TenancyModelResults"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TenancyModelResults"}},"text/xml":{"schema":{"$ref":"#/components/schemas/TenancyModelResults"}}}}},"summary":"Search all properties available for rent given a range of search criteria.","tags":["LettingsController"]}},"/v2/tier2/{shortName}/lettings/advertisedbetweendates":{"get":{"deprecated":false,"operationId":"LettingsController_GetAdvertisedBetweenDates","parameters":[{"description":"The unique client short-name","in":"path","name":"shortName","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the Branch","in":"query","name":"branchID","required":true,"schema":{"type":"string"}},{"description":"The index of the first item to return","in":"query","name":"offset","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The maximum number of items to return (up to 1000 per request)","in":"query","name":"count","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The date to search from","in":"query","name":"rangeStartDate","required":true,"schema":{"type":"string","format":"date-time"}},{"description":"The date to search to","in":"query","name":"rangeEndDate","required":true,"schema":{"type":"string","format":"date-time"}},{"description":"The unique ID of the Area","in":"query","name":"areaID","required":false,"schema":{"type":"string"}},{"description":"The minimum advertised rent to search for","in":"query","name":"rentMinimum","required":false,"schema":{"type":"number","format":"double"}},{"description":"The maximum advertised rent to search for","in":"query","name":"rentMaximum","required":false,"schema":{"type":"number","format":"double"}},{"description":"The maximum number of tenants a property can accommodate","in":"query","name":"maximumTenants","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Search for shared properties?","in":"query","name":"wantSharedProperties","required":false,"schema":{"type":"boolean"}},{"description":"Search for student properties?","in":"query","name":"wantStudentProperties","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TenancyModelResults"}},"text/json":{"schema":{"$ref":"#/components/schemas/TenancyModelResults"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TenancyModelResults"}},"text/xml":{"schema":{"$ref":"#/components/schemas/TenancyModelResults"}}}}},"summary":"Search all properties available for rent given a range of search criteria and dates.","tags":["LettingsController"]}},"/v2/tier2/{shortName}/lettings/tenancies":{"get":{"deprecated":false,"parameters":[{"description":"The unique client short-name","in":"path","name":"shortName","required":true,"schema":{"type":"string"}},{"description":"The index of the first item to return","in":"query","name":"offset","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The maximum number of items to return (up to 1000 per request)","in":"query","name":"count","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TenancyModelResults"}},"text/json":{"schema":{"$ref":"#/components/schemas/TenancyModelResults"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TenancyModelResults"}},"text/xml":{"schema":{"$ref":"#/components/schemas/TenancyModelResults"}}}}},"summary":"A collection of all the company's tenancies","tags":["LettingsController"]}},"/v2/tier2/{shortName}/lettings/tenancies/{tenancyID}":{"get":{"deprecated":false,"parameters":[{"description":"The unique client short-name","in":"path","name":"shortName","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the Tenancy","in":"path","name":"tenancyID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TenancyModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/TenancyModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TenancyModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/TenancyModel"}}}}},"summary":"Get a specific tenancy given its unique Object ID (OID)","tags":["LettingsController"]}},"/v2/tier2/{shortName}/lettings/tenancies/{tenancyID}/brochure":{"get":{"deprecated":false,"operationId":"LettingsController_GetTenancyBrochure","parameters":[{"description":"The unique client short-name","in":"path","name":"shortName","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the tenancy","in":"path","name":"tenancyID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Object"}},"text/json":{"schema":{"$ref":"#/components/schemas/Object"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Object"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Object"}}}}},"summary":"Downloads the brochure relating to the latest advertised rental of a property","tags":["LettingsController"]}},"/v2/tier2/{shortName}/photo/photos":{"get":{"deprecated":false,"parameters":[{"description":"The unique client short-name","in":"path","name":"shortName","required":true,"schema":{"type":"string"}},{"description":"The index of the first item to return","in":"query","name":"offset","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The maximum number of items to return (up to 1000 per request)","in":"query","name":"count","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhotoModelResults"}},"text/json":{"schema":{"$ref":"#/components/schemas/PhotoModelResults"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PhotoModelResults"}},"text/xml":{"schema":{"$ref":"#/components/schemas/PhotoModelResults"}}}}},"summary":"A collection of all photos in the company","tags":["PhotoController"]}},"/v2/tier2/{shortName}/photo/photos/{photoID}":{"get":{"deprecated":false,"parameters":[{"description":"The unique client short-name","in":"path","name":"shortName","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the Photo","in":"path","name":"photoID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhotoModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/PhotoModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PhotoModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/PhotoModel"}}}}},"summary":"Get a specific photo given its unique Object ID (OID)","tags":["PhotoController"]}},"/v2/tier2/{shortName}/photos/photo/{photoID}/download":{"get":{"deprecated":false,"operationId":"PhotoController_GetPhotoDownload","parameters":[{"description":"The unique client short-name","in":"path","name":"shortName","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the photo on the property","in":"path","name":"photoID","required":true,"schema":{"type":"string"}},{"description":"An optional parameter specifying the image width","in":"query","name":"width","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"An optional parameter specifying the image height","in":"query","name":"height","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Object"}},"text/json":{"schema":{"$ref":"#/components/schemas/Object"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Object"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Object"}}}}},"summary":"Downloads the photo of a property given the property and photo ID.","tags":["PhotoController"]}},"/v2/tier2/{shortName}/property/properties":{"get":{"deprecated":false,"parameters":[{"description":"The unique client short-name","in":"path","name":"shortName","required":true,"schema":{"type":"string"}},{"description":"The index of the first item to return","in":"query","name":"offset","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The maximum number of items to return (up to 1000 per request)","in":"query","name":"count","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyModelResults"}},"text/json":{"schema":{"$ref":"#/components/schemas/PropertyModelResults"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PropertyModelResults"}},"text/xml":{"schema":{"$ref":"#/components/schemas/PropertyModelResults"}}}}},"summary":"A collection of all properties within a company","tags":["PropertyController"]}},"/v2/tier2/{shortName}/property/properties/{propertyID}":{"get":{"deprecated":false,"parameters":[{"description":"The unique client short-name","in":"path","name":"shortName","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the Property","in":"path","name":"propertyID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/PropertyModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PropertyModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/PropertyModel"}}}}},"summary":"Get a specific property given its unique Object ID (OID)","tags":["PropertyController"]}},"/v2/tier2/{shortName}/property/properties/{propertyID}/facilities":{"get":{"deprecated":false,"operationId":"PropertyController_GetPropertiesFacilities","parameters":[{"description":"The unique client short-name","in":"path","name":"shortName","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the Property","in":"path","name":"propertyID","required":true,"schema":{"type":"string"}},{"description":"The index of the first item to return","in":"query","name":"offset","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The maximum number of items to return (up to 1000 per request)","in":"query","name":"count","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyFacilityModelResults"}},"text/json":{"schema":{"$ref":"#/components/schemas/PropertyFacilityModelResults"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PropertyFacilityModelResults"}},"text/xml":{"schema":{"$ref":"#/components/schemas/PropertyFacilityModelResults"}}}}},"summary":"A collection of facilities linked to a block, property or room","tags":["PropertyController"]}},"/v2/tier2/{shortName}/property/properties/{propertyID}/photos":{"get":{"deprecated":false,"operationId":"PropertyController_GetPropertiesPhotos","parameters":[{"description":"The unique client short-name","in":"path","name":"shortName","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the Property","in":"path","name":"propertyID","required":true,"schema":{"type":"string"}},{"description":"The index of the first item to return","in":"query","name":"offset","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The maximum number of items to return (up to 1000 per request)","in":"query","name":"count","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhotoModelResults"}},"text/json":{"schema":{"$ref":"#/components/schemas/PhotoModelResults"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PhotoModelResults"}},"text/xml":{"schema":{"$ref":"#/components/schemas/PhotoModelResults"}}}}},"summary":"A collection showing all the photos linked to a specific block, property or room","tags":["PropertyController"]}},"/v2/tier2/{shortName}/property/properties/{propertyID}/rooms":{"get":{"deprecated":false,"operationId":"PropertyController_GetPropertiesRooms","parameters":[{"description":"The unique client short-name","in":"path","name":"shortName","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the Property","in":"path","name":"propertyID","required":true,"schema":{"type":"string"}},{"description":"The index of the first item to return","in":"query","name":"offset","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The maximum number of items to return (up to 1000 per request)","in":"query","name":"count","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyRoomModelResults"}},"text/json":{"schema":{"$ref":"#/components/schemas/PropertyRoomModelResults"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PropertyRoomModelResults"}},"text/xml":{"schema":{"$ref":"#/components/schemas/PropertyRoomModelResults"}}}}},"summary":"A collection of the rooms that belong to this property or block","tags":["PropertyController"]}},"/v2/tier2/{shortName}/property/properties/{propertyID}/tenancies":{"get":{"deprecated":false,"operationId":"PropertyController_GetPropertiesTenancies","parameters":[{"description":"The unique client short-name","in":"path","name":"shortName","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the Property","in":"path","name":"propertyID","required":true,"schema":{"type":"string"}},{"description":"The index of the first item to return","in":"query","name":"offset","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The maximum number of items to return (up to 1000 per request)","in":"query","name":"count","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TenancyModelResults"}},"text/json":{"schema":{"$ref":"#/components/schemas/TenancyModelResults"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TenancyModelResults"}},"text/xml":{"schema":{"$ref":"#/components/schemas/TenancyModelResults"}}}}},"summary":"A collection of all tenancies associated with this block, property or room","tags":["PropertyController"]}},"/v2/tier2/{shortName}/property/structures/{propertyStructureID}/reports/eer":{"get":{"deprecated":false,"operationId":"PropertyController_GetPropertyEERDownload","parameters":[{"description":"The unique client short-name","in":"path","name":"shortName","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the property structure","in":"path","name":"propertyStructureID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Object"}},"text/json":{"schema":{"$ref":"#/components/schemas/Object"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Object"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Object"}}}}},"summary":"Downloads the energy efficiency report (EER) graph for a property","tags":["PropertyController"]}},"/v2/tier2/{shortName}/property/structures/{propertyStructureID}/reports/eir":{"get":{"deprecated":false,"operationId":"PropertyController_GetPropertyEIRDownload","parameters":[{"description":"The unique client short-name","in":"path","name":"shortName","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the property structure","in":"path","name":"propertyStructureID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Object"}},"text/json":{"schema":{"$ref":"#/components/schemas/Object"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Object"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Object"}}}}},"summary":"Downloads the environmental impact report (EIR) graph for a property","tags":["PropertyController"]}},"/v2/tier2/{shortName}/sales/advertisedsales":{"get":{"deprecated":false,"operationId":"SalesController_GetAdvertisedSales","parameters":[{"description":"The unique client short-name","in":"path","name":"shortName","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the Branch","in":"query","name":"branchID","required":true,"schema":{"type":"string"}},{"description":"The index of the first item to return","in":"query","name":"offset","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The maximum number of items to return (up to 1000 per request)","in":"query","name":"count","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"Show only development properties?","in":"query","name":"onlyDevelopement","required":true,"schema":{"type":"boolean"}},{"description":"Show only investment properties?","in":"query","name":"onlyInvestements","required":true,"schema":{"type":"boolean"}},{"description":"The minimum price to search for","in":"query","name":"minimumPrice","required":false,"schema":{"type":"number","format":"double"}},{"description":"The maximum price to search for","in":"query","name":"maximumPrice","required":false,"schema":{"type":"number","format":"double"}},{"description":"The minimum beds to search for","in":"query","name":"minimumBeds","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"The minimum bathrooms to search for","in":"query","name":"minimumBathrooms","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"The minimum ensuite bathrooms to search for","in":"query","name":"minimumEnsuites","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"The minimum toilets to search for","in":"query","name":"minimumToilets","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"The minimum reception rooms to search for","in":"query","name":"minimumReception","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesInstructionModelResults"}},"text/json":{"schema":{"$ref":"#/components/schemas/SalesInstructionModelResults"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SalesInstructionModelResults"}},"text/xml":{"schema":{"$ref":"#/components/schemas/SalesInstructionModelResults"}}}}},"summary":"Search all sales properties available given a range of search criteria","tags":["SalesController"]}},"/v2/tier2/{shortName}/sales/reports/eer/{salesInstructionID}":{"get":{"deprecated":false,"operationId":"SalesController_GetEER","parameters":[{"description":"The unique client short-name","in":"path","name":"shortName","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the SalesInstruction","in":"path","name":"salesInstructionID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Object"}},"text/json":{"schema":{"$ref":"#/components/schemas/Object"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Object"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Object"}}}}},"summary":"Downloads the energy efficiency report (EER) graph for a sales instruction","tags":["SalesController"]}},"/v2/tier2/{shortName}/sales/reports/eir/{salesInstructionID}":{"get":{"deprecated":false,"operationId":"SalesController_GetEIR","parameters":[{"description":"The unique client short-name","in":"path","name":"shortName","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the SalesInstruction","in":"path","name":"salesInstructionID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Object"}},"text/json":{"schema":{"$ref":"#/components/schemas/Object"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Object"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Object"}}}}},"summary":"Downloads the energy efficiency report (EIR) graph for a sales instruction","tags":["SalesController"]}},"/v2/tier2/{shortName}/sales/salesfeaturetypes":{"get":{"deprecated":false,"parameters":[{"description":"The unique client short-name","in":"path","name":"shortName","required":true,"schema":{"type":"string"}},{"description":"The index of the first item to return","in":"query","name":"offset","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The maximum number of items to return (up to 1000 per request)","in":"query","name":"count","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesFeatureTypeModelResults"}},"text/json":{"schema":{"$ref":"#/components/schemas/SalesFeatureTypeModelResults"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SalesFeatureTypeModelResults"}},"text/xml":{"schema":{"$ref":"#/components/schemas/SalesFeatureTypeModelResults"}}}}},"summary":"A collection of all sales feature types linked to a company","tags":["SalesController"]}},"/v2/tier2/{shortName}/sales/salesfeaturetypes/{salesFeatureTypeID}":{"get":{"deprecated":false,"parameters":[{"description":"The unique client short-name","in":"path","name":"shortName","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the SalesFeatureType","in":"path","name":"salesFeatureTypeID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesFeatureTypeModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/SalesFeatureTypeModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SalesFeatureTypeModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/SalesFeatureTypeModel"}}}}},"summary":"Get a specific sales feature type given its unique Object ID (OID)","tags":["SalesController"]}},"/v2/tier2/{shortName}/sales/salesinstructions":{"get":{"deprecated":false,"parameters":[{"description":"The unique client short-name","in":"path","name":"shortName","required":true,"schema":{"type":"string"}},{"description":"The index of the first item to return","in":"query","name":"offset","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The maximum number of items to return (up to 1000 per request)","in":"query","name":"count","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesInstructionModelResults"}},"text/json":{"schema":{"$ref":"#/components/schemas/SalesInstructionModelResults"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SalesInstructionModelResults"}},"text/xml":{"schema":{"$ref":"#/components/schemas/SalesInstructionModelResults"}}}}},"summary":"A collection of all sales instructions linked to a company","tags":["SalesController"]}},"/v2/tier2/{shortName}/sales/salesinstructions/{salesInstructionID}":{"get":{"deprecated":false,"parameters":[{"description":"The unique client short-name","in":"path","name":"shortName","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the SalesInstruction","in":"path","name":"salesInstructionID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesInstructionModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/SalesInstructionModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SalesInstructionModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/SalesInstructionModel"}}}}},"summary":"Get a specific sales instruction given its unique Object ID (OID)","tags":["SalesController"]}},"/v2/tier2/{shortName}/sales/salesinstructions/{salesInstructionID}/features":{"get":{"deprecated":false,"operationId":"SalesController_GetSalesInstructionsFeatures","parameters":[{"description":"The unique client short-name","in":"path","name":"shortName","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the SalesInstruction","in":"path","name":"salesInstructionID","required":true,"schema":{"type":"string"}},{"description":"The index of the first item to return","in":"query","name":"offset","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The maximum number of items to return (up to 1000 per request)","in":"query","name":"count","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesFeatureModelResults"}},"text/json":{"schema":{"$ref":"#/components/schemas/SalesFeatureModelResults"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SalesFeatureModelResults"}},"text/xml":{"schema":{"$ref":"#/components/schemas/SalesFeatureModelResults"}}}}},"summary":"A collection of all features linked to a sales instruction","tags":["SalesController"]}},"/v2/tier2/{shortName}/sales/salesinstructions/{salesInstructionID}/floorplans":{"get":{"deprecated":false,"operationId":"SalesController_GetSalesInstructionsFloorPlans","parameters":[{"description":"The unique client short-name","in":"path","name":"shortName","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the SalesInstruction","in":"path","name":"salesInstructionID","required":true,"schema":{"type":"string"}},{"description":"The index of the first item to return","in":"query","name":"offset","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The maximum number of items to return (up to 1000 per request)","in":"query","name":"count","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhotoModelResults"}},"text/json":{"schema":{"$ref":"#/components/schemas/PhotoModelResults"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PhotoModelResults"}},"text/xml":{"schema":{"$ref":"#/components/schemas/PhotoModelResults"}}}}},"summary":"A collection of floor plans linked to an instruction","tags":["SalesController"]}},"/v2/tier2/{shortName}/sales/salesinstructions/{salesInstructionID}/photos":{"get":{"deprecated":false,"operationId":"SalesController_GetSalesInstructionsPhotos","parameters":[{"description":"The unique client short-name","in":"path","name":"shortName","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the SalesInstruction","in":"path","name":"salesInstructionID","required":true,"schema":{"type":"string"}},{"description":"The index of the first item to return","in":"query","name":"offset","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The maximum number of items to return (up to 1000 per request)","in":"query","name":"count","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhotoModelResults"}},"text/json":{"schema":{"$ref":"#/components/schemas/PhotoModelResults"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PhotoModelResults"}},"text/xml":{"schema":{"$ref":"#/components/schemas/PhotoModelResults"}}}}},"summary":"A collection of photos linked to an instruction","tags":["SalesController"]}},"/v2/tier2/{shortName}/sales/salesinstructions/{salesInstructionID}/rooms":{"get":{"deprecated":false,"operationId":"SalesController_GetSalesInstructionsRooms","parameters":[{"description":"The unique client short-name","in":"path","name":"shortName","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the SalesInstruction","in":"path","name":"salesInstructionID","required":true,"schema":{"type":"string"}},{"description":"The index of the first item to return","in":"query","name":"offset","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The maximum number of items to return (up to 1000 per request)","in":"query","name":"count","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyRoomModelResults"}},"text/json":{"schema":{"$ref":"#/components/schemas/PropertyRoomModelResults"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PropertyRoomModelResults"}},"text/xml":{"schema":{"$ref":"#/components/schemas/PropertyRoomModelResults"}}}}},"summary":"A collection of rooms linked to an instruction","tags":["SalesController"]}},"/v2/tier2/{shortName}/staff/staff":{"get":{"deprecated":false,"parameters":[{"description":"The unique client short-name","in":"path","name":"shortName","required":true,"schema":{"type":"string"}},{"description":"The index of the first item to return","in":"query","name":"offset","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The maximum number of items to return (up to 1000 per request)","in":"query","name":"count","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationStaffModelResults"}},"text/json":{"schema":{"$ref":"#/components/schemas/ApplicationStaffModelResults"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ApplicationStaffModelResults"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ApplicationStaffModelResults"}}}}},"summary":"A collection of all the staff members linked to a specific company","tags":["StaffController"]}},"/v2/tier2/{shortName}/staff/staff/{applicationStaffID}":{"get":{"deprecated":false,"parameters":[{"description":"The unique client short-name","in":"path","name":"shortName","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the ApplicationStaff","in":"path","name":"applicationStaffID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationStaffModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/ApplicationStaffModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ApplicationStaffModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ApplicationStaffModel"}}}}},"summary":"Get a specific application staff given its unique Object ID (OID)","tags":["StaffController"]}},"/v2/tier2/{shortName}/viewing/bookings":{"get":{"deprecated":false,"operationId":"ViewingController_GetBookings","parameters":[{"description":"The unique client short-name","in":"path","name":"shortName","required":true,"schema":{"type":"string"}},{"description":"The preferred date for a viewing","in":"query","name":"preferredDate","required":true,"schema":{"type":"string","format":"date-time"}},{"description":"An array of unique IDs of properties to view","in":"query","name":"propertyIDsToView","required":true,"explode":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ViewingBookingModel"},"type":"array"}},"text/json":{"schema":{"items":{"$ref":"#/components/schemas/ViewingBookingModel"},"type":"array"}},"application/xml":{"schema":{"items":{"$ref":"#/components/schemas/ViewingBookingModel"},"type":"array"}},"text/xml":{"schema":{"items":{"$ref":"#/components/schemas/ViewingBookingModel"},"type":"array"}}}}},"summary":"Gets a list of available viewing slots for one or more properties","tags":["ViewingController"]},"post":{"deprecated":false,"operationId":"ViewingController_MakeBooking","parameters":[{"description":"The unique client short-name","in":"path","name":"shortName","required":true,"schema":{"type":"string"}},{"description":"The forename of the prospect","in":"query","name":"forename","required":true,"schema":{"type":"string"}},{"description":"The surname of the prospect","in":"query","name":"surname","required":true,"schema":{"type":"string"}},{"description":"The mobile phone number of the prospect","in":"query","name":"mobilePhone","required":true,"schema":{"type":"string"}},{"description":"The email address of the prospect","in":"query","name":"emailAddress","required":true,"schema":{"type":"string"}},{"description":"An array of unique IDs of properties to view","in":"query","name":"propertyIDsToView","required":true,"explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Whether the prospect wants a shared property","in":"query","name":"wantRoomInSharedProperty","required":false,"schema":{"type":"boolean"}},{"description":"The minimum rent amount the prospect is looking for","in":"query","name":"alertMinRent","required":false,"schema":{"type":"number","format":"double"}},{"description":"The maximum rent amount the prospect is looking for","in":"query","name":"alertMaxRent","required":false,"schema":{"type":"number","format":"double"}},{"description":"The minimum number of beds the prospect is looking for","in":"query","name":"alertNumberOfBeds","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"The unique ID of the area the prospect is looking for","in":"query","name":"alertAreaID","required":false,"schema":{"type":"string"}},{"description":"The tenanct type the prospect is looking for","in":"query","name":"alertTenantType","required":false,"schema":{"type":"string","enum":["Employed","SelfEmployed","Unemployed","Student","OwnMeans","Retired","Company","Council"]}},{"description":"Whether to subscribe the prospect to email alerts","in":"query","name":"subscribeToEmailAlerts","required":false,"schema":{"type":"boolean"}},{"description":"Whether to subscribe the prospect to SMS alerts","in":"query","name":"subscribeToSMSAlerts","required":false,"schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViewingBookingModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/ViewingBookingModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ViewingBookingModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ViewingBookingModel"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/ViewingBookingModel"}}},"description":"The prospect's selected viewing slot","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"}},"text/json":{"schema":{"type":"boolean"