{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources. Success responses include a `source` block to cite. Apizie Finance endpoints (SEC EDGAR, FRED, ECB, U.S. Treasury, GLEIF, World Bank, official:*) need a Finance plan."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/ecommerce:letmc-basic-tier/get-v2-tier2-short-name-area-areas":{"get":{"operationId":"ecommerce_letmc_basic_tier_get_v2_tier2_short_name_area_areas","summary":"A collection of all the areas for a company","description":"GET /v2/tier2/{shortName}/area/areas","tags":["ecommerce"],"x-apizie-access":"read","parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"offset","in":"query","required":true,"description":"The index of the first item to return","schema":{"type":"integer","description":"The index of the first item to return"}},{"name":"count","in":"query","required":true,"description":"The maximum number of items to return (up to 1000 per request)","schema":{"type":"integer","description":"The maximum number of items to return (up to 1000 per request)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-basic-tier/get-v2-tier2-short-name-area-areas-area-id":{"get":{"operationId":"ecommerce_letmc_basic_tier_get_v2_tier2_short_name_area_areas_area_id","summary":"Get a specific area given its unique Object ID (OID)","description":"GET /v2/tier2/{shortName}/area/areas/{areaID}","tags":["ecommerce"],"x-apizie-access":"read","parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"areaID","in":"query","required":true,"description":"The unique ID of the Area","schema":{"type":"string","description":"The unique ID of the Area"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-basic-tier/get-v2-tier2-short-name-branch-branches":{"get":{"operationId":"ecommerce_letmc_basic_tier_get_v2_tier2_short_name_branch_branches","summary":"All branches defined for a company","description":"GET /v2/tier2/{shortName}/branch/branches","tags":["ecommerce"],"x-apizie-access":"read","parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"offset","in":"query","required":true,"description":"The index of the first item to return","schema":{"type":"integer","description":"The index of the first item to return"}},{"name":"count","in":"query","required":true,"description":"The maximum number of items to return (up to 1000 per request)","schema":{"type":"integer","description":"The maximum number of items to return (up to 1000 per request)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-basic-tier/get-v2-tier2-short-name-branch-branches-branch-id":{"get":{"operationId":"ecommerce_letmc_basic_tier_get_v2_tier2_short_name_branch_branches_branch_id","summary":"Get a specific branch given its unique Object ID (OID)","description":"GET /v2/tier2/{shortName}/branch/branches/{branchID}","tags":["ecommerce"],"x-apizie-access":"read","parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"branchID","in":"query","required":true,"description":"The unique ID of the Branch","schema":{"type":"string","description":"The unique ID of the Branch"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-basic-tier/company-controller-get-company":{"get":{"operationId":"ecommerce_letmc_basic_tier_company_controller_get_company","summary":"Information about a specific company","description":"GET /v2/tier2/{shortName}/company","tags":["ecommerce"],"x-apizie-access":"read","parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-basic-tier/get-v2-tier2-short-name-county-counties":{"get":{"operationId":"ecommerce_letmc_basic_tier_get_v2_tier2_short_name_county_counties","summary":"A collection of all counties available for a company","description":"GET /v2/tier2/{shortName}/county/counties","tags":["ecommerce"],"x-apizie-access":"read","parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"offset","in":"query","required":true,"description":"The index of the first item to return","schema":{"type":"integer","description":"The index of the first item to return"}},{"name":"count","in":"query","required":true,"description":"The maximum number of items to return (up to 1000 per request)","schema":{"type":"integer","description":"The maximum number of items to return (up to 1000 per request)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-basic-tier/get-v2-tier2-short-name-county-counties-county-id":{"get":{"operationId":"ecommerce_letmc_basic_tier_get_v2_tier2_short_name_county_counties_county_id","summary":"Get a specific county given its unique Object ID (OID)","description":"GET /v2/tier2/{shortName}/county/counties/{countyID}","tags":["ecommerce"],"x-apizie-access":"read","parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"countyID","in":"query","required":true,"description":"The unique ID of the County","schema":{"type":"string","description":"The unique ID of the County"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-basic-tier/county-controller-get-counties-branches":{"get":{"operationId":"ecommerce_letmc_basic_tier_county_controller_get_counties_branches","summary":"A collection of branches that manage a specific county","description":"GET /v2/tier2/{shortName}/county/counties/{countyID}/branches","tags":["ecommerce"],"x-apizie-access":"read","parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"countyID","in":"query","required":true,"description":"The unique ID of the County","schema":{"type":"string","description":"The unique ID of the County"}},{"name":"offset","in":"query","required":true,"description":"The index of the first item to return","schema":{"type":"integer","description":"The index of the first item to return"}},{"name":"count","in":"query","required":true,"description":"The maximum number of items to return (up to 1000 per request)","schema":{"type":"integer","description":"The maximum number of items to return (up to 1000 per request)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-basic-tier/get-v2-tier2-short-name-diary-allocations":{"get":{"operationId":"ecommerce_letmc_basic_tier_get_v2_tier2_short_name_diary_allocations","summary":"A collection of all diary allocations","description":"GET /v2/tier2/{shortName}/diary/allocations","tags":["ecommerce"],"x-apizie-access":"read","parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"offset","in":"query","required":true,"description":"The index of the first item to return","schema":{"type":"integer","description":"The index of the first item to return"}},{"name":"count","in":"query","required":true,"description":"The maximum number of items to return (up to 1000 per request)","schema":{"type":"integer","description":"The maximum number of items to return (up to 1000 per request)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-basic-tier/get-v2-tier2-short-name-diary-allocations-diary-allocation-i":{"get":{"operationId":"ecommerce_letmc_basic_tier_get_v2_tier2_short_name_diary_allocations_diary_allocation_i","summary":"Get a specific diary allocation given its unique Object ID (OID)","description":"GET /v2/tier2/{shortName}/diary/allocations/{diaryAllocationID}","tags":["ecommerce"],"x-apizie-access":"read","parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"diaryAllocationID","in":"query","required":true,"description":"The unique ID of the DiaryAllocation","schema":{"type":"string","description":"The unique ID of the DiaryAllocation"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-basic-tier/get-v2-tier2-short-name-diary-appointments":{"get":{"operationId":"ecommerce_letmc_basic_tier_get_v2_tier2_short_name_diary_appointments","summary":"A collection of all diary appointments","description":"GET /v2/tier2/{shortName}/diary/appointments","tags":["ecommerce"],"x-apizie-access":"read","parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"offset","in":"query","required":true,"description":"The index of the first item to return","schema":{"type":"integer","description":"The index of the first item to return"}},{"name":"count","in":"query","required":true,"description":"The maximum number of items to return (up to 1000 per request)","schema":{"type":"integer","description":"The maximum number of items to return (up to 1000 per request)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-basic-tier/get-v2-tier2-short-name-diary-appointments-diary-appointment":{"get":{"operationId":"ecommerce_letmc_basic_tier_get_v2_tier2_short_name_diary_appointments_diary_appointment","summary":"Get a specific diary appointment given its unique Object ID (OID)","description":"GET /v2/tier2/{shortName}/diary/appointments/{diaryAppointmentID}","tags":["ecommerce"],"x-apizie-access":"read","parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"diaryAppointmentID","in":"query","required":true,"description":"The unique ID of the DiaryAppointment","schema":{"type":"string","description":"The unique ID of the DiaryAppointment"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-basic-tier/get-v2-tier2-short-name-diary-appointmenttypes":{"get":{"operationId":"ecommerce_letmc_basic_tier_get_v2_tier2_short_name_diary_appointmenttypes","summary":"A collection of all diary appointment types","description":"GET /v2/tier2/{shortName}/diary/appointmenttypes","tags":["ecommerce"],"x-apizie-access":"read","parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"offset","in":"query","required":true,"description":"The index of the first item to return","schema":{"type":"integer","description":"The index of the first item to return"}},{"name":"count","in":"query","required":true,"description":"The maximum number of items to return (up to 1000 per request)","schema":{"type":"integer","description":"The maximum number of items to return (up to 1000 per request)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-basic-tier/get-v2-tier2-short-name-diary-appointmenttypes-diary-appoint":{"get":{"operationId":"ecommerce_letmc_basic_tier_get_v2_tier2_short_name_diary_appointmenttypes_diary_appoint","summary":"Get a specific diary appointment type given its unique Object ID (OID)","description":"GET /v2/tier2/{shortName}/diary/appointmenttypes/{diaryAppointmentTypeID}","tags":["ecommerce"],"x-apizie-access":"read","parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"diaryAppointmentTypeID","in":"query","required":true,"description":"The unique ID of the DiaryAppointmentType","schema":{"type":"string","description":"The unique ID of the DiaryAppointmentType"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-basic-tier/lettings-controller-get-advertised":{"get":{"operationId":"ecommerce_letmc_basic_tier_lettings_controller_get_advertised","summary":"Search all properties available for rent given a range of search criteria.","description":"GET /v2/tier2/{shortName}/lettings/advertised","tags":["ecommerce"],"x-apizie-access":"read","parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"branchID","in":"query","required":true,"description":"The unique ID of the Branch","schema":{"type":"string","description":"The unique ID of the Branch"}},{"name":"offset","in":"query","required":true,"description":"The index of the first item to return","schema":{"type":"integer","description":"The index of the first item to return"}},{"name":"count","in":"query","required":true,"description":"The maximum number of items to return (up to 1000 per request)","schema":{"type":"integer","description":"The maximum number of items to return (up to 1000 per request)"}},{"name":"areaID","in":"query","required":false,"description":"The unique ID of the Area","schema":{"type":"string","description":"The unique ID of the Area"}},{"name":"rentMinimum","in":"query","required":false,"description":"The minimum advertised rent to search for","schema":{"type":"number","description":"The minimum advertised rent to search for"}},{"name":"rentMaximum","in":"query","required":false,"description":"The maximum advertised rent to search for","schema":{"type":"number","description":"The maximum advertised rent to search for"}},{"name":"maximumTenants","in":"query","required":false,"description":"The maximum number of tenants a property can accommodate","schema":{"type":"integer","description":"The maximum number of tenants a property can accommodate"}},{"name":"wantSharedProperties","in":"query","required":false,"description":"Search for shared properties?","schema":{"type":"boolean","description":"Search for shared properties?"}},{"name":"wantStudentProperties","in":"query","required":false,"description":"Search for student properties?","schema":{"type":"boolean","description":"Search for student properties?"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-basic-tier/lettings-controller-get-advertised-between-dates":{"get":{"operationId":"ecommerce_letmc_basic_tier_lettings_controller_get_advertised_between_dates","summary":"Search all properties available for rent given a range of search criteria and dates.","description":"GET /v2/tier2/{shortName}/lettings/advertisedbetweendates","tags":["ecommerce"],"x-apizie-access":"read","parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"branchID","in":"query","required":true,"description":"The unique ID of the Branch","schema":{"type":"string","description":"The unique ID of the Branch"}},{"name":"offset","in":"query","required":true,"description":"The index of the first item to return","schema":{"type":"integer","description":"The index of the first item to return"}},{"name":"count","in":"query","required":true,"description":"The maximum number of items to return (up to 1000 per request)","schema":{"type":"integer","description":"The maximum number of items to return (up to 1000 per request)"}},{"name":"rangeStartDate","in":"query","required":true,"description":"The date to search from","schema":{"type":"string","description":"The date to search from"}},{"name":"rangeEndDate","in":"query","required":true,"description":"The date to search to","schema":{"type":"string","description":"The date to search to"}},{"name":"areaID","in":"query","required":false,"description":"The unique ID of the Area","schema":{"type":"string","description":"The unique ID of the Area"}},{"name":"rentMinimum","in":"query","required":false,"description":"The minimum advertised rent to search for","schema":{"type":"number","description":"The minimum advertised rent to search for"}},{"name":"rentMaximum","in":"query","required":false,"description":"The maximum advertised rent to search for","schema":{"type":"number","description":"The maximum advertised rent to search for"}},{"name":"maximumTenants","in":"query","required":false,"description":"The maximum number of tenants a property can accommodate","schema":{"type":"integer","description":"The maximum number of tenants a property can accommodate"}},{"name":"wantSharedProperties","in":"query","required":false,"description":"Search for shared properties?","schema":{"type":"boolean","description":"Search for shared properties?"}},{"name":"wantStudentProperties","in":"query","required":false,"description":"Search for student properties?","schema":{"type":"boolean","description":"Search for student properties?"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-basic-tier/get-v2-tier2-short-name-lettings-tenancies":{"get":{"operationId":"ecommerce_letmc_basic_tier_get_v2_tier2_short_name_lettings_tenancies","summary":"A collection of all the company's tenancies","description":"GET /v2/tier2/{shortName}/lettings/tenancies","tags":["ecommerce"],"x-apizie-access":"read","parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"offset","in":"query","required":true,"description":"The index of the first item to return","schema":{"type":"integer","description":"The index of the first item to return"}},{"name":"count","in":"query","required":true,"description":"The maximum number of items to return (up to 1000 per request)","schema":{"type":"integer","description":"The maximum number of items to return (up to 1000 per request)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-basic-tier/get-v2-tier2-short-name-lettings-tenancies-tenancy-id":{"get":{"operationId":"ecommerce_letmc_basic_tier_get_v2_tier2_short_name_lettings_tenancies_tenancy_id","summary":"Get a specific tenancy given its unique Object ID (OID)","description":"GET /v2/tier2/{shortName}/lettings/tenancies/{tenancyID}","tags":["ecommerce"],"x-apizie-access":"read","parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"tenancyID","in":"query","required":true,"description":"The unique ID of the Tenancy","schema":{"type":"string","description":"The unique ID of the Tenancy"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-basic-tier/lettings-controller-get-tenancy-brochure":{"get":{"operationId":"ecommerce_letmc_basic_tier_lettings_controller_get_tenancy_brochure","summary":"Downloads the brochure relating to the latest advertised rental of a property","description":"GET /v2/tier2/{shortName}/lettings/tenancies/{tenancyID}/brochure","tags":["ecommerce"],"x-apizie-access":"read","parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"tenancyID","in":"query","required":true,"description":"The unique ID of the tenancy","schema":{"type":"string","description":"The unique ID of the tenancy"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-basic-tier/get-v2-tier2-short-name-photo-photos":{"get":{"operationId":"ecommerce_letmc_basic_tier_get_v2_tier2_short_name_photo_photos","summary":"A collection of all photos in the company","description":"GET /v2/tier2/{shortName}/photo/photos","tags":["ecommerce"],"x-apizie-access":"read","parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"offset","in":"query","required":true,"description":"The index of the first item to return","schema":{"type":"integer","description":"The index of the first item to return"}},{"name":"count","in":"query","required":true,"description":"The maximum number of items to return (up to 1000 per request)","schema":{"type":"integer","description":"The maximum number of items to return (up to 1000 per request)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-basic-tier/get-v2-tier2-short-name-photo-photos-photo-id":{"get":{"operationId":"ecommerce_letmc_basic_tier_get_v2_tier2_short_name_photo_photos_photo_id","summary":"Get a specific photo given its unique Object ID (OID)","description":"GET /v2/tier2/{shortName}/photo/photos/{photoID}","tags":["ecommerce"],"x-apizie-access":"read","parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"photoID","in":"query","required":true,"description":"The unique ID of the Photo","schema":{"type":"string","description":"The unique ID of the Photo"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-basic-tier/photo-controller-get-photo-download":{"get":{"operationId":"ecommerce_letmc_basic_tier_photo_controller_get_photo_download","summary":"Downloads the photo of a property given the property and photo ID.","description":"GET /v2/tier2/{shortName}/photos/photo/{photoID}/download","tags":["ecommerce"],"x-apizie-access":"read","parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"photoID","in":"query","required":true,"description":"The unique ID of the photo on the property","schema":{"type":"string","description":"The unique ID of the photo on the property"}},{"name":"width","in":"query","required":false,"description":"An optional parameter specifying the image width","schema":{"type":"integer","description":"An optional parameter specifying the image width"}},{"name":"height","in":"query","required":false,"description":"An optional parameter specifying the image height","schema":{"type":"integer","description":"An optional parameter specifying the image height"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-basic-tier/get-v2-tier2-short-name-property-properties":{"get":{"operationId":"ecommerce_letmc_basic_tier_get_v2_tier2_short_name_property_properties","summary":"A collection of all properties within a company","description":"GET /v2/tier2/{shortName}/property/properties","tags":["ecommerce"],"x-apizie-access":"read","parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"offset","in":"query","required":true,"description":"The index of the first item to return","schema":{"type":"integer","description":"The index of the first item to return"}},{"name":"count","in":"query","required":true,"description":"The maximum number of items to return (up to 1000 per request)","schema":{"type":"integer","description":"The maximum number of items to return (up to 1000 per request)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-basic-tier/get-v2-tier2-short-name-property-properties-property-id":{"get":{"operationId":"ecommerce_letmc_basic_tier_get_v2_tier2_short_name_property_properties_property_id","summary":"Get a specific property given its unique Object ID (OID)","description":"GET /v2/tier2/{shortName}/property/properties/{propertyID}","tags":["ecommerce"],"x-apizie-access":"read","parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"propertyID","in":"query","required":true,"description":"The unique ID of the Property","schema":{"type":"string","description":"The unique ID of the Property"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-basic-tier/property-controller-get-properties-facilities":{"get":{"operationId":"ecommerce_letmc_basic_tier_property_controller_get_properties_facilities","summary":"A collection of facilities linked to a block, property or room","description":"GET /v2/tier2/{shortName}/property/properties/{propertyID}/facilities","tags":["ecommerce"],"x-apizie-access":"read","parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"propertyID","in":"query","required":true,"description":"The unique ID of the Property","schema":{"type":"string","description":"The unique ID of the Property"}},{"name":"offset","in":"query","required":true,"description":"The index of the first item to return","schema":{"type":"integer","description":"The index of the first item to return"}},{"name":"count","in":"query","required":true,"description":"The maximum number of items to return (up to 1000 per request)","schema":{"type":"integer","description":"The maximum number of items to return (up to 1000 per request)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-basic-tier/property-controller-get-properties-photos":{"get":{"operationId":"ecommerce_letmc_basic_tier_property_controller_get_properties_photos","summary":"A collection showing all the photos linked to a specific block, property or room","description":"GET /v2/tier2/{shortName}/property/properties/{propertyID}/photos","tags":["ecommerce"],"x-apizie-access":"read","parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"propertyID","in":"query","required":true,"description":"The unique ID of the Property","schema":{"type":"string","description":"The unique ID of the Property"}},{"name":"offset","in":"query","required":true,"description":"The index of the first item to return","schema":{"type":"integer","description":"The index of the first item to return"}},{"name":"count","in":"query","required":true,"description":"The maximum number of items to return (up to 1000 per request)","schema":{"type":"integer","description":"The maximum number of items to return (up to 1000 per request)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-basic-tier/property-controller-get-properties-rooms":{"get":{"operationId":"ecommerce_letmc_basic_tier_property_controller_get_properties_rooms","summary":"A collection of the rooms that belong to this property or block","description":"GET /v2/tier2/{shortName}/property/properties/{propertyID}/rooms","tags":["ecommerce"],"x-apizie-access":"read","parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"propertyID","in":"query","required":true,"description":"The unique ID of the Property","schema":{"type":"string","description":"The unique ID of the Property"}},{"name":"offset","in":"query","required":true,"description":"The index of the first item to return","schema":{"type":"integer","description":"The index of the first item to return"}},{"name":"count","in":"query","required":true,"description":"The maximum number of items to return (up to 1000 per request)","schema":{"type":"integer","description":"The maximum number of items to return (up to 1000 per request)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-basic-tier/property-controller-get-properties-tenancies":{"get":{"operationId":"ecommerce_letmc_basic_tier_property_controller_get_properties_tenancies","summary":"A collection of all tenancies associated with this block, property or room","description":"GET /v2/tier2/{shortName}/property/properties/{propertyID}/tenancies","tags":["ecommerce"],"x-apizie-access":"read","parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"propertyID","in":"query","required":true,"description":"The unique ID of the Property","schema":{"type":"string","description":"The unique ID of the Property"}},{"name":"offset","in":"query","required":true,"description":"The index of the first item to return","schema":{"type":"integer","description":"The index of the first item to return"}},{"name":"count","in":"query","required":true,"description":"The maximum number of items to return (up to 1000 per request)","schema":{"type":"integer","description":"The maximum number of items to return (up to 1000 per request)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-basic-tier/property-controller-get-property-eerdownload":{"get":{"operationId":"ecommerce_letmc_basic_tier_property_controller_get_property_eerdownload","summary":"Downloads the energy efficiency report (EER) graph for a property","description":"GET /v2/tier2/{shortName}/property/structures/{propertyStructureID}/reports/eer","tags":["ecommerce"],"x-apizie-access":"read","parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"propertyStructureID","in":"query","required":true,"description":"The unique ID of the property structure","schema":{"type":"string","description":"The unique ID of the property structure"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-basic-tier/property-controller-get-property-eirdownload":{"get":{"operationId":"ecommerce_letmc_basic_tier_property_controller_get_property_eirdownload","summary":"Downloads the environmental impact report (EIR) graph for a property","description":"GET /v2/tier2/{shortName}/property/structures/{propertyStructureID}/reports/eir","tags":["ecommerce"],"x-apizie-access":"read","parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"propertyStructureID","in":"query","required":true,"description":"The unique ID of the property structure","schema":{"type":"string","description":"The unique ID of the property structure"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-basic-tier/sales-controller-get-advertised-sales":{"get":{"operationId":"ecommerce_letmc_basic_tier_sales_controller_get_advertised_sales","summary":"Search all sales properties available given a range of search criteria","description":"GET /v2/tier2/{shortName}/sales/advertisedsales","tags":["ecommerce"],"x-apizie-access":"read","parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"branchID","in":"query","required":true,"description":"The unique ID of the Branch","schema":{"type":"string","description":"The unique ID of the Branch"}},{"name":"offset","in":"query","required":true,"description":"The index of the first item to return","schema":{"type":"integer","description":"The index of the first item to return"}},{"name":"count","in":"query","required":true,"description":"The maximum number of items to return (up to 1000 per request)","schema":{"type":"integer","description":"The maximum number of items to return (up to 1000 per request)"}},{"name":"onlyDevelopement","in":"query","required":true,"description":"Show only development properties?","schema":{"type":"boolean","description":"Show only development properties?"}},{"name":"onlyInvestements","in":"query","required":true,"description":"Show only investment properties?","schema":{"type":"boolean","description":"Show only investment properties?"}},{"name":"minimumPrice","in":"query","required":false,"description":"The minimum price to search for","schema":{"type":"number","description":"The minimum price to search for"}},{"name":"maximumPrice","in":"query","required":false,"description":"The maximum price to search for","schema":{"type":"number","description":"The maximum price to search for"}},{"name":"minimumBeds","in":"query","required":false,"description":"The minimum beds to search for","schema":{"type":"integer","description":"The minimum beds to search for"}},{"name":"minimumBathrooms","in":"query","required":false,"description":"The minimum bathrooms to search for","schema":{"type":"integer","description":"The minimum bathrooms to search for"}},{"name":"minimumEnsuites","in":"query","required":false,"description":"The minimum ensuite bathrooms to search for","schema":{"type":"integer","description":"The minimum ensuite bathrooms to search for"}},{"name":"minimumToilets","in":"query","required":false,"description":"The minimum toilets to search for","schema":{"type":"integer","description":"The minimum toilets to search for"}},{"name":"minimumReception","in":"query","required":false,"description":"The minimum reception rooms to search for","schema":{"type":"integer","description":"The minimum reception rooms to search for"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-basic-tier/sales-controller-get-eer":{"get":{"operationId":"ecommerce_letmc_basic_tier_sales_controller_get_eer","summary":"Downloads the energy efficiency report (EER) graph for a sales instruction","description":"GET /v2/tier2/{shortName}/sales/reports/eer/{salesInstructionID}","tags":["ecommerce"],"x-apizie-access":"read","parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"salesInstructionID","in":"query","required":true,"description":"The unique ID of the SalesInstruction","schema":{"type":"string","description":"The unique ID of the SalesInstruction"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-basic-tier/sales-controller-get-eir":{"get":{"operationId":"ecommerce_letmc_basic_tier_sales_controller_get_eir","summary":"Downloads the energy efficiency report (EIR) graph for a sales instruction","description":"GET /v2/tier2/{shortName}/sales/reports/eir/{salesInstructionID}","tags":["ecommerce"],"x-apizie-access":"read","parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"salesInstructionID","in":"query","required":true,"description":"The unique ID of the SalesInstruction","schema":{"type":"string","description":"The unique ID of the SalesInstruction"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-basic-tier/get-v2-tier2-short-name-sales-salesfeaturetypes":{"get":{"operationId":"ecommerce_letmc_basic_tier_get_v2_tier2_short_name_sales_salesfeaturetypes","summary":"A collection of all sales feature types linked to a company","description":"GET /v2/tier2/{shortName}/sales/salesfeaturetypes","tags":["ecommerce"],"x-apizie-access":"read","parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"offset","in":"query","required":true,"description":"The index of the first item to return","schema":{"type":"integer","description":"The index of the first item to return"}},{"name":"count","in":"query","required":true,"description":"The maximum number of items to return (up to 1000 per request)","schema":{"type":"integer","description":"The maximum number of items to return (up to 1000 per request)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-basic-tier/get-v2-tier2-short-name-sales-salesfeaturetypes-sales-featur":{"get":{"operationId":"ecommerce_letmc_basic_tier_get_v2_tier2_short_name_sales_salesfeaturetypes_sales_featur","summary":"Get a specific sales feature type given its unique Object ID (OID)","description":"GET /v2/tier2/{shortName}/sales/salesfeaturetypes/{salesFeatureTypeID}","tags":["ecommerce"],"x-apizie-access":"read","parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"salesFeatureTypeID","in":"query","required":true,"description":"The unique ID of the SalesFeatureType","schema":{"type":"string","description":"The unique ID of the SalesFeatureType"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-basic-tier/get-v2-tier2-short-name-sales-salesinstructions":{"get":{"operationId":"ecommerce_letmc_basic_tier_get_v2_tier2_short_name_sales_salesinstructions","summary":"A collection of all sales instructions linked to a company","description":"GET /v2/tier2/{shortName}/sales/salesinstructions","tags":["ecommerce"],"x-apizie-access":"read","parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"offset","in":"query","required":true,"description":"The index of the first item to return","schema":{"type":"integer","description":"The index of the first item to return"}},{"name":"count","in":"query","required":true,"description":"The maximum number of items to return (up to 1000 per request)","schema":{"type":"integer","description":"The maximum number of items to return (up to 1000 per request)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-basic-tier/get-v2-tier2-short-name-sales-salesinstructions-sales-instru":{"get":{"operationId":"ecommerce_letmc_basic_tier_get_v2_tier2_short_name_sales_salesinstructions_sales_instru","summary":"Get a specific sales instruction given its unique Object ID (OID)","description":"GET /v2/tier2/{shortName}/sales/salesinstructions/{salesInstructionID}","tags":["ecommerce"],"x-apizie-access":"read","parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"salesInstructionID","in":"query","required":true,"description":"The unique ID of the SalesInstruction","schema":{"type":"string","description":"The unique ID of the SalesInstruction"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-basic-tier/sales-controller-get-sales-instructions-features":{"get":{"operationId":"ecommerce_letmc_basic_tier_sales_controller_get_sales_instructions_features","summary":"A collection of all features linked to a sales instruction","description":"GET /v2/tier2/{shortName}/sales/salesinstructions/{salesInstructionID}/features","tags":["ecommerce"],"x-apizie-access":"read","parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"salesInstructionID","in":"query","required":true,"description":"The unique ID of the SalesInstruction","schema":{"type":"string","description":"The unique ID of the SalesInstruction"}},{"name":"offset","in":"query","required":true,"description":"The index of the first item to return","schema":{"type":"integer","description":"The index of the first item to return"}},{"name":"count","in":"query","required":true,"description":"The maximum number of items to return (up to 1000 per request)","schema":{"type":"integer","description":"The maximum number of items to return (up to 1000 per request)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-basic-tier/sales-controller-get-sales-instructions-floor-plans":{"get":{"operationId":"ecommerce_letmc_basic_tier_sales_controller_get_sales_instructions_floor_plans","summary":"A collection of floor plans linked to an instruction","description":"GET /v2/tier2/{shortName}/sales/salesinstructions/{salesInstructionID}/floorplans","tags":["ecommerce"],"x-apizie-access":"read","parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"salesInstructionID","in":"query","required":true,"description":"The unique ID of the SalesInstruction","schema":{"type":"string","description":"The unique ID of the SalesInstruction"}},{"name":"offset","in":"query","required":true,"description":"The index of the first item to return","schema":{"type":"integer","description":"The index of the first item to return"}},{"name":"count","in":"query","required":true,"description":"The maximum number of items to return (up to 1000 per request)","schema":{"type":"integer","description":"The maximum number of items to return (up to 1000 per request)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-basic-tier/sales-controller-get-sales-instructions-photos":{"get":{"operationId":"ecommerce_letmc_basic_tier_sales_controller_get_sales_instructions_photos","summary":"A collection of photos linked to an instruction","description":"GET /v2/tier2/{shortName}/sales/salesinstructions/{salesInstructionID}/photos","tags":["ecommerce"],"x-apizie-access":"read","parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"salesInstructionID","in":"query","required":true,"description":"The unique ID of the SalesInstruction","schema":{"type":"string","description":"The unique ID of the SalesInstruction"}},{"name":"offset","in":"query","required":true,"description":"The index of the first item to return","schema":{"type":"integer","description":"The index of the first item to return"}},{"name":"count","in":"query","required":true,"description":"The maximum number of items to return (up to 1000 per request)","schema":{"type":"integer","description":"The maximum number of items to return (up to 1000 per request)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-basic-tier/sales-controller-get-sales-instructions-rooms":{"get":{"operationId":"ecommerce_letmc_basic_tier_sales_controller_get_sales_instructions_rooms","summary":"A collection of rooms linked to an instruction","description":"GET /v2/tier2/{shortName}/sales/salesinstructions/{salesInstructionID}/rooms","tags":["ecommerce"],"x-apizie-access":"read","parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"salesInstructionID","in":"query","required":true,"description":"The unique ID of the SalesInstruction","schema":{"type":"string","description":"The unique ID of the SalesInstruction"}},{"name":"offset","in":"query","required":true,"description":"The index of the first item to return","schema":{"type":"integer","description":"The index of the first item to return"}},{"name":"count","in":"query","required":true,"description":"The maximum number of items to return (up to 1000 per request)","schema":{"type":"integer","description":"The maximum number of items to return (up to 1000 per request)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-basic-tier/get-v2-tier2-short-name-staff-staff":{"get":{"operationId":"ecommerce_letmc_basic_tier_get_v2_tier2_short_name_staff_staff","summary":"A collection of all the staff members linked to a specific company","description":"GET /v2/tier2/{shortName}/staff/staff","tags":["ecommerce"],"x-apizie-access":"read","parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"offset","in":"query","required":true,"description":"The index of the first item to return","schema":{"type":"integer","description":"The index of the first item to return"}},{"name":"count","in":"query","required":true,"description":"The maximum number of items to return (up to 1000 per request)","schema":{"type":"integer","description":"The maximum number of items to return (up to 1000 per request)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-basic-tier/get-v2-tier2-short-name-staff-staff-application-staff-id":{"get":{"operationId":"ecommerce_letmc_basic_tier_get_v2_tier2_short_name_staff_staff_application_staff_id","summary":"Get a specific application staff given its unique Object ID (OID)","description":"GET /v2/tier2/{shortName}/staff/staff/{applicationStaffID}","tags":["ecommerce"],"x-apizie-access":"read","parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"applicationStaffID","in":"query","required":true,"description":"The unique ID of the ApplicationStaff","schema":{"type":"string","description":"The unique ID of the ApplicationStaff"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-basic-tier/viewing-controller-get-bookings":{"get":{"operationId":"ecommerce_letmc_basic_tier_viewing_controller_get_bookings","summary":"Gets a list of available viewing slots for one or more properties","description":"GET /v2/tier2/{shortName}/viewing/bookings","tags":["ecommerce"],"x-apizie-access":"read","parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"preferredDate","in":"query","required":true,"description":"The preferred date for a viewing","schema":{"type":"string","description":"The preferred date for a viewing"}},{"name":"propertyIDsToView","in":"query","required":true,"description":"An array of unique IDs of properties to view","schema":{"type":"array","description":"An array of unique IDs of properties to view"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-basic-tier/viewing-controller-make-booking":{"post":{"operationId":"ecommerce_letmc_basic_tier_viewing_controller_make_booking","summary":"Book an appointment for a viewing slot returned from the GET verb","description":"POST /v2/tier2/{shortName}/viewing/bookings","tags":["ecommerce"],"x-apizie-access":"read","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["shortName","forename","surname","mobilePhone","emailAddress","propertyIDsToView","body"],"properties":{"shortName":{"type":"string","description":"The unique client short-name"},"forename":{"type":"string","description":"The forename of the prospect"},"surname":{"type":"string","description":"The surname of the prospect"},"mobilePhone":{"type":"string","description":"The mobile phone number of the prospect"},"emailAddress":{"type":"string","description":"The email address of the prospect"},"propertyIDsToView":{"type":"array","description":"An array of unique IDs of properties to view"},"wantRoomInSharedProperty":{"type":"boolean","description":"Whether the prospect wants a shared property"},"alertMinRent":{"type":"number","description":"The minimum rent amount the prospect is looking for"},"alertMaxRent":{"type":"number","description":"The maximum rent amount the prospect is looking for"},"alertNumberOfBeds":{"type":"integer","description":"The minimum number of beds the prospect is looking for"},"alertAreaID":{"type":"string","description":"The unique ID of the area the prospect is looking for"},"alertTenantType":{"type":"string","enum":["Employed","SelfEmployed","Unemployed","Student","OwnMeans","Retired","Company","Council"],"description":"The tenanct type the prospect is looking for"},"subscribeToEmailAlerts":{"type":"boolean","description":"Whether to subscribe the prospect to email alerts"},"subscribeToSMSAlerts":{"type":"boolean","description":"Whether to subscribe the prospect to SMS alerts"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"official:company"},"data":{},"source":{"type":"object","description":"Where the data came from. Cite it.","properties":{"official":{"type":"boolean"},"provider":{"type":"string","example":"SEC EDGAR"},"publisher":{"type":"string","example":"U.S. Securities and Exchange Commission"},"url":{"type":"string","format":"uri","description":"A page a person can open to check the value"},"apiUrl":{"type":"string","format":"uri","description":"The official API URL that was called (credentials removed)"},"retrievedAt":{"type":"string","format":"date-time"},"license":{"type":"string"},"licenseUrl":{"type":"string","format":"uri"},"attribution":{"type":"string"},"notice":{"type":"string"}}},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}