{ "uuid": "348313db-baa3-4147-ac1d-5fd0b745ac0a", "lastMigration": 29, "name": "LetMC Api V2, Free (Tier 1)", "endpointPrefix": "", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "b4bf4dbc-52a1-40d4-8435-d5f76740aaef", "documentation": "A collection of all the areas for a company", "method": "get", "endpoint": "v2/tier1/:shortName/area/areas", "responses": [ { "uuid": "baf51104-45c6-4c93-b12d-4aca951f369b", "body": "{\n \"Count\": {{faker 'number.int' max=99999}},\n \"Data\": [\n {\n \"Branch\": \"\",\n \"ETag\": \"\",\n \"Name\": \"\",\n \"OID\": \"\",\n \"ShowOnSites\": {{faker 'datatype.boolean'}}\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2904a7b3-d214-4aea-8d75-fa5177667b25", "documentation": "Get a specific area given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier1/:shortName/area/areas/:areaID", "responses": [ { "uuid": "0e8f6f6f-2bec-4cc9-ab36-99b40f272564", "body": "{\n \"Branch\": \"\",\n \"ETag\": \"\",\n \"Name\": \"\",\n \"OID\": \"\",\n \"ShowOnSites\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a4f2830a-4686-45a9-b0ea-40f0887e53d4", "documentation": "All branches defined for a company", "method": "get", "endpoint": "v2/tier1/:shortName/branch/branches", "responses": [ { "uuid": "df72630e-49d0-487b-952f-17048a6d3a89", "body": "{\n \"Count\": {{faker 'number.int' max=99999}},\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" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "057272de-ec70-4846-bf80-b4f9df50d896", "documentation": "Get a specific branch given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier1/:shortName/branch/branches/:branchID", "responses": [ { "uuid": "a634475d-4bae-4ad2-9b16-7bb0d9c4ab58", "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" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "751f1c80-f6df-458f-a2f2-ac64feb660cd", "documentation": "Information about a specific company", "method": "get", "endpoint": "v2/tier1/:shortName/company", "responses": [ { "uuid": "3642a687-2490-4c9f-bf2b-06292bba74b7", "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" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1ac9564b-0c82-4404-b9b8-95d97fd0133d", "documentation": "A collection of all counties available for a company", "method": "get", "endpoint": "v2/tier1/:shortName/county/counties", "responses": [ { "uuid": "d163d11d-6112-452f-a027-91c46420ed18", "body": "{\n \"Count\": {{faker 'number.int' max=99999}},\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" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1d163b06-0741-4a6f-8389-02b5a1252a0c", "documentation": "Get a specific county given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier1/:shortName/county/counties/:countyID", "responses": [ { "uuid": "dff9cc82-017d-4823-b837-c25c91cc0460", "body": "{\n \"ETag\": \"\",\n \"Name\": \"\",\n \"OID\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "50177955-2772-463c-8484-ad0e32c6d610", "documentation": "A collection of branches that manage a specific county", "method": "get", "endpoint": "v2/tier1/:shortName/county/counties/:countyID/branches", "responses": [ { "uuid": "8e165115-1635-4688-956c-33d1932be732", "body": "{\n \"Count\": {{faker 'number.int' max=99999}},\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" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2c68197c-1c69-446e-8827-cf52dc319270", "documentation": "A collection of all diary allocations", "method": "get", "endpoint": "v2/tier1/:shortName/diary/allocations", "responses": [ { "uuid": "4d88f7e8-4ea2-4ebb-8eed-02dd605e27c3", "body": "{\n \"Count\": {{faker 'number.int' max=99999}},\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" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "51fb9431-2894-4978-954b-1f1b1f2645f0", "documentation": "Get a specific diary allocation given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier1/:shortName/diary/allocations/:diaryAllocationID", "responses": [ { "uuid": "29ea987c-4265-418a-9b76-01a8c5120c71", "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" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "96a616cb-188c-4994-bd7b-8e93c61017af", "documentation": "A collection of all diary appointments", "method": "get", "endpoint": "v2/tier1/:shortName/diary/appointments", "responses": [ { "uuid": "6a51b49a-d132-4601-a481-95aa98dcb7be", "body": "{\n \"Count\": {{faker 'number.int' max=99999}},\n \"Data\": [\n {\n \"AppointmentType\": \"\",\n \"Cancelled\": {{faker 'datatype.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" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a29f7e66-d31a-4a30-9ff1-3933977b0110", "documentation": "Get a specific diary appointment given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier1/:shortName/diary/appointments/:diaryAppointmentID", "responses": [ { "uuid": "31c1ba5c-48fd-4965-8743-202d7c440ec6", "body": "{\n \"AppointmentType\": \"\",\n \"Cancelled\": {{faker 'datatype.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" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "60717ca6-e7ba-4270-bfc4-125a31f7c354", "documentation": "A collection of all diary appointment types", "method": "get", "endpoint": "v2/tier1/:shortName/diary/appointmenttypes", "responses": [ { "uuid": "d22722a3-c626-4f88-a55e-7547a9359508", "body": "{\n \"Count\": {{faker 'number.int' max=99999}},\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" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "694b54e3-974c-4a49-9bdb-e90baf5e4958", "documentation": "Get a specific diary appointment type given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier1/:shortName/diary/appointmenttypes/:diaryAppointmentTypeID", "responses": [ { "uuid": "88a486ff-111e-428c-a3ea-a704b5da8e60", "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" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d3ba3bb0-fd50-4591-9700-abf4f9e3ace9", "documentation": "Search all properties available for rent given a range of search criteria.", "method": "get", "endpoint": "v2/tier1/:shortName/lettings/advertised", "responses": [ { "uuid": "31a1abb0-c4cb-4f15-9bf9-b83e28f74958", "body": "{\n \"Count\": {{faker 'number.int' max=99999}},\n \"Data\": [\n {\n \"AdvertiseFrom\": \"{{faker 'date.recent' 365}}\",\n \"Area\": \"\",\n \"BondRequired\": {{faker 'number.float'}},\n \"Branch\": \"\",\n \"ETag\": \"\",\n \"Furnished\": \"{{oneOf (array 'Unfurnished' 'PartFurnished' 'Furnished')}}\",\n \"GlobalReference\": \"\",\n \"IsShareProperty\": {{faker 'datatype.boolean'}},\n \"IsStudentProperty\": {{faker 'datatype.boolean'}},\n \"IsTenancyAdvertised\": {{faker 'datatype.boolean'}},\n \"IsTenancyProposed\": {{faker 'datatype.boolean'}},\n \"MaximumTenants\": {{faker 'number.int' max=99999}},\n \"MinimumTenants\": {{faker 'number.int' max=99999}},\n \"OID\": \"\",\n \"RentAdvertised\": {{faker 'number.float'}},\n \"RentRecurrence\": {{faker 'number.int' max=99999}},\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 'number.int' max=99999}},\n \"TermMinimum\": {{faker 'number.int' max=99999}},\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" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6b5a0c76-2865-4b92-87bc-98f4b7a64c7f", "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": "3d2281d9-eb23-4f27-85bc-758749dad864", "body": "{\n \"Count\": {{faker 'number.int' max=99999}},\n \"Data\": [\n {\n \"AdvertiseFrom\": \"{{faker 'date.recent' 365}}\",\n \"Area\": \"\",\n \"BondRequired\": {{faker 'number.float'}},\n \"Branch\": \"\",\n \"ETag\": \"\",\n \"Furnished\": \"{{oneOf (array 'Unfurnished' 'PartFurnished' 'Furnished')}}\",\n \"GlobalReference\": \"\",\n \"IsShareProperty\": {{faker 'datatype.boolean'}},\n \"IsStudentProperty\": {{faker 'datatype.boolean'}},\n \"IsTenancyAdvertised\": {{faker 'datatype.boolean'}},\n \"IsTenancyProposed\": {{faker 'datatype.boolean'}},\n \"MaximumTenants\": {{faker 'number.int' max=99999}},\n \"MinimumTenants\": {{faker 'number.int' max=99999}},\n \"OID\": \"\",\n \"RentAdvertised\": {{faker 'number.float'}},\n \"RentRecurrence\": {{faker 'number.int' max=99999}},\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 'number.int' max=99999}},\n \"TermMinimum\": {{faker 'number.int' max=99999}},\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" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "17464f58-27f3-4fcb-a03a-4e6f6942ec87", "documentation": "A collection of all the company's tenancies", "method": "get", "endpoint": "v2/tier1/:shortName/lettings/tenancies", "responses": [ { "uuid": "9e381302-d088-4807-bc24-504c94e81b0a", "body": "{\n \"Count\": {{faker 'number.int' max=99999}},\n \"Data\": [\n {\n \"AdvertiseFrom\": \"{{faker 'date.recent' 365}}\",\n \"Area\": \"\",\n \"BondRequired\": {{faker 'number.float'}},\n \"Branch\": \"\",\n \"ETag\": \"\",\n \"Furnished\": \"{{oneOf (array 'Unfurnished' 'PartFurnished' 'Furnished')}}\",\n \"GlobalReference\": \"\",\n \"IsShareProperty\": {{faker 'datatype.boolean'}},\n \"IsStudentProperty\": {{faker 'datatype.boolean'}},\n \"IsTenancyAdvertised\": {{faker 'datatype.boolean'}},\n \"IsTenancyProposed\": {{faker 'datatype.boolean'}},\n \"MaximumTenants\": {{faker 'number.int' max=99999}},\n \"MinimumTenants\": {{faker 'number.int' max=99999}},\n \"OID\": \"\",\n \"RentAdvertised\": {{faker 'number.float'}},\n \"RentRecurrence\": {{faker 'number.int' max=99999}},\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 'number.int' max=99999}},\n \"TermMinimum\": {{faker 'number.int' max=99999}},\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" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8e2c1348-d565-4fea-95bd-2ffb6f6a7796", "documentation": "Get a specific tenancy given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier1/:shortName/lettings/tenancies/:tenancyID", "responses": [ { "uuid": "e03623ae-0a26-46b8-9160-d31b512055f8", "body": "{\n \"AdvertiseFrom\": \"{{faker 'date.recent' 365}}\",\n \"Area\": \"\",\n \"BondRequired\": {{faker 'number.float'}},\n \"Branch\": \"\",\n \"ETag\": \"\",\n \"Furnished\": \"{{oneOf (array 'Unfurnished' 'PartFurnished' 'Furnished')}}\",\n \"GlobalReference\": \"\",\n \"IsShareProperty\": {{faker 'datatype.boolean'}},\n \"IsStudentProperty\": {{faker 'datatype.boolean'}},\n \"IsTenancyAdvertised\": {{faker 'datatype.boolean'}},\n \"IsTenancyProposed\": {{faker 'datatype.boolean'}},\n \"MaximumTenants\": {{faker 'number.int' max=99999}},\n \"MinimumTenants\": {{faker 'number.int' max=99999}},\n \"OID\": \"\",\n \"RentAdvertised\": {{faker 'number.float'}},\n \"RentRecurrence\": {{faker 'number.int' max=99999}},\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 'number.int' max=99999}},\n \"TermMinimum\": {{faker 'number.int' max=99999}},\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" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "35f6bfce-6d01-4a78-a16c-9e70155fae4f", "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": "0fffa8bc-4d98-44e7-a572-6590d3421e09", "body": "{}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e097b88e-5122-4918-ba17-fe25d6c90ee0", "documentation": "A collection of all photos in the company", "method": "get", "endpoint": "v2/tier1/:shortName/photo/photos", "responses": [ { "uuid": "1e96c8e1-bd3b-4b5c-af28-66796394bd99", "body": "{\n \"Count\": {{faker 'number.int' max=99999}},\n \"Data\": [\n {\n \"ETag\": \"\",\n \"FileName\": \"\",\n \"InspectionItem\": \"\",\n \"InterimInspection\": \"\",\n \"InventoryItem\": \"\",\n \"Name\": \"\",\n \"OID\": \"\",\n \"PhotoNumber\": {{faker 'number.int' max=99999}},\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" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2fa7e47a-aa5c-426c-9841-4e11a196b1fe", "documentation": "Get a specific photo given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier1/:shortName/photo/photos/:photoID", "responses": [ { "uuid": "39d429d0-3444-42f7-b1bd-6b0d9690eb14", "body": "{\n \"ETag\": \"\",\n \"FileName\": \"\",\n \"InspectionItem\": \"\",\n \"InterimInspection\": \"\",\n \"InventoryItem\": \"\",\n \"Name\": \"\",\n \"OID\": \"\",\n \"PhotoNumber\": {{faker 'number.int' max=99999}},\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" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e86ab495-b7dd-4ce7-89b4-52f51ada141a", "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": "4120f777-cb7f-4b96-b079-d0f35759f52a", "body": "{}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5a010e64-c4d5-4a41-8d65-22ebdb60c1f4", "documentation": "A collection of all properties within a company", "method": "get", "endpoint": "v2/tier1/:shortName/property/properties", "responses": [ { "uuid": "f0d5d13e-54a9-4dad-ad8f-80a485e749d4", "body": "{\n \"Count\": {{faker 'number.int' max=99999}},\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" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "bb3a9c36-e380-4fee-845b-995597d51de1", "documentation": "Get a specific property given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier1/:shortName/property/properties/:propertyID", "responses": [ { "uuid": "5e85bdcc-ca24-4da5-9bb4-61b4506a76f1", "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" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b0b7a701-56ce-49f3-87ae-c845e5993ad4", "documentation": "A collection of facilities linked to a block, property or room", "method": "get", "endpoint": "v2/tier1/:shortName/property/properties/:propertyID/facilities", "responses": [ { "uuid": "0ec6255e-5037-4b05-b186-08c48ae81d53", "body": "{\n \"Count\": {{faker 'number.int' max=99999}},\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" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "37fd8b85-bae8-4816-8a62-7c069e6cb382", "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": "5687d30d-dde4-4a54-b893-4a419eb9a9ad", "body": "{\n \"Count\": {{faker 'number.int' max=99999}},\n \"Data\": [\n {\n \"ETag\": \"\",\n \"FileName\": \"\",\n \"InspectionItem\": \"\",\n \"InterimInspection\": \"\",\n \"InventoryItem\": \"\",\n \"Name\": \"\",\n \"OID\": \"\",\n \"PhotoNumber\": {{faker 'number.int' max=99999}},\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" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "56a7d952-10f3-494c-b494-38ee549c141c", "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": "a26ec08b-24f5-410b-8285-38411251005d", "body": "{\n \"Count\": {{faker 'number.int' max=99999}},\n \"Data\": [\n {\n \"Area\": \"\",\n \"Branch\": \"\",\n \"Description\": \"\",\n \"ETag\": \"\",\n \"FullAddress\": \"\",\n \"GlobalReference\": \"\",\n \"HeightCentimeters\": {{faker 'number.int' max=99999}},\n \"HeightMeters\": {{faker 'number.int' max=99999}},\n \"LengthCentimeters\": {{faker 'number.int' max=99999}},\n \"LengthMeters\": {{faker 'number.int' max=99999}},\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 'number.int' max=99999}},\n \"WidthMeters\": {{faker 'number.int' max=99999}}\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5f914cd1-a867-4414-9457-bcdc566f776f", "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": "ed75c101-d937-4c8e-b8a1-38d6a37ccf4f", "body": "{\n \"Count\": {{faker 'number.int' max=99999}},\n \"Data\": [\n {\n \"AdvertiseFrom\": \"{{faker 'date.recent' 365}}\",\n \"Area\": \"\",\n \"BondRequired\": {{faker 'number.float'}},\n \"Branch\": \"\",\n \"ETag\": \"\",\n \"Furnished\": \"{{oneOf (array 'Unfurnished' 'PartFurnished' 'Furnished')}}\",\n \"GlobalReference\": \"\",\n \"IsShareProperty\": {{faker 'datatype.boolean'}},\n \"IsStudentProperty\": {{faker 'datatype.boolean'}},\n \"IsTenancyAdvertised\": {{faker 'datatype.boolean'}},\n \"IsTenancyProposed\": {{faker 'datatype.boolean'}},\n \"MaximumTenants\": {{faker 'number.int' max=99999}},\n \"MinimumTenants\": {{faker 'number.int' max=99999}},\n \"OID\": \"\",\n \"RentAdvertised\": {{faker 'number.float'}},\n \"RentRecurrence\": {{faker 'number.int' max=99999}},\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 'number.int' max=99999}},\n \"TermMinimum\": {{faker 'number.int' max=99999}},\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" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "84f2641a-fdcd-4e86-b584-7640c440b74d", "documentation": "Downloads the energy efficiency report (EER) graph for a property", "method": "get", "endpoint": "v2/tier1/:shortName/property/structures/:propertyStructureID/reports/eer", "responses": [ { "uuid": "88282478-4924-40b3-b5e7-5aa34a2fc44e", "body": "{}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "43d41029-2b5a-4dcb-9f93-dce139303707", "documentation": "Downloads the environmental impact report (EIR) graph for a property", "method": "get", "endpoint": "v2/tier1/:shortName/property/structures/:propertyStructureID/reports/eir", "responses": [ { "uuid": "062cdd68-2ef7-42f2-ad28-1864a12b0567", "body": "{}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c1061b3c-4f47-443b-a2f2-7c0110402e17", "documentation": "Search all sales properties available given a range of search criteria", "method": "get", "endpoint": "v2/tier1/:shortName/sales/advertisedsales", "responses": [ { "uuid": "0e33d9f2-3dbc-43f1-a258-e9dac8be6832", "body": "{\n \"Count\": {{faker 'number.int' max=99999}},\n \"Data\": [\n {\n \"Address1\": \"\",\n \"Address2\": \"\",\n \"Address3\": \"\",\n \"Address4\": \"\",\n \"AddressNumber\": \"\",\n \"Area\": \"\",\n \"Bathrooms\": {{faker 'number.int' max=99999}},\n \"BathroomsEnsuite\": {{faker 'number.int' max=99999}},\n \"Bedrooms\": {{faker 'number.int' max=99999}},\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 'datatype.boolean'}},\n \"Directions\": \"\",\n \"EPCCurrentEER\": {{faker 'number.int' max=99999}},\n \"EPCCurrentEI\": {{faker 'number.int' max=99999}},\n \"EPCPotentialEER\": {{faker 'number.int' max=99999}},\n \"EPCPotentialEI\": {{faker 'number.int' max=99999}},\n \"ETag\": \"\",\n \"HasElectricitySupply\": {{faker 'datatype.boolean'}},\n \"HasGasSupply\": {{faker 'datatype.boolean'}},\n \"HasWaterMeter\": {{faker 'datatype.boolean'}},\n \"InvestmentOpp\": {{faker 'datatype.boolean'}},\n \"Kitchens\": {{faker 'number.int' max=99999}},\n \"OID\": \"\",\n \"OutsideSpaceBalcony\": {{faker 'datatype.boolean'}},\n \"OutsideSpaceCommunalGarden\": {{faker 'datatype.boolean'}},\n \"OutsideSpaceConservatory\": {{faker 'datatype.boolean'}},\n \"OutsideSpaceGarden\": {{faker 'datatype.boolean'}},\n \"OutsideSpaceLargeGarden\": {{faker 'datatype.boolean'}},\n \"OutsideSpacePatio\": {{faker 'datatype.boolean'}},\n \"OutsideSpaceRoofTerrace\": {{faker 'datatype.boolean'}},\n \"OutsideSpaceSouthFacingGarden\": {{faker 'datatype.boolean'}},\n \"ParkingAllocated\": {{faker 'datatype.boolean'}},\n \"ParkingCarport\": {{faker 'datatype.boolean'}},\n \"ParkingDoubleGarage\": {{faker 'datatype.boolean'}},\n \"ParkingGarage\": {{faker 'datatype.boolean'}},\n \"ParkingOffRoad\": {{faker 'datatype.boolean'}},\n \"ParkingOnRoad\": {{faker 'datatype.boolean'}},\n \"ParkingPermit\": {{faker 'datatype.boolean'}},\n \"ParkingSecureGated\": {{faker 'datatype.boolean'}},\n \"ParkingTripleGarage\": {{faker 'datatype.boolean'}},\n \"Postcode\": \"\",\n \"Price\": {{faker 'number.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 'number.int' max=99999}},\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" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "af0ecfd5-09f6-4a2f-b373-5a1beb4e7507", "documentation": "Downloads the energy efficiency report (EER) graph for a sales instruction", "method": "get", "endpoint": "v2/tier1/:shortName/sales/reports/eer/:salesInstructionID", "responses": [ { "uuid": "aaf5513c-8b39-4066-a80f-e2befa6b1fd7", "body": "{}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0788e7f1-041e-4727-8a0a-bb7ecf566114", "documentation": "Downloads the energy efficiency report (EIR) graph for a sales instruction", "method": "get", "endpoint": "v2/tier1/:shortName/sales/reports/eir/:salesInstructionID", "responses": [ { "uuid": "7c0168d6-bb69-4d18-a5be-fd6c61a0cff9", "body": "{}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6e046dc1-7d50-4b77-ae4c-e40097e4f388", "documentation": "A collection of all sales feature types linked to a company", "method": "get", "endpoint": "v2/tier1/:shortName/sales/salesfeaturetypes", "responses": [ { "uuid": "ff12064c-8c04-46a3-9194-f6ada600f3e3", "body": "{\n \"Count\": {{faker 'number.int' max=99999}},\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" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c873df7c-085e-48dc-940b-910acc49ce3c", "documentation": "Get a specific sales feature type given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier1/:shortName/sales/salesfeaturetypes/:salesFeatureTypeID", "responses": [ { "uuid": "621f6003-a841-461c-a24d-b5f63d70a0f0", "body": "{\n \"ETag\": \"\",\n \"Name\": \"\",\n \"OID\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d6f29de0-21ce-4757-9b46-8ec390134477", "documentation": "A collection of all sales instructions linked to a company", "method": "get", "endpoint": "v2/tier1/:shortName/sales/salesinstructions", "responses": [ { "uuid": "118d91f1-11cb-4e82-b82a-58956a12f459", "body": "{\n \"Count\": {{faker 'number.int' max=99999}},\n \"Data\": [\n {\n \"Address1\": \"\",\n \"Address2\": \"\",\n \"Address3\": \"\",\n \"Address4\": \"\",\n \"AddressNumber\": \"\",\n \"Area\": \"\",\n \"Bathrooms\": {{faker 'number.int' max=99999}},\n \"BathroomsEnsuite\": {{faker 'number.int' max=99999}},\n \"Bedrooms\": {{faker 'number.int' max=99999}},\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 'datatype.boolean'}},\n \"Directions\": \"\",\n \"EPCCurrentEER\": {{faker 'number.int' max=99999}},\n \"EPCCurrentEI\": {{faker 'number.int' max=99999}},\n \"EPCPotentialEER\": {{faker 'number.int' max=99999}},\n \"EPCPotentialEI\": {{faker 'number.int' max=99999}},\n \"ETag\": \"\",\n \"HasElectricitySupply\": {{faker 'datatype.boolean'}},\n \"HasGasSupply\": {{faker 'datatype.boolean'}},\n \"HasWaterMeter\": {{faker 'datatype.boolean'}},\n \"InvestmentOpp\": {{faker 'datatype.boolean'}},\n \"Kitchens\": {{faker 'number.int' max=99999}},\n \"OID\": \"\",\n \"OutsideSpaceBalcony\": {{faker 'datatype.boolean'}},\n \"OutsideSpaceCommunalGarden\": {{faker 'datatype.boolean'}},\n \"OutsideSpaceConservatory\": {{faker 'datatype.boolean'}},\n \"OutsideSpaceGarden\": {{faker 'datatype.boolean'}},\n \"OutsideSpaceLargeGarden\": {{faker 'datatype.boolean'}},\n \"OutsideSpacePatio\": {{faker 'datatype.boolean'}},\n \"OutsideSpaceRoofTerrace\": {{faker 'datatype.boolean'}},\n \"OutsideSpaceSouthFacingGarden\": {{faker 'datatype.boolean'}},\n \"ParkingAllocated\": {{faker 'datatype.boolean'}},\n \"ParkingCarport\": {{faker 'datatype.boolean'}},\n \"ParkingDoubleGarage\": {{faker 'datatype.boolean'}},\n \"ParkingGarage\": {{faker 'datatype.boolean'}},\n \"ParkingOffRoad\": {{faker 'datatype.boolean'}},\n \"ParkingOnRoad\": {{faker 'datatype.boolean'}},\n \"ParkingPermit\": {{faker 'datatype.boolean'}},\n \"ParkingSecureGated\": {{faker 'datatype.boolean'}},\n \"ParkingTripleGarage\": {{faker 'datatype.boolean'}},\n \"Postcode\": \"\",\n \"Price\": {{faker 'number.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 'number.int' max=99999}},\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" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "51c60e79-4b18-4f17-8408-c6fa8a518d37", "documentation": "Get a specific sales instruction given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier1/:shortName/sales/salesinstructions/:salesInstructionID", "responses": [ { "uuid": "87a807ea-0205-4530-866a-fec8d8a51f0f", "body": "{\n \"Address1\": \"\",\n \"Address2\": \"\",\n \"Address3\": \"\",\n \"Address4\": \"\",\n \"AddressNumber\": \"\",\n \"Area\": \"\",\n \"Bathrooms\": {{faker 'number.int' max=99999}},\n \"BathroomsEnsuite\": {{faker 'number.int' max=99999}},\n \"Bedrooms\": {{faker 'number.int' max=99999}},\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 'datatype.boolean'}},\n \"Directions\": \"\",\n \"EPCCurrentEER\": {{faker 'number.int' max=99999}},\n \"EPCCurrentEI\": {{faker 'number.int' max=99999}},\n \"EPCPotentialEER\": {{faker 'number.int' max=99999}},\n \"EPCPotentialEI\": {{faker 'number.int' max=99999}},\n \"ETag\": \"\",\n \"HasElectricitySupply\": {{faker 'datatype.boolean'}},\n \"HasGasSupply\": {{faker 'datatype.boolean'}},\n \"HasWaterMeter\": {{faker 'datatype.boolean'}},\n \"InvestmentOpp\": {{faker 'datatype.boolean'}},\n \"Kitchens\": {{faker 'number.int' max=99999}},\n \"OID\": \"\",\n \"OutsideSpaceBalcony\": {{faker 'datatype.boolean'}},\n \"OutsideSpaceCommunalGarden\": {{faker 'datatype.boolean'}},\n \"OutsideSpaceConservatory\": {{faker 'datatype.boolean'}},\n \"OutsideSpaceGarden\": {{faker 'datatype.boolean'}},\n \"OutsideSpaceLargeGarden\": {{faker 'datatype.boolean'}},\n \"OutsideSpacePatio\": {{faker 'datatype.boolean'}},\n \"OutsideSpaceRoofTerrace\": {{faker 'datatype.boolean'}},\n \"OutsideSpaceSouthFacingGarden\": {{faker 'datatype.boolean'}},\n \"ParkingAllocated\": {{faker 'datatype.boolean'}},\n \"ParkingCarport\": {{faker 'datatype.boolean'}},\n \"ParkingDoubleGarage\": {{faker 'datatype.boolean'}},\n \"ParkingGarage\": {{faker 'datatype.boolean'}},\n \"ParkingOffRoad\": {{faker 'datatype.boolean'}},\n \"ParkingOnRoad\": {{faker 'datatype.boolean'}},\n \"ParkingPermit\": {{faker 'datatype.boolean'}},\n \"ParkingSecureGated\": {{faker 'datatype.boolean'}},\n \"ParkingTripleGarage\": {{faker 'datatype.boolean'}},\n \"Postcode\": \"\",\n \"Price\": {{faker 'number.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 'number.int' max=99999}},\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" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3cbdaaa0-c202-4baf-affb-694c86d65bb9", "documentation": "A collection of all features linked to a sales instruction", "method": "get", "endpoint": "v2/tier1/:shortName/sales/salesinstructions/:salesInstructionID/features", "responses": [ { "uuid": "b9302b28-fa48-4172-bfec-8b94d8c0ad68", "body": "{\n \"Count\": {{faker 'number.int' max=99999}},\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" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "65fcbcaa-47f3-442a-a4d6-ed3d2e3281dc", "documentation": "A collection of floor plans linked to an instruction", "method": "get", "endpoint": "v2/tier1/:shortName/sales/salesinstructions/:salesInstructionID/floorplans", "responses": [ { "uuid": "3f1d07a5-3db2-48eb-a019-a76b9fc25297", "body": "{\n \"Count\": {{faker 'number.int' max=99999}},\n \"Data\": [\n {\n \"ETag\": \"\",\n \"FileName\": \"\",\n \"InspectionItem\": \"\",\n \"InterimInspection\": \"\",\n \"InventoryItem\": \"\",\n \"Name\": \"\",\n \"OID\": \"\",\n \"PhotoNumber\": {{faker 'number.int' max=99999}},\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" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2e95da09-ed4a-4de8-8856-5cd9fc7141d2", "documentation": "A collection of photos linked to an instruction", "method": "get", "endpoint": "v2/tier1/:shortName/sales/salesinstructions/:salesInstructionID/photos", "responses": [ { "uuid": "355c6482-7c4e-466d-b2d4-08dc1600f522", "body": "{\n \"Count\": {{faker 'number.int' max=99999}},\n \"Data\": [\n {\n \"ETag\": \"\",\n \"FileName\": \"\",\n \"InspectionItem\": \"\",\n \"InterimInspection\": \"\",\n \"InventoryItem\": \"\",\n \"Name\": \"\",\n \"OID\": \"\",\n \"PhotoNumber\": {{faker 'number.int' max=99999}},\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" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f69239ef-ccfd-480d-9850-6727c9996ceb", "documentation": "A collection of rooms linked to an instruction", "method": "get", "endpoint": "v2/tier1/:shortName/sales/salesinstructions/:salesInstructionID/rooms", "responses": [ { "uuid": "8338ff96-47ad-4b24-a271-5b9c7a684840", "body": "{\n \"Count\": {{faker 'number.int' max=99999}},\n \"Data\": [\n {\n \"Area\": \"\",\n \"Branch\": \"\",\n \"Description\": \"\",\n \"ETag\": \"\",\n \"FullAddress\": \"\",\n \"GlobalReference\": \"\",\n \"HeightCentimeters\": {{faker 'number.int' max=99999}},\n \"HeightMeters\": {{faker 'number.int' max=99999}},\n \"LengthCentimeters\": {{faker 'number.int' max=99999}},\n \"LengthMeters\": {{faker 'number.int' max=99999}},\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 'number.int' max=99999}},\n \"WidthMeters\": {{faker 'number.int' max=99999}}\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "60873a04-610d-424e-9817-9732793f4e2e", "documentation": "A collection of all the staff members linked to a specific company", "method": "get", "endpoint": "v2/tier1/:shortName/staff/staff", "responses": [ { "uuid": "87ca5d75-dba3-4ef0-9777-d4644c50e218", "body": "{\n \"Count\": {{faker 'number.int' max=99999}},\n \"Data\": [\n {\n \"ETag\": \"\",\n \"Forename\": \"\",\n \"GlobalReference\": \"\",\n \"IsEnabled\": {{faker 'datatype.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" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a3a004fc-2f50-476c-8d13-cea89b496174", "documentation": "Get a specific application staff given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier1/:shortName/staff/staff/:applicationStaffID", "responses": [ { "uuid": "20cdd78e-3893-488d-b482-1c3e60787d26", "body": "{\n \"ETag\": \"\",\n \"Forename\": \"\",\n \"GlobalReference\": \"\",\n \"IsEnabled\": {{faker 'datatype.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" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "b4bf4dbc-52a1-40d4-8435-d5f76740aaef" }, { "type": "route", "uuid": "2904a7b3-d214-4aea-8d75-fa5177667b25" }, { "type": "route", "uuid": "a4f2830a-4686-45a9-b0ea-40f0887e53d4" }, { "type": "route", "uuid": "057272de-ec70-4846-bf80-b4f9df50d896" }, { "type": "route", "uuid": "751f1c80-f6df-458f-a2f2-ac64feb660cd" }, { "type": "route", "uuid": "1ac9564b-0c82-4404-b9b8-95d97fd0133d" }, { "type": "route", "uuid": "1d163b06-0741-4a6f-8389-02b5a1252a0c" }, { "type": "route", "uuid": "50177955-2772-463c-8484-ad0e32c6d610" }, { "type": "route", "uuid": "2c68197c-1c69-446e-8827-cf52dc319270" }, { "type": "route", "uuid": "51fb9431-2894-4978-954b-1f1b1f2645f0" }, { "type": "route", "uuid": "96a616cb-188c-4994-bd7b-8e93c61017af" }, { "type": "route", "uuid": "a29f7e66-d31a-4a30-9ff1-3933977b0110" }, { "type": "route", "uuid": "60717ca6-e7ba-4270-bfc4-125a31f7c354" }, { "type": "route", "uuid": "694b54e3-974c-4a49-9bdb-e90baf5e4958" }, { "type": "route", "uuid": "d3ba3bb0-fd50-4591-9700-abf4f9e3ace9" }, { "type": "route", "uuid": "6b5a0c76-2865-4b92-87bc-98f4b7a64c7f" }, { "type": "route", "uuid": "17464f58-27f3-4fcb-a03a-4e6f6942ec87" }, { "type": "route", "uuid": "8e2c1348-d565-4fea-95bd-2ffb6f6a7796" }, { "type": "route", "uuid": "35f6bfce-6d01-4a78-a16c-9e70155fae4f" }, { "type": "route", "uuid": "e097b88e-5122-4918-ba17-fe25d6c90ee0" }, { "type": "route", "uuid": "2fa7e47a-aa5c-426c-9841-4e11a196b1fe" }, { "type": "route", "uuid": "e86ab495-b7dd-4ce7-89b4-52f51ada141a" }, { "type": "route", "uuid": "5a010e64-c4d5-4a41-8d65-22ebdb60c1f4" }, { "type": "route", "uuid": "bb3a9c36-e380-4fee-845b-995597d51de1" }, { "type": "route", "uuid": "b0b7a701-56ce-49f3-87ae-c845e5993ad4" }, { "type": "route", "uuid": "37fd8b85-bae8-4816-8a62-7c069e6cb382" }, { "type": "route", "uuid": "56a7d952-10f3-494c-b494-38ee549c141c" }, { "type": "route", "uuid": "5f914cd1-a867-4414-9457-bcdc566f776f" }, { "type": "route", "uuid": "84f2641a-fdcd-4e86-b584-7640c440b74d" }, { "type": "route", "uuid": "43d41029-2b5a-4dcb-9f93-dce139303707" }, { "type": "route", "uuid": "c1061b3c-4f47-443b-a2f2-7c0110402e17" }, { "type": "route", "uuid": "af0ecfd5-09f6-4a2f-b373-5a1beb4e7507" }, { "type": "route", "uuid": "0788e7f1-041e-4727-8a0a-bb7ecf566114" }, { "type": "route", "uuid": "6e046dc1-7d50-4b77-ae4c-e40097e4f388" }, { "type": "route", "uuid": "c873df7c-085e-48dc-940b-910acc49ce3c" }, { "type": "route", "uuid": "d6f29de0-21ce-4757-9b46-8ec390134477" }, { "type": "route", "uuid": "51c60e79-4b18-4f17-8408-c6fa8a518d37" }, { "type": "route", "uuid": "3cbdaaa0-c202-4baf-affb-694c86d65bb9" }, { "type": "route", "uuid": "65fcbcaa-47f3-442a-a4d6-ed3d2e3281dc" }, { "type": "route", "uuid": "2e95da09-ed4a-4de8-8856-5cd9fc7141d2" }, { "type": "route", "uuid": "f69239ef-ccfd-480d-9850-6727c9996ceb" }, { "type": "route", "uuid": "60873a04-610d-424e-9817-9732793f4e2e" }, { "type": "route", "uuid": "a3a004fc-2f50-476c-8d13-cea89b496174" } ] }