{ "uuid": "a4fac00b-5188-4969-bee6-ac8f4d6b7a92", "lastMigration": 19, "name": "LetMC Api V2, Free (Tier 1)", "endpointPrefix": "", "latency": 0, "port": 3000, "hostname": "0.0.0.0", "routes": [ { "uuid": "270ed5be-18f8-4033-9616-08ae632040d7", "documentation": "A collection of all the areas for a company", "method": "get", "endpoint": "v2/tier1/:shortName/area/areas", "responses": [ { "uuid": "e1b2affe-133e-4ecd-a9f9-a8c97d381c8a", "body": "{\n \"Count\": {{faker 'random.number'}},\n \"Data\": [\n {\n \"Branch\": \"\",\n \"ETag\": \"\",\n \"Name\": \"\",\n \"OID\": \"\",\n \"ShowOnSites\": {{faker 'random.boolean'}}\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "0cdfddee-4a82-4c75-9f17-e27da6049868", "documentation": "Get a specific area given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier1/:shortName/area/areas/:areaID", "responses": [ { "uuid": "c196e108-a361-4436-a6a2-844bef0fec28", "body": "{\n \"Branch\": \"\",\n \"ETag\": \"\",\n \"Name\": \"\",\n \"OID\": \"\",\n \"ShowOnSites\": {{faker 'random.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "aa0ddd35-287d-41bd-9083-540018c894e6", "documentation": "All branches defined for a company", "method": "get", "endpoint": "v2/tier1/:shortName/branch/branches", "responses": [ { "uuid": "2136d635-e941-4977-9af4-072857bb3a0a", "body": "{\n \"Count\": {{faker 'random.number'}},\n \"Data\": [\n {\n \"Address1\": \"\",\n \"Address2\": \"\",\n \"Address3\": \"\",\n \"Address4\": \"\",\n \"CompanyName\": \"\",\n \"County\": \"\",\n \"EMailAddress\": \"\",\n \"ETag\": \"\",\n \"FaxPhone\": \"\",\n \"LandPhone\": \"\",\n \"Name\": \"\",\n \"OID\": \"\",\n \"Postcode\": \"\",\n \"WebAddress\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "6a7d02a1-4eec-4836-bdef-8e8f2c4f4cc6", "documentation": "Get a specific branch given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier1/:shortName/branch/branches/:branchID", "responses": [ { "uuid": "b5276e39-3ef3-4f3e-9ee3-321f78b8d431", "body": "{\n \"Address1\": \"\",\n \"Address2\": \"\",\n \"Address3\": \"\",\n \"Address4\": \"\",\n \"CompanyName\": \"\",\n \"County\": \"\",\n \"EMailAddress\": \"\",\n \"ETag\": \"\",\n \"FaxPhone\": \"\",\n \"LandPhone\": \"\",\n \"Name\": \"\",\n \"OID\": \"\",\n \"Postcode\": \"\",\n \"WebAddress\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "91ca8fc6-a77f-4768-9c01-c61f951a516e", "documentation": "Information about a specific company", "method": "get", "endpoint": "v2/tier1/:shortName/company", "responses": [ { "uuid": "960bb474-f6b6-4636-9407-e3835a397c4b", "body": "{\n \"CompanyName\": \"\",\n \"CompanyRegistration\": \"\",\n \"ETag\": \"\",\n \"MarketingCompanyName\": \"\",\n \"OID\": \"\",\n \"ShortName\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "90de4c44-516a-4336-9068-3ffca2ff3baf", "documentation": "A collection of all counties available for a company", "method": "get", "endpoint": "v2/tier1/:shortName/county/counties", "responses": [ { "uuid": "95a270af-7612-4347-be65-3b163289c624", "body": "{\n \"Count\": {{faker 'random.number'}},\n \"Data\": [\n {\n \"ETag\": \"\",\n \"Name\": \"\",\n \"OID\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "2d869b36-ebc2-4842-9e28-50f5eb74474b", "documentation": "Get a specific county given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier1/:shortName/county/counties/:countyID", "responses": [ { "uuid": "dfd71393-37b6-4b95-9a02-8445b3e01135", "body": "{\n \"ETag\": \"\",\n \"Name\": \"\",\n \"OID\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "dec56ee2-f126-4923-bbb4-3bfd2ea098a6", "documentation": "A collection of branches that manage a specific county", "method": "get", "endpoint": "v2/tier1/:shortName/county/counties/:countyID/branches", "responses": [ { "uuid": "9c266935-a667-400b-91ca-a03d7357e4ae", "body": "{\n \"Count\": {{faker 'random.number'}},\n \"Data\": [\n {\n \"Address1\": \"\",\n \"Address2\": \"\",\n \"Address3\": \"\",\n \"Address4\": \"\",\n \"CompanyName\": \"\",\n \"County\": \"\",\n \"EMailAddress\": \"\",\n \"ETag\": \"\",\n \"FaxPhone\": \"\",\n \"LandPhone\": \"\",\n \"Name\": \"\",\n \"OID\": \"\",\n \"Postcode\": \"\",\n \"WebAddress\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "b09a4f0f-6a85-4503-8878-07ea4dc70bd1", "documentation": "A collection of all diary allocations", "method": "get", "endpoint": "v2/tier1/:shortName/diary/allocations", "responses": [ { "uuid": "a151a8ad-a90b-4cb1-abad-dc2f735eb024", "body": "{\n \"Count\": {{faker 'random.number'}},\n \"Data\": [\n {\n \"AppointmentType\": \"\",\n \"ETag\": \"\",\n \"End\": \"{{faker 'date.recent' 365}}\",\n \"OID\": \"\",\n \"Staff\": \"\",\n \"Start\": \"{{faker 'date.recent' 365}}\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "2ca0ca77-28b7-4d33-bafd-4805cfdbc1f9", "documentation": "Get a specific diary allocation given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier1/:shortName/diary/allocations/:diaryAllocationID", "responses": [ { "uuid": "65684f96-13fe-4ecd-bc23-34cc924eddc3", "body": "{\n \"AppointmentType\": \"\",\n \"ETag\": \"\",\n \"End\": \"{{faker 'date.recent' 365}}\",\n \"OID\": \"\",\n \"Staff\": \"\",\n \"Start\": \"{{faker 'date.recent' 365}}\"\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "05f94012-7572-4393-890f-496d67fd30f5", "documentation": "A collection of all diary appointments", "method": "get", "endpoint": "v2/tier1/:shortName/diary/appointments", "responses": [ { "uuid": "5977d911-7824-4ab2-a930-6c80e796adcc", "body": "{\n \"Count\": {{faker 'random.number'}},\n \"Data\": [\n {\n \"AppointmentType\": \"\",\n \"Cancelled\": {{faker 'random.boolean'}},\n \"Comment\": \"\",\n \"CreatedAt\": \"{{faker 'date.recent' 365}}\",\n \"CreatedBy\": \"\",\n \"ETag\": \"\",\n \"End\": \"{{faker 'date.recent' 365}}\",\n \"OID\": \"\",\n \"RemindAt\": \"{{faker 'date.recent' 365}}\",\n \"RemindBefore\": \"{{oneOf (array 'Min' 'Min2' 'Min5' 'Min10' 'Min15' 'Min30' 'Min45' 'Hour' 'Hour2' 'Hour3' 'Hour6' 'Hour12' 'Day' 'Day2' 'Day3' 'Week' 'NoReminder')}}\",\n \"Staff\": \"\",\n \"Start\": \"{{faker 'date.recent' 365}}\",\n \"Subject\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "182b6b4c-52b3-4b8a-b116-ee39cacb8d9e", "documentation": "Get a specific diary appointment given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier1/:shortName/diary/appointments/:diaryAppointmentID", "responses": [ { "uuid": "138f68d5-319a-41be-a0bb-d41be5b9338a", "body": "{\n \"AppointmentType\": \"\",\n \"Cancelled\": {{faker 'random.boolean'}},\n \"Comment\": \"\",\n \"CreatedAt\": \"{{faker 'date.recent' 365}}\",\n \"CreatedBy\": \"\",\n \"ETag\": \"\",\n \"End\": \"{{faker 'date.recent' 365}}\",\n \"OID\": \"\",\n \"RemindAt\": \"{{faker 'date.recent' 365}}\",\n \"RemindBefore\": \"{{oneOf (array 'Min' 'Min2' 'Min5' 'Min10' 'Min15' 'Min30' 'Min45' 'Hour' 'Hour2' 'Hour3' 'Hour6' 'Hour12' 'Day' 'Day2' 'Day3' 'Week' 'NoReminder')}}\",\n \"Staff\": \"\",\n \"Start\": \"{{faker 'date.recent' 365}}\",\n \"Subject\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "3baa2a30-bc3d-4e70-8ed2-724d43cdff0a", "documentation": "A collection of all diary appointment types", "method": "get", "endpoint": "v2/tier1/:shortName/diary/appointmenttypes", "responses": [ { "uuid": "8482945c-4464-488d-ba88-8ddf1206fe72", "body": "{\n \"Count\": {{faker 'random.number'}},\n \"Data\": [\n {\n \"ETag\": \"\",\n \"Name\": \"\",\n \"OID\": \"\",\n \"SystemType\": \"{{oneOf (array 'Viewing' 'ViewAndValue' 'OpeningInspection' 'InterimInspection' 'ClosingInspection' 'SalesAppraisal' 'Custom')}}\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "e5d622f3-9bfd-4aea-a0d1-ee4b2ebb5870", "documentation": "Get a specific diary appointment type given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier1/:shortName/diary/appointmenttypes/:diaryAppointmentTypeID", "responses": [ { "uuid": "7e0ed5ba-33f0-49c8-bec6-ce9d45e318bc", "body": "{\n \"ETag\": \"\",\n \"Name\": \"\",\n \"OID\": \"\",\n \"SystemType\": \"{{oneOf (array 'Viewing' 'ViewAndValue' 'OpeningInspection' 'InterimInspection' 'ClosingInspection' 'SalesAppraisal' 'Custom')}}\"\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "718adba9-7c0f-4a45-938a-ec25d659f26e", "documentation": "Search all properties available for rent given a range of search criteria.", "method": "get", "endpoint": "v2/tier1/:shortName/lettings/advertised", "responses": [ { "uuid": "c7172071-5423-428c-9d9c-8f742424fa61", "body": "{\n \"Count\": {{faker 'random.number'}},\n \"Data\": [\n {\n \"AdvertiseFrom\": \"{{faker 'date.recent' 365}}\",\n \"Area\": \"\",\n \"BondRequired\": {{faker 'random.float'}},\n \"Branch\": \"\",\n \"ETag\": \"\",\n \"Furnished\": \"{{oneOf (array 'Unfurnished' 'PartFurnished' 'Furnished')}}\",\n \"GlobalReference\": \"\",\n \"IsShareProperty\": {{faker 'random.boolean'}},\n \"IsStudentProperty\": {{faker 'random.boolean'}},\n \"IsTenancyAdvertised\": {{faker 'random.boolean'}},\n \"IsTenancyProposed\": {{faker 'random.boolean'}},\n \"MaximumTenants\": {{faker 'random.number'}},\n \"MinimumTenants\": {{faker 'random.number'}},\n \"OID\": \"\",\n \"RentAdvertised\": {{faker 'random.float'}},\n \"RentRecurrence\": {{faker 'random.number'}},\n \"RentSchedule\": \"{{oneOf (array 'Once' 'Daily' 'Weekly' 'Monthly' 'Yearly')}}\",\n \"TenancyProperty\": \"\",\n \"TenantSystemTypes\": [\n \"{{oneOf (array 'Employed' 'SelfEmployed' 'Unemployed' 'Student' 'OwnMeans' 'Retired' 'Company' 'Council')}}\"\n ],\n \"TermMaximum\": {{faker 'random.number'}},\n \"TermMinimum\": {{faker 'random.number'}},\n \"TermStart\": \"{{faker 'date.recent' 365}}\",\n \"UtilityCouncilTax\": \"{{oneOf (array 'Tenant' 'Landlord')}}\",\n \"UtilityElectricity\": \"{{oneOf (array 'Tenant' 'Landlord')}}\",\n \"UtilityGas\": \"{{oneOf (array 'Tenant' 'Landlord')}}\",\n \"UtilityTelephone\": \"{{oneOf (array 'Tenant' 'Landlord')}}\",\n \"UtilityWater\": \"{{oneOf (array 'Tenant' 'Landlord')}}\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "5d10cb51-de4b-4560-864f-46b429470d79", "documentation": "Search all properties available for rent given a range of search criteria and dates.", "method": "get", "endpoint": "v2/tier1/:shortName/lettings/advertisedbetweendates", "responses": [ { "uuid": "61064fc1-5bbf-4205-a2ab-95fc412f87bb", "body": "{\n \"Count\": {{faker 'random.number'}},\n \"Data\": [\n {\n \"AdvertiseFrom\": \"{{faker 'date.recent' 365}}\",\n \"Area\": \"\",\n \"BondRequired\": {{faker 'random.float'}},\n \"Branch\": \"\",\n \"ETag\": \"\",\n \"Furnished\": \"{{oneOf (array 'Unfurnished' 'PartFurnished' 'Furnished')}}\",\n \"GlobalReference\": \"\",\n \"IsShareProperty\": {{faker 'random.boolean'}},\n \"IsStudentProperty\": {{faker 'random.boolean'}},\n \"IsTenancyAdvertised\": {{faker 'random.boolean'}},\n \"IsTenancyProposed\": {{faker 'random.boolean'}},\n \"MaximumTenants\": {{faker 'random.number'}},\n \"MinimumTenants\": {{faker 'random.number'}},\n \"OID\": \"\",\n \"RentAdvertised\": {{faker 'random.float'}},\n \"RentRecurrence\": {{faker 'random.number'}},\n \"RentSchedule\": \"{{oneOf (array 'Once' 'Daily' 'Weekly' 'Monthly' 'Yearly')}}\",\n \"TenancyProperty\": \"\",\n \"TenantSystemTypes\": [\n \"{{oneOf (array 'Employed' 'SelfEmployed' 'Unemployed' 'Student' 'OwnMeans' 'Retired' 'Company' 'Council')}}\"\n ],\n \"TermMaximum\": {{faker 'random.number'}},\n \"TermMinimum\": {{faker 'random.number'}},\n \"TermStart\": \"{{faker 'date.recent' 365}}\",\n \"UtilityCouncilTax\": \"{{oneOf (array 'Tenant' 'Landlord')}}\",\n \"UtilityElectricity\": \"{{oneOf (array 'Tenant' 'Landlord')}}\",\n \"UtilityGas\": \"{{oneOf (array 'Tenant' 'Landlord')}}\",\n \"UtilityTelephone\": \"{{oneOf (array 'Tenant' 'Landlord')}}\",\n \"UtilityWater\": \"{{oneOf (array 'Tenant' 'Landlord')}}\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "09b4ecc0-882e-4bf6-a8bb-7603167d5993", "documentation": "A collection of all the company's tenancies", "method": "get", "endpoint": "v2/tier1/:shortName/lettings/tenancies", "responses": [ { "uuid": "2fce729c-1c70-449a-915f-c3c141ec3429", "body": "{\n \"Count\": {{faker 'random.number'}},\n \"Data\": [\n {\n \"AdvertiseFrom\": \"{{faker 'date.recent' 365}}\",\n \"Area\": \"\",\n \"BondRequired\": {{faker 'random.float'}},\n \"Branch\": \"\",\n \"ETag\": \"\",\n \"Furnished\": \"{{oneOf (array 'Unfurnished' 'PartFurnished' 'Furnished')}}\",\n \"GlobalReference\": \"\",\n \"IsShareProperty\": {{faker 'random.boolean'}},\n \"IsStudentProperty\": {{faker 'random.boolean'}},\n \"IsTenancyAdvertised\": {{faker 'random.boolean'}},\n \"IsTenancyProposed\": {{faker 'random.boolean'}},\n \"MaximumTenants\": {{faker 'random.number'}},\n \"MinimumTenants\": {{faker 'random.number'}},\n \"OID\": \"\",\n \"RentAdvertised\": {{faker 'random.float'}},\n \"RentRecurrence\": {{faker 'random.number'}},\n \"RentSchedule\": \"{{oneOf (array 'Once' 'Daily' 'Weekly' 'Monthly' 'Yearly')}}\",\n \"TenancyProperty\": \"\",\n \"TenantSystemTypes\": [\n \"{{oneOf (array 'Employed' 'SelfEmployed' 'Unemployed' 'Student' 'OwnMeans' 'Retired' 'Company' 'Council')}}\"\n ],\n \"TermMaximum\": {{faker 'random.number'}},\n \"TermMinimum\": {{faker 'random.number'}},\n \"TermStart\": \"{{faker 'date.recent' 365}}\",\n \"UtilityCouncilTax\": \"{{oneOf (array 'Tenant' 'Landlord')}}\",\n \"UtilityElectricity\": \"{{oneOf (array 'Tenant' 'Landlord')}}\",\n \"UtilityGas\": \"{{oneOf (array 'Tenant' 'Landlord')}}\",\n \"UtilityTelephone\": \"{{oneOf (array 'Tenant' 'Landlord')}}\",\n \"UtilityWater\": \"{{oneOf (array 'Tenant' 'Landlord')}}\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "5a01fa51-5977-44ca-8b80-9e3f853dc4ee", "documentation": "Get a specific tenancy given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier1/:shortName/lettings/tenancies/:tenancyID", "responses": [ { "uuid": "fa83c4b4-f0c3-4a3f-9b45-e44bf51738c6", "body": "{\n \"AdvertiseFrom\": \"{{faker 'date.recent' 365}}\",\n \"Area\": \"\",\n \"BondRequired\": {{faker 'random.float'}},\n \"Branch\": \"\",\n \"ETag\": \"\",\n \"Furnished\": \"{{oneOf (array 'Unfurnished' 'PartFurnished' 'Furnished')}}\",\n \"GlobalReference\": \"\",\n \"IsShareProperty\": {{faker 'random.boolean'}},\n \"IsStudentProperty\": {{faker 'random.boolean'}},\n \"IsTenancyAdvertised\": {{faker 'random.boolean'}},\n \"IsTenancyProposed\": {{faker 'random.boolean'}},\n \"MaximumTenants\": {{faker 'random.number'}},\n \"MinimumTenants\": {{faker 'random.number'}},\n \"OID\": \"\",\n \"RentAdvertised\": {{faker 'random.float'}},\n \"RentRecurrence\": {{faker 'random.number'}},\n \"RentSchedule\": \"{{oneOf (array 'Once' 'Daily' 'Weekly' 'Monthly' 'Yearly')}}\",\n \"TenancyProperty\": \"\",\n \"TenantSystemTypes\": [\n \"{{oneOf (array 'Employed' 'SelfEmployed' 'Unemployed' 'Student' 'OwnMeans' 'Retired' 'Company' 'Council')}}\"\n ],\n \"TermMaximum\": {{faker 'random.number'}},\n \"TermMinimum\": {{faker 'random.number'}},\n \"TermStart\": \"{{faker 'date.recent' 365}}\",\n \"UtilityCouncilTax\": \"{{oneOf (array 'Tenant' 'Landlord')}}\",\n \"UtilityElectricity\": \"{{oneOf (array 'Tenant' 'Landlord')}}\",\n \"UtilityGas\": \"{{oneOf (array 'Tenant' 'Landlord')}}\",\n \"UtilityTelephone\": \"{{oneOf (array 'Tenant' 'Landlord')}}\",\n \"UtilityWater\": \"{{oneOf (array 'Tenant' 'Landlord')}}\"\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "41299d6c-f41f-4242-b683-6519962e052a", "documentation": "Downloads the brochure relating to the latest advertised rental of a property", "method": "get", "endpoint": "v2/tier1/:shortName/lettings/tenancies/:tenancyID/brochure", "responses": [ { "uuid": "6070b9f0-858c-4f98-b6b6-1c70cfccb310", "body": "{}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "efc8200e-4a50-4b92-9dc7-4c59a6f5c134", "documentation": "A collection of all photos in the company", "method": "get", "endpoint": "v2/tier1/:shortName/photo/photos", "responses": [ { "uuid": "dda81377-ad27-4c25-9a53-092f0f1d7176", "body": "{\n \"Count\": {{faker 'random.number'}},\n \"Data\": [\n {\n \"ETag\": \"\",\n \"FileName\": \"\",\n \"InspectionItem\": \"\",\n \"InterimInspection\": \"\",\n \"InventoryItem\": \"\",\n \"Name\": \"\",\n \"OID\": \"\",\n \"PhotoNumber\": {{faker 'random.number'}},\n \"PhotoType\": \"{{oneOf (array 'Photo' 'Map' 'FloorPlan' 'SiteMap' 'AerialPhoto')}}\",\n \"Property\": \"\",\n \"Room\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "04a6bf5f-ea11-418d-9538-31c755733032", "documentation": "Get a specific photo given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier1/:shortName/photo/photos/:photoID", "responses": [ { "uuid": "be5350cb-dace-4468-815d-492e28cd3a2a", "body": "{\n \"ETag\": \"\",\n \"FileName\": \"\",\n \"InspectionItem\": \"\",\n \"InterimInspection\": \"\",\n \"InventoryItem\": \"\",\n \"Name\": \"\",\n \"OID\": \"\",\n \"PhotoNumber\": {{faker 'random.number'}},\n \"PhotoType\": \"{{oneOf (array 'Photo' 'Map' 'FloorPlan' 'SiteMap' 'AerialPhoto')}}\",\n \"Property\": \"\",\n \"Room\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "053326ea-d618-42c9-9788-6f9c3e2c6356", "documentation": "Downloads the photo of a property given the property and photo ID.", "method": "get", "endpoint": "v2/tier1/:shortName/photos/photo/:photoID/download", "responses": [ { "uuid": "e8f30720-c167-4da8-b0c9-411bcce3832c", "body": "{}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "75ed9b92-1944-4f88-baca-200f71da6688", "documentation": "A collection of all properties within a company", "method": "get", "endpoint": "v2/tier1/:shortName/property/properties", "responses": [ { "uuid": "a81560b2-0e1a-4251-beba-1201da47065b", "body": "{\n \"Count\": {{faker 'random.number'}},\n \"Data\": [\n {\n \"Area\": \"\",\n \"Branch\": \"\",\n \"Description\": \"\",\n \"ETag\": \"\",\n \"FullAddress\": \"\",\n \"GlobalReference\": \"\",\n \"MainPhoto\": \"\",\n \"ManagedByStaff\": \"\",\n \"OID\": \"\",\n \"PropertySource\": \"\",\n \"PropertyType\": \"{{oneOf (array 'House' 'FlatApartment' 'Bungalow' 'Land' 'HouseFlatShare' 'GarageParking' 'CommercialProperty' 'Block' 'TerracedHouse' 'EndTerraceHouse' 'SemiDetachedHouse' 'DetachedHouse' 'SemiDetachedBungalow' 'TownHouse' 'Cottage' 'ServicedApartment' 'Studio' 'Apartment' 'Barn' 'FarmHouse' 'Penthouse' 'BuildingPlot' 'DetachedBungalow' 'LinkDetached' 'MidTerracedBungalow' 'LandResidential')}}\",\n \"RoomName\": \"\",\n \"VideoURL\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "a776f46e-ed18-4c44-b67a-099047e15dc5", "documentation": "Get a specific property given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier1/:shortName/property/properties/:propertyID", "responses": [ { "uuid": "d208e39e-b574-42b4-87ba-245543d9bea1", "body": "{\n \"Area\": \"\",\n \"Branch\": \"\",\n \"Description\": \"\",\n \"ETag\": \"\",\n \"FullAddress\": \"\",\n \"GlobalReference\": \"\",\n \"MainPhoto\": \"\",\n \"ManagedByStaff\": \"\",\n \"OID\": \"\",\n \"PropertySource\": \"\",\n \"PropertyType\": \"{{oneOf (array 'House' 'FlatApartment' 'Bungalow' 'Land' 'HouseFlatShare' 'GarageParking' 'CommercialProperty' 'Block' 'TerracedHouse' 'EndTerraceHouse' 'SemiDetachedHouse' 'DetachedHouse' 'SemiDetachedBungalow' 'TownHouse' 'Cottage' 'ServicedApartment' 'Studio' 'Apartment' 'Barn' 'FarmHouse' 'Penthouse' 'BuildingPlot' 'DetachedBungalow' 'LinkDetached' 'MidTerracedBungalow' 'LandResidential')}}\",\n \"RoomName\": \"\",\n \"VideoURL\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "878db806-46cf-4d6f-9381-d554d254a3a6", "documentation": "A collection of facilities linked to a block, property or room", "method": "get", "endpoint": "v2/tier1/:shortName/property/properties/:propertyID/facilities", "responses": [ { "uuid": "7dfa39a4-7c88-4e2c-b5d0-cf02d5b0b15d", "body": "{\n \"Count\": {{faker 'random.number'}},\n \"Data\": [\n {\n \"ETag\": \"\",\n \"Name\": \"\",\n \"OID\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "2488cb4c-17fe-4309-8025-12d191f67eee", "documentation": "A collection showing all the photos linked to a specific block, property or room", "method": "get", "endpoint": "v2/tier1/:shortName/property/properties/:propertyID/photos", "responses": [ { "uuid": "165650df-43cb-4de9-a739-ce2ffd563701", "body": "{\n \"Count\": {{faker 'random.number'}},\n \"Data\": [\n {\n \"ETag\": \"\",\n \"FileName\": \"\",\n \"InspectionItem\": \"\",\n \"InterimInspection\": \"\",\n \"InventoryItem\": \"\",\n \"Name\": \"\",\n \"OID\": \"\",\n \"PhotoNumber\": {{faker 'random.number'}},\n \"PhotoType\": \"{{oneOf (array 'Photo' 'Map' 'FloorPlan' 'SiteMap' 'AerialPhoto')}}\",\n \"Property\": \"\",\n \"Room\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "2559b0cb-e3ea-4867-9557-db3f7062b725", "documentation": "A collection of the rooms that belong to this property or block", "method": "get", "endpoint": "v2/tier1/:shortName/property/properties/:propertyID/rooms", "responses": [ { "uuid": "2a0e4b97-92b6-4449-b05e-4b9c7d4cc97a", "body": "{\n \"Count\": {{faker 'random.number'}},\n \"Data\": [\n {\n \"Area\": \"\",\n \"Branch\": \"\",\n \"Description\": \"\",\n \"ETag\": \"\",\n \"FullAddress\": \"\",\n \"GlobalReference\": \"\",\n \"HeightCentimeters\": {{faker 'random.number'}},\n \"HeightMeters\": {{faker 'random.number'}},\n \"LengthCentimeters\": {{faker 'random.number'}},\n \"LengthMeters\": {{faker 'random.number'}},\n \"MainPhoto\": \"\",\n \"ManagedByStaff\": \"\",\n \"OID\": \"\",\n \"PropertySource\": \"\",\n \"RoomFloor\": \"{{oneOf (array 'Basement' 'Ground' 'First' 'Second' 'Third' 'Fourth' 'Fifth' 'SixthPlus' 'Unknown')}}\",\n \"RoomName\": \"\",\n \"WidthCentiMeters\": {{faker 'random.number'}},\n \"WidthMeters\": {{faker 'random.number'}}\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "a27bf82b-96f3-4b31-bd25-57cb5186ce39", "documentation": "A collection of all tenancies associated with this block, property or room", "method": "get", "endpoint": "v2/tier1/:shortName/property/properties/:propertyID/tenancies", "responses": [ { "uuid": "e9756746-2cca-4c9c-a770-eab7f5412063", "body": "{\n \"Count\": {{faker 'random.number'}},\n \"Data\": [\n {\n \"AdvertiseFrom\": \"{{faker 'date.recent' 365}}\",\n \"Area\": \"\",\n \"BondRequired\": {{faker 'random.float'}},\n \"Branch\": \"\",\n \"ETag\": \"\",\n \"Furnished\": \"{{oneOf (array 'Unfurnished' 'PartFurnished' 'Furnished')}}\",\n \"GlobalReference\": \"\",\n \"IsShareProperty\": {{faker 'random.boolean'}},\n \"IsStudentProperty\": {{faker 'random.boolean'}},\n \"IsTenancyAdvertised\": {{faker 'random.boolean'}},\n \"IsTenancyProposed\": {{faker 'random.boolean'}},\n \"MaximumTenants\": {{faker 'random.number'}},\n \"MinimumTenants\": {{faker 'random.number'}},\n \"OID\": \"\",\n \"RentAdvertised\": {{faker 'random.float'}},\n \"RentRecurrence\": {{faker 'random.number'}},\n \"RentSchedule\": \"{{oneOf (array 'Once' 'Daily' 'Weekly' 'Monthly' 'Yearly')}}\",\n \"TenancyProperty\": \"\",\n \"TenantSystemTypes\": [\n \"{{oneOf (array 'Employed' 'SelfEmployed' 'Unemployed' 'Student' 'OwnMeans' 'Retired' 'Company' 'Council')}}\"\n ],\n \"TermMaximum\": {{faker 'random.number'}},\n \"TermMinimum\": {{faker 'random.number'}},\n \"TermStart\": \"{{faker 'date.recent' 365}}\",\n \"UtilityCouncilTax\": \"{{oneOf (array 'Tenant' 'Landlord')}}\",\n \"UtilityElectricity\": \"{{oneOf (array 'Tenant' 'Landlord')}}\",\n \"UtilityGas\": \"{{oneOf (array 'Tenant' 'Landlord')}}\",\n \"UtilityTelephone\": \"{{oneOf (array 'Tenant' 'Landlord')}}\",\n \"UtilityWater\": \"{{oneOf (array 'Tenant' 'Landlord')}}\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "ba936477-86fb-4f61-bb89-81d7f1441978", "documentation": "Downloads the energy efficiency report (EER) graph for a property", "method": "get", "endpoint": "v2/tier1/:shortName/property/structures/:propertyStructureID/reports/eer", "responses": [ { "uuid": "bacd6d85-1a77-415d-930d-3cadd021a5f1", "body": "{}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "7dc7e267-e45e-44bd-954a-5c7df55bff67", "documentation": "Downloads the environmental impact report (EIR) graph for a property", "method": "get", "endpoint": "v2/tier1/:shortName/property/structures/:propertyStructureID/reports/eir", "responses": [ { "uuid": "c4d586ee-bf63-460f-9939-2cf822158f97", "body": "{}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "3713ef94-3eea-448a-a735-65ac0d923c5a", "documentation": "Search all sales properties available given a range of search criteria", "method": "get", "endpoint": "v2/tier1/:shortName/sales/advertisedsales", "responses": [ { "uuid": "b49cf2a1-76e3-48b6-8a58-215d73140fb0", "body": "{\n \"Count\": {{faker 'random.number'}},\n \"Data\": [\n {\n \"Address1\": \"\",\n \"Address2\": \"\",\n \"Address3\": \"\",\n \"Address4\": \"\",\n \"AddressNumber\": \"\",\n \"Area\": \"\",\n \"Bathrooms\": {{faker 'random.number'}},\n \"BathroomsEnsuite\": {{faker 'random.number'}},\n \"Bedrooms\": {{faker 'random.number'}},\n \"ContractType\": \"{{oneOf (array 'Pending' 'SoleAgency' 'SoleSellingRights' 'JointSoleAgency' 'MultiAgency' 'SubAgent')}}\",\n \"Country\": \"{{oneOf (array 'Afghanistan' 'Albania' 'Algeria' 'Andorra' 'Angola' 'AntiguaAndBarbuda' 'Argentina' 'Armenia' 'Australia' 'Austria' 'Azerbaijan' 'Bahamas' 'Bahrain' 'Bangladesh' 'Barbados' 'Belarus' 'Belgium' 'Belize' 'Benin' 'Bhutan' 'Bolivia' 'BosniaAndHerzegovina' 'Botswana' 'Brazil' 'Brunei' 'Bulgaria' 'BurkinaFaso' 'Burundi' 'Cambodia' 'Cameroon' 'Canada' 'CapeVerde' 'CentralAfricanRepublic' 'Chad' 'Chile' 'China' 'Colombia' 'Comoros' 'CongoBrazzaville' 'CongoDemocraticRepublicOfThe' 'CostaRica' 'CoteDIvoire' 'Croatia' 'Cuba' 'Cyprus' 'CzechRepublic' 'Denmark' 'Djibouti' 'Dominica' 'DominicanRepublic' 'EastTimorTimorTimur' 'Ecuador' 'Egypt' 'ElSalvador' 'EquatorialGuinea' 'Eritrea' 'Estonia' 'Ethiopia' 'Fiji' 'Finland' 'France' 'Gabon' 'GambiaThe' 'Georgia' 'Germany' 'Ghana' 'Greece' 'Grenada' 'Guatemala' 'Guinea' 'GuineaBissau' 'Guyana' 'Haiti' 'Honduras' 'Hungary' 'Iceland' 'India' 'Indonesia' 'Iran' 'Iraq' 'Ireland' 'Israel' 'Italy' 'Jamaica' 'Japan' 'Jordan' 'Kazakhstan' 'Kenya' 'Kiribati' 'KoreaNorth' 'KoreaSouth' 'Kuwait' 'Kyrgyzstan' 'Laos' 'Latvia' 'Lebanon' 'Lesotho' 'Liberia' 'Libya' 'Liechtenstein' 'Lithuania' 'Luxembourg' 'MacedoniaFormerYugoslavRepublicOf' 'Madagascar' 'Malawi' 'Malaysia' 'Maldives' 'Mali' 'Malta' 'MarshallIslands' 'Mauritania' 'Mauritius' 'Mexico' 'MicronesiaFederatedStatesOf' 'Moldova' 'Monaco' 'Mongolia' 'Morocco' 'Mozambique' 'Myanmar' 'Namibia' 'Nauru' 'Nepal' 'Netherlands' 'NewZealand' 'Nicaragua' 'Niger' 'Nigeria' 'Norway' 'Oman' 'Pakistan' 'Palau' 'Panama' 'PapuaNewGuinea' 'Paraguay' 'Peru' 'Philippines' 'Poland' 'Portugal' 'Qatar' 'Romania' 'Russia' 'Rwanda' 'SaintKittsAndNevis' 'SaintLucia' 'SaintVincentAndTheGrenadines' 'Samoa' 'SanMarino' 'SaoTomeAndPrincipe' 'SaudiArabia' 'Senegal' 'SerbiaAndMontenegro' 'Seychelles' 'SierraLeone' 'Singapore' 'Slovakia' 'Slovenia' 'SolomonIslands' 'Somalia' 'SouthAfrica' 'Spain' 'SriLanka' 'Sudan' 'Suriname' 'Swaziland' 'Sweden' 'Switzerland' 'Syria' 'Taiwan' 'Tajikistan' 'Tanzania' 'Thailand' 'Togo' 'Tonga' 'TrinidadAndTobago' 'Tunisia' 'Turkey' 'Turkmenistan' 'Tuvalu' 'Uganda' 'Ukraine' 'UnitedArabEmirates' 'UnitedKingdom' 'UnitedStates' 'Uruguay' 'Uzbekistan' 'Vanuatu' 'VaticanCity' 'Venezuela' 'Vietnam' 'WesternSahara' 'Yemen' 'Zambia' 'Zimbabwe' 'UnknownCountry' 'HongKong' 'Jersey' 'ChannelIslands' 'Bermuda' 'BritishOverseasTerritory')}}\",\n \"Description\": \"\",\n \"DevelopmentOpp\": {{faker 'random.boolean'}},\n \"Directions\": \"\",\n \"EPCCurrentEER\": {{faker 'random.number'}},\n \"EPCCurrentEI\": {{faker 'random.number'}},\n \"EPCPotentialEER\": {{faker 'random.number'}},\n \"EPCPotentialEI\": {{faker 'random.number'}},\n \"ETag\": \"\",\n \"HasElectricitySupply\": {{faker 'random.boolean'}},\n \"HasGasSupply\": {{faker 'random.boolean'}},\n \"HasWaterMeter\": {{faker 'random.boolean'}},\n \"InvestmentOpp\": {{faker 'random.boolean'}},\n \"Kitchens\": {{faker 'random.number'}},\n \"OID\": \"\",\n \"OutsideSpaceBalcony\": {{faker 'random.boolean'}},\n \"OutsideSpaceCommunalGarden\": {{faker 'random.boolean'}},\n \"OutsideSpaceConservatory\": {{faker 'random.boolean'}},\n \"OutsideSpaceGarden\": {{faker 'random.boolean'}},\n \"OutsideSpaceLargeGarden\": {{faker 'random.boolean'}},\n \"OutsideSpacePatio\": {{faker 'random.boolean'}},\n \"OutsideSpaceRoofTerrace\": {{faker 'random.boolean'}},\n \"OutsideSpaceSouthFacingGarden\": {{faker 'random.boolean'}},\n \"ParkingAllocated\": {{faker 'random.boolean'}},\n \"ParkingCarport\": {{faker 'random.boolean'}},\n \"ParkingDoubleGarage\": {{faker 'random.boolean'}},\n \"ParkingGarage\": {{faker 'random.boolean'}},\n \"ParkingOffRoad\": {{faker 'random.boolean'}},\n \"ParkingOnRoad\": {{faker 'random.boolean'}},\n \"ParkingPermit\": {{faker 'random.boolean'}},\n \"ParkingSecureGated\": {{faker 'random.boolean'}},\n \"ParkingTripleGarage\": {{faker 'random.boolean'}},\n \"Postcode\": \"\",\n \"Price\": {{faker 'random.float'}},\n \"PropertyOwnableType\": \"{{oneOf (array 'House' 'FlatApartment' 'Bungalow' 'Land' 'HouseFlatShare' 'GarageParking' 'CommercialProperty' 'Block' 'TerracedHouse' 'EndTerraceHouse' 'SemiDetachedHouse' 'DetachedHouse' 'SemiDetachedBungalow' 'TownHouse' 'Cottage' 'ServicedApartment' 'Studio' 'Apartment' 'Barn' 'FarmHouse' 'Penthouse' 'BuildingPlot' 'DetachedBungalow' 'LinkDetached' 'MidTerracedBungalow' 'LandResidential')}}\",\n \"ReceptionRooms\": {{faker 'random.number'}},\n \"State\": \"{{oneOf (array 'MarketAppraisal' 'LostAppraisal' 'Instructed' 'Advertised' 'UnderOffer' 'ContractsExchanged' 'Completed' 'FallenThrough' 'Withdrawn')}}\",\n \"Tenure\": \"{{oneOf (array 'Freehold' 'Leasehold' 'Commonhold' 'ShareOfFreehold' 'FlyingFreehold' 'ShareTransfer' 'Unknown')}}\",\n \"VideoURL\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "a85b5b5f-0e76-465e-b904-5154f82d798f", "documentation": "Downloads the energy efficiency report (EER) graph for a sales instruction", "method": "get", "endpoint": "v2/tier1/:shortName/sales/reports/eer/:salesInstructionID", "responses": [ { "uuid": "f88fe97c-902b-407d-b9b3-d1ab8f984306", "body": "{}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "687776a6-95f3-4e59-a014-309f91e3e162", "documentation": "Downloads the energy efficiency report (EIR) graph for a sales instruction", "method": "get", "endpoint": "v2/tier1/:shortName/sales/reports/eir/:salesInstructionID", "responses": [ { "uuid": "603e493c-2da6-451e-b896-ffc8ced9c945", "body": "{}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "7bbdced7-dc2e-403c-836e-9937b1f25815", "documentation": "A collection of all sales feature types linked to a company", "method": "get", "endpoint": "v2/tier1/:shortName/sales/salesfeaturetypes", "responses": [ { "uuid": "96c03225-bb4f-4dd0-ad8f-eb581c247ad3", "body": "{\n \"Count\": {{faker 'random.number'}},\n \"Data\": [\n {\n \"ETag\": \"\",\n \"Name\": \"\",\n \"OID\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "c046df0b-c36e-4e64-8ec8-10949cd49c45", "documentation": "Get a specific sales feature type given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier1/:shortName/sales/salesfeaturetypes/:salesFeatureTypeID", "responses": [ { "uuid": "3b0ff6c2-5113-4cd2-89d8-45fec3a1be44", "body": "{\n \"ETag\": \"\",\n \"Name\": \"\",\n \"OID\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "ebbdb6e6-8c50-483f-a368-84fcd7be692c", "documentation": "A collection of all sales instructions linked to a company", "method": "get", "endpoint": "v2/tier1/:shortName/sales/salesinstructions", "responses": [ { "uuid": "62bd13a3-8da3-4033-84fe-e2fb026c6af5", "body": "{\n \"Count\": {{faker 'random.number'}},\n \"Data\": [\n {\n \"Address1\": \"\",\n \"Address2\": \"\",\n \"Address3\": \"\",\n \"Address4\": \"\",\n \"AddressNumber\": \"\",\n \"Area\": \"\",\n \"Bathrooms\": {{faker 'random.number'}},\n \"BathroomsEnsuite\": {{faker 'random.number'}},\n \"Bedrooms\": {{faker 'random.number'}},\n \"ContractType\": \"{{oneOf (array 'Pending' 'SoleAgency' 'SoleSellingRights' 'JointSoleAgency' 'MultiAgency' 'SubAgent')}}\",\n \"Country\": \"{{oneOf (array 'Afghanistan' 'Albania' 'Algeria' 'Andorra' 'Angola' 'AntiguaAndBarbuda' 'Argentina' 'Armenia' 'Australia' 'Austria' 'Azerbaijan' 'Bahamas' 'Bahrain' 'Bangladesh' 'Barbados' 'Belarus' 'Belgium' 'Belize' 'Benin' 'Bhutan' 'Bolivia' 'BosniaAndHerzegovina' 'Botswana' 'Brazil' 'Brunei' 'Bulgaria' 'BurkinaFaso' 'Burundi' 'Cambodia' 'Cameroon' 'Canada' 'CapeVerde' 'CentralAfricanRepublic' 'Chad' 'Chile' 'China' 'Colombia' 'Comoros' 'CongoBrazzaville' 'CongoDemocraticRepublicOfThe' 'CostaRica' 'CoteDIvoire' 'Croatia' 'Cuba' 'Cyprus' 'CzechRepublic' 'Denmark' 'Djibouti' 'Dominica' 'DominicanRepublic' 'EastTimorTimorTimur' 'Ecuador' 'Egypt' 'ElSalvador' 'EquatorialGuinea' 'Eritrea' 'Estonia' 'Ethiopia' 'Fiji' 'Finland' 'France' 'Gabon' 'GambiaThe' 'Georgia' 'Germany' 'Ghana' 'Greece' 'Grenada' 'Guatemala' 'Guinea' 'GuineaBissau' 'Guyana' 'Haiti' 'Honduras' 'Hungary' 'Iceland' 'India' 'Indonesia' 'Iran' 'Iraq' 'Ireland' 'Israel' 'Italy' 'Jamaica' 'Japan' 'Jordan' 'Kazakhstan' 'Kenya' 'Kiribati' 'KoreaNorth' 'KoreaSouth' 'Kuwait' 'Kyrgyzstan' 'Laos' 'Latvia' 'Lebanon' 'Lesotho' 'Liberia' 'Libya' 'Liechtenstein' 'Lithuania' 'Luxembourg' 'MacedoniaFormerYugoslavRepublicOf' 'Madagascar' 'Malawi' 'Malaysia' 'Maldives' 'Mali' 'Malta' 'MarshallIslands' 'Mauritania' 'Mauritius' 'Mexico' 'MicronesiaFederatedStatesOf' 'Moldova' 'Monaco' 'Mongolia' 'Morocco' 'Mozambique' 'Myanmar' 'Namibia' 'Nauru' 'Nepal' 'Netherlands' 'NewZealand' 'Nicaragua' 'Niger' 'Nigeria' 'Norway' 'Oman' 'Pakistan' 'Palau' 'Panama' 'PapuaNewGuinea' 'Paraguay' 'Peru' 'Philippines' 'Poland' 'Portugal' 'Qatar' 'Romania' 'Russia' 'Rwanda' 'SaintKittsAndNevis' 'SaintLucia' 'SaintVincentAndTheGrenadines' 'Samoa' 'SanMarino' 'SaoTomeAndPrincipe' 'SaudiArabia' 'Senegal' 'SerbiaAndMontenegro' 'Seychelles' 'SierraLeone' 'Singapore' 'Slovakia' 'Slovenia' 'SolomonIslands' 'Somalia' 'SouthAfrica' 'Spain' 'SriLanka' 'Sudan' 'Suriname' 'Swaziland' 'Sweden' 'Switzerland' 'Syria' 'Taiwan' 'Tajikistan' 'Tanzania' 'Thailand' 'Togo' 'Tonga' 'TrinidadAndTobago' 'Tunisia' 'Turkey' 'Turkmenistan' 'Tuvalu' 'Uganda' 'Ukraine' 'UnitedArabEmirates' 'UnitedKingdom' 'UnitedStates' 'Uruguay' 'Uzbekistan' 'Vanuatu' 'VaticanCity' 'Venezuela' 'Vietnam' 'WesternSahara' 'Yemen' 'Zambia' 'Zimbabwe' 'UnknownCountry' 'HongKong' 'Jersey' 'ChannelIslands' 'Bermuda' 'BritishOverseasTerritory')}}\",\n \"Description\": \"\",\n \"DevelopmentOpp\": {{faker 'random.boolean'}},\n \"Directions\": \"\",\n \"EPCCurrentEER\": {{faker 'random.number'}},\n \"EPCCurrentEI\": {{faker 'random.number'}},\n \"EPCPotentialEER\": {{faker 'random.number'}},\n \"EPCPotentialEI\": {{faker 'random.number'}},\n \"ETag\": \"\",\n \"HasElectricitySupply\": {{faker 'random.boolean'}},\n \"HasGasSupply\": {{faker 'random.boolean'}},\n \"HasWaterMeter\": {{faker 'random.boolean'}},\n \"InvestmentOpp\": {{faker 'random.boolean'}},\n \"Kitchens\": {{faker 'random.number'}},\n \"OID\": \"\",\n \"OutsideSpaceBalcony\": {{faker 'random.boolean'}},\n \"OutsideSpaceCommunalGarden\": {{faker 'random.boolean'}},\n \"OutsideSpaceConservatory\": {{faker 'random.boolean'}},\n \"OutsideSpaceGarden\": {{faker 'random.boolean'}},\n \"OutsideSpaceLargeGarden\": {{faker 'random.boolean'}},\n \"OutsideSpacePatio\": {{faker 'random.boolean'}},\n \"OutsideSpaceRoofTerrace\": {{faker 'random.boolean'}},\n \"OutsideSpaceSouthFacingGarden\": {{faker 'random.boolean'}},\n \"ParkingAllocated\": {{faker 'random.boolean'}},\n \"ParkingCarport\": {{faker 'random.boolean'}},\n \"ParkingDoubleGarage\": {{faker 'random.boolean'}},\n \"ParkingGarage\": {{faker 'random.boolean'}},\n \"ParkingOffRoad\": {{faker 'random.boolean'}},\n \"ParkingOnRoad\": {{faker 'random.boolean'}},\n \"ParkingPermit\": {{faker 'random.boolean'}},\n \"ParkingSecureGated\": {{faker 'random.boolean'}},\n \"ParkingTripleGarage\": {{faker 'random.boolean'}},\n \"Postcode\": \"\",\n \"Price\": {{faker 'random.float'}},\n \"PropertyOwnableType\": \"{{oneOf (array 'House' 'FlatApartment' 'Bungalow' 'Land' 'HouseFlatShare' 'GarageParking' 'CommercialProperty' 'Block' 'TerracedHouse' 'EndTerraceHouse' 'SemiDetachedHouse' 'DetachedHouse' 'SemiDetachedBungalow' 'TownHouse' 'Cottage' 'ServicedApartment' 'Studio' 'Apartment' 'Barn' 'FarmHouse' 'Penthouse' 'BuildingPlot' 'DetachedBungalow' 'LinkDetached' 'MidTerracedBungalow' 'LandResidential')}}\",\n \"ReceptionRooms\": {{faker 'random.number'}},\n \"State\": \"{{oneOf (array 'MarketAppraisal' 'LostAppraisal' 'Instructed' 'Advertised' 'UnderOffer' 'ContractsExchanged' 'Completed' 'FallenThrough' 'Withdrawn')}}\",\n \"Tenure\": \"{{oneOf (array 'Freehold' 'Leasehold' 'Commonhold' 'ShareOfFreehold' 'FlyingFreehold' 'ShareTransfer' 'Unknown')}}\",\n \"VideoURL\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "b1b5fe07-3a23-4c97-adea-96a96444f803", "documentation": "Get a specific sales instruction given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier1/:shortName/sales/salesinstructions/:salesInstructionID", "responses": [ { "uuid": "b7204d85-bc6a-4ee2-9d9c-26fe87728bf8", "body": "{\n \"Address1\": \"\",\n \"Address2\": \"\",\n \"Address3\": \"\",\n \"Address4\": \"\",\n \"AddressNumber\": \"\",\n \"Area\": \"\",\n \"Bathrooms\": {{faker 'random.number'}},\n \"BathroomsEnsuite\": {{faker 'random.number'}},\n \"Bedrooms\": {{faker 'random.number'}},\n \"ContractType\": \"{{oneOf (array 'Pending' 'SoleAgency' 'SoleSellingRights' 'JointSoleAgency' 'MultiAgency' 'SubAgent')}}\",\n \"Country\": \"{{oneOf (array 'Afghanistan' 'Albania' 'Algeria' 'Andorra' 'Angola' 'AntiguaAndBarbuda' 'Argentina' 'Armenia' 'Australia' 'Austria' 'Azerbaijan' 'Bahamas' 'Bahrain' 'Bangladesh' 'Barbados' 'Belarus' 'Belgium' 'Belize' 'Benin' 'Bhutan' 'Bolivia' 'BosniaAndHerzegovina' 'Botswana' 'Brazil' 'Brunei' 'Bulgaria' 'BurkinaFaso' 'Burundi' 'Cambodia' 'Cameroon' 'Canada' 'CapeVerde' 'CentralAfricanRepublic' 'Chad' 'Chile' 'China' 'Colombia' 'Comoros' 'CongoBrazzaville' 'CongoDemocraticRepublicOfThe' 'CostaRica' 'CoteDIvoire' 'Croatia' 'Cuba' 'Cyprus' 'CzechRepublic' 'Denmark' 'Djibouti' 'Dominica' 'DominicanRepublic' 'EastTimorTimorTimur' 'Ecuador' 'Egypt' 'ElSalvador' 'EquatorialGuinea' 'Eritrea' 'Estonia' 'Ethiopia' 'Fiji' 'Finland' 'France' 'Gabon' 'GambiaThe' 'Georgia' 'Germany' 'Ghana' 'Greece' 'Grenada' 'Guatemala' 'Guinea' 'GuineaBissau' 'Guyana' 'Haiti' 'Honduras' 'Hungary' 'Iceland' 'India' 'Indonesia' 'Iran' 'Iraq' 'Ireland' 'Israel' 'Italy' 'Jamaica' 'Japan' 'Jordan' 'Kazakhstan' 'Kenya' 'Kiribati' 'KoreaNorth' 'KoreaSouth' 'Kuwait' 'Kyrgyzstan' 'Laos' 'Latvia' 'Lebanon' 'Lesotho' 'Liberia' 'Libya' 'Liechtenstein' 'Lithuania' 'Luxembourg' 'MacedoniaFormerYugoslavRepublicOf' 'Madagascar' 'Malawi' 'Malaysia' 'Maldives' 'Mali' 'Malta' 'MarshallIslands' 'Mauritania' 'Mauritius' 'Mexico' 'MicronesiaFederatedStatesOf' 'Moldova' 'Monaco' 'Mongolia' 'Morocco' 'Mozambique' 'Myanmar' 'Namibia' 'Nauru' 'Nepal' 'Netherlands' 'NewZealand' 'Nicaragua' 'Niger' 'Nigeria' 'Norway' 'Oman' 'Pakistan' 'Palau' 'Panama' 'PapuaNewGuinea' 'Paraguay' 'Peru' 'Philippines' 'Poland' 'Portugal' 'Qatar' 'Romania' 'Russia' 'Rwanda' 'SaintKittsAndNevis' 'SaintLucia' 'SaintVincentAndTheGrenadines' 'Samoa' 'SanMarino' 'SaoTomeAndPrincipe' 'SaudiArabia' 'Senegal' 'SerbiaAndMontenegro' 'Seychelles' 'SierraLeone' 'Singapore' 'Slovakia' 'Slovenia' 'SolomonIslands' 'Somalia' 'SouthAfrica' 'Spain' 'SriLanka' 'Sudan' 'Suriname' 'Swaziland' 'Sweden' 'Switzerland' 'Syria' 'Taiwan' 'Tajikistan' 'Tanzania' 'Thailand' 'Togo' 'Tonga' 'TrinidadAndTobago' 'Tunisia' 'Turkey' 'Turkmenistan' 'Tuvalu' 'Uganda' 'Ukraine' 'UnitedArabEmirates' 'UnitedKingdom' 'UnitedStates' 'Uruguay' 'Uzbekistan' 'Vanuatu' 'VaticanCity' 'Venezuela' 'Vietnam' 'WesternSahara' 'Yemen' 'Zambia' 'Zimbabwe' 'UnknownCountry' 'HongKong' 'Jersey' 'ChannelIslands' 'Bermuda' 'BritishOverseasTerritory')}}\",\n \"Description\": \"\",\n \"DevelopmentOpp\": {{faker 'random.boolean'}},\n \"Directions\": \"\",\n \"EPCCurrentEER\": {{faker 'random.number'}},\n \"EPCCurrentEI\": {{faker 'random.number'}},\n \"EPCPotentialEER\": {{faker 'random.number'}},\n \"EPCPotentialEI\": {{faker 'random.number'}},\n \"ETag\": \"\",\n \"HasElectricitySupply\": {{faker 'random.boolean'}},\n \"HasGasSupply\": {{faker 'random.boolean'}},\n \"HasWaterMeter\": {{faker 'random.boolean'}},\n \"InvestmentOpp\": {{faker 'random.boolean'}},\n \"Kitchens\": {{faker 'random.number'}},\n \"OID\": \"\",\n \"OutsideSpaceBalcony\": {{faker 'random.boolean'}},\n \"OutsideSpaceCommunalGarden\": {{faker 'random.boolean'}},\n \"OutsideSpaceConservatory\": {{faker 'random.boolean'}},\n \"OutsideSpaceGarden\": {{faker 'random.boolean'}},\n \"OutsideSpaceLargeGarden\": {{faker 'random.boolean'}},\n \"OutsideSpacePatio\": {{faker 'random.boolean'}},\n \"OutsideSpaceRoofTerrace\": {{faker 'random.boolean'}},\n \"OutsideSpaceSouthFacingGarden\": {{faker 'random.boolean'}},\n \"ParkingAllocated\": {{faker 'random.boolean'}},\n \"ParkingCarport\": {{faker 'random.boolean'}},\n \"ParkingDoubleGarage\": {{faker 'random.boolean'}},\n \"ParkingGarage\": {{faker 'random.boolean'}},\n \"ParkingOffRoad\": {{faker 'random.boolean'}},\n \"ParkingOnRoad\": {{faker 'random.boolean'}},\n \"ParkingPermit\": {{faker 'random.boolean'}},\n \"ParkingSecureGated\": {{faker 'random.boolean'}},\n \"ParkingTripleGarage\": {{faker 'random.boolean'}},\n \"Postcode\": \"\",\n \"Price\": {{faker 'random.float'}},\n \"PropertyOwnableType\": \"{{oneOf (array 'House' 'FlatApartment' 'Bungalow' 'Land' 'HouseFlatShare' 'GarageParking' 'CommercialProperty' 'Block' 'TerracedHouse' 'EndTerraceHouse' 'SemiDetachedHouse' 'DetachedHouse' 'SemiDetachedBungalow' 'TownHouse' 'Cottage' 'ServicedApartment' 'Studio' 'Apartment' 'Barn' 'FarmHouse' 'Penthouse' 'BuildingPlot' 'DetachedBungalow' 'LinkDetached' 'MidTerracedBungalow' 'LandResidential')}}\",\n \"ReceptionRooms\": {{faker 'random.number'}},\n \"State\": \"{{oneOf (array 'MarketAppraisal' 'LostAppraisal' 'Instructed' 'Advertised' 'UnderOffer' 'ContractsExchanged' 'Completed' 'FallenThrough' 'Withdrawn')}}\",\n \"Tenure\": \"{{oneOf (array 'Freehold' 'Leasehold' 'Commonhold' 'ShareOfFreehold' 'FlyingFreehold' 'ShareTransfer' 'Unknown')}}\",\n \"VideoURL\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "34fe66ba-1679-40e8-94a3-969bc1acd443", "documentation": "A collection of all features linked to a sales instruction", "method": "get", "endpoint": "v2/tier1/:shortName/sales/salesinstructions/:salesInstructionID/features", "responses": [ { "uuid": "0e2e7415-7620-48d9-a147-87570a390842", "body": "{\n \"Count\": {{faker 'random.number'}},\n \"Data\": [\n {\n \"Comment\": \"\",\n \"ETag\": \"\",\n \"OID\": \"\",\n \"Type\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "dc4f023e-4e4d-4b4c-b9f1-1088ab4e2d97", "documentation": "A collection of floor plans linked to an instruction", "method": "get", "endpoint": "v2/tier1/:shortName/sales/salesinstructions/:salesInstructionID/floorplans", "responses": [ { "uuid": "faa21ecc-148a-4517-9cbd-275fcea47ca2", "body": "{\n \"Count\": {{faker 'random.number'}},\n \"Data\": [\n {\n \"ETag\": \"\",\n \"FileName\": \"\",\n \"InspectionItem\": \"\",\n \"InterimInspection\": \"\",\n \"InventoryItem\": \"\",\n \"Name\": \"\",\n \"OID\": \"\",\n \"PhotoNumber\": {{faker 'random.number'}},\n \"PhotoType\": \"{{oneOf (array 'Photo' 'Map' 'FloorPlan' 'SiteMap' 'AerialPhoto')}}\",\n \"Property\": \"\",\n \"Room\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "29098141-9b92-45a9-9945-93164bfc3b24", "documentation": "A collection of photos linked to an instruction", "method": "get", "endpoint": "v2/tier1/:shortName/sales/salesinstructions/:salesInstructionID/photos", "responses": [ { "uuid": "e512f987-97f0-4164-9d98-08fd55afe4dd", "body": "{\n \"Count\": {{faker 'random.number'}},\n \"Data\": [\n {\n \"ETag\": \"\",\n \"FileName\": \"\",\n \"InspectionItem\": \"\",\n \"InterimInspection\": \"\",\n \"InventoryItem\": \"\",\n \"Name\": \"\",\n \"OID\": \"\",\n \"PhotoNumber\": {{faker 'random.number'}},\n \"PhotoType\": \"{{oneOf (array 'Photo' 'Map' 'FloorPlan' 'SiteMap' 'AerialPhoto')}}\",\n \"Property\": \"\",\n \"Room\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "3c031788-3da8-40c5-9f72-1d12aa39291d", "documentation": "A collection of rooms linked to an instruction", "method": "get", "endpoint": "v2/tier1/:shortName/sales/salesinstructions/:salesInstructionID/rooms", "responses": [ { "uuid": "2749202a-6251-49f7-8aac-8d8ee8d04182", "body": "{\n \"Count\": {{faker 'random.number'}},\n \"Data\": [\n {\n \"Area\": \"\",\n \"Branch\": \"\",\n \"Description\": \"\",\n \"ETag\": \"\",\n \"FullAddress\": \"\",\n \"GlobalReference\": \"\",\n \"HeightCentimeters\": {{faker 'random.number'}},\n \"HeightMeters\": {{faker 'random.number'}},\n \"LengthCentimeters\": {{faker 'random.number'}},\n \"LengthMeters\": {{faker 'random.number'}},\n \"MainPhoto\": \"\",\n \"ManagedByStaff\": \"\",\n \"OID\": \"\",\n \"PropertySource\": \"\",\n \"RoomFloor\": \"{{oneOf (array 'Basement' 'Ground' 'First' 'Second' 'Third' 'Fourth' 'Fifth' 'SixthPlus' 'Unknown')}}\",\n \"RoomName\": \"\",\n \"WidthCentiMeters\": {{faker 'random.number'}},\n \"WidthMeters\": {{faker 'random.number'}}\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "40b90b8d-2ea3-44fd-91f2-0ca52240dca8", "documentation": "A collection of all the staff members linked to a specific company", "method": "get", "endpoint": "v2/tier1/:shortName/staff/staff", "responses": [ { "uuid": "2eb8f241-c887-47fe-97af-54bac5f45ba4", "body": "{\n \"Count\": {{faker 'random.number'}},\n \"Data\": [\n {\n \"ETag\": \"\",\n \"Forename\": \"\",\n \"GlobalReference\": \"\",\n \"IsEnabled\": {{faker 'random.boolean'}},\n \"ManagedBy\": \"\",\n \"Middlename\": \"\",\n \"OID\": \"\",\n \"Surname\": \"\",\n \"Title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "136d534f-4a1a-4409-ba07-607260242d27", "documentation": "Get a specific application staff given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier1/:shortName/staff/staff/:applicationStaffID", "responses": [ { "uuid": "46665178-520f-4706-8cea-176c2ea4da36", "body": "{\n \"ETag\": \"\",\n \"Forename\": \"\",\n \"GlobalReference\": \"\",\n \"IsEnabled\": {{faker 'random.boolean'}},\n \"ManagedBy\": \"\",\n \"Middlename\": \"\",\n \"OID\": \"\",\n \"Surname\": \"\",\n \"Title\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [ { "key": "", "value": "" } ], "proxyResHeaders": [ { "key": "", "value": "" } ] }