{ "uuid": "4f885d1d-0900-49db-816d-f563e90a9ef4", "lastMigration": 19, "name": "LetMC Api V2, Basic (Tier 2)", "endpointPrefix": "", "latency": 0, "port": 3000, "hostname": "0.0.0.0", "routes": [ { "uuid": "63f5111b-176d-40b6-9040-219d0f81c483", "documentation": "A collection of all the areas for a company", "method": "get", "endpoint": "v2/tier2/:shortName/area/areas", "responses": [ { "uuid": "0b63c077-327f-4e62-bf8b-853c4da42ca5", "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": "359a2c77-58de-4f66-9778-66fcdc9a2517", "documentation": "Get a specific area given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier2/:shortName/area/areas/:areaID", "responses": [ { "uuid": "ea72630f-4759-4967-ae52-8ae6ff74515e", "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": "6705084d-b1c3-41a8-9669-f27a7c6e9345", "documentation": "All branches defined for a company", "method": "get", "endpoint": "v2/tier2/:shortName/branch/branches", "responses": [ { "uuid": "83ad7086-7b54-4bd3-8169-3620b61f73e8", "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": "d2a7abef-4a52-4941-95cb-21255dcf0041", "documentation": "Get a specific branch given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier2/:shortName/branch/branches/:branchID", "responses": [ { "uuid": "f6f41888-b5e6-4ff5-a555-c96b0336f6a2", "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": "fc4cb536-0ab7-4295-aed9-e6e19598d4fd", "documentation": "Information about a specific company", "method": "get", "endpoint": "v2/tier2/:shortName/company", "responses": [ { "uuid": "acb985f6-dda3-4066-ba3b-0e9c4dbcb9e6", "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": "ea0fc737-6548-4ad3-bbb1-51130632acf9", "documentation": "A collection of all counties available for a company", "method": "get", "endpoint": "v2/tier2/:shortName/county/counties", "responses": [ { "uuid": "df0218f4-6bda-4823-84f8-62cda3a4740f", "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": "b8e2ec97-1e2a-4fc0-bf08-6de51c3a141f", "documentation": "Get a specific county given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier2/:shortName/county/counties/:countyID", "responses": [ { "uuid": "7c5dfaad-a122-4664-b6d5-4dc0c23e6a36", "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": "de1f71d9-e9ab-4b5d-8d8e-47c53f40afc3", "documentation": "A collection of branches that manage a specific county", "method": "get", "endpoint": "v2/tier2/:shortName/county/counties/:countyID/branches", "responses": [ { "uuid": "dad030b9-600c-4da5-957e-0249ca0b5ef4", "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": "d470c7a6-5389-4c9b-9e78-b83d29f1c45f", "documentation": "A collection of all diary allocations", "method": "get", "endpoint": "v2/tier2/:shortName/diary/allocations", "responses": [ { "uuid": "e68e22d9-9a16-4ad3-9c6a-21cb3443227e", "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": "ad739863-6872-403c-aa89-1ac7b7740828", "documentation": "Get a specific diary allocation given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier2/:shortName/diary/allocations/:diaryAllocationID", "responses": [ { "uuid": "3dd69d92-0e7b-49e4-bfaf-c78dd4a27b22", "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": "ed0f6b05-5754-4541-a867-b7c8e5435cac", "documentation": "A collection of all diary appointments", "method": "get", "endpoint": "v2/tier2/:shortName/diary/appointments", "responses": [ { "uuid": "d08b3c06-3259-4fca-81b3-1bdf640e318d", "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": "bfee37e3-b1b9-4dd2-abd6-80b4b888118c", "documentation": "Get a specific diary appointment given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier2/:shortName/diary/appointments/:diaryAppointmentID", "responses": [ { "uuid": "201ffa3f-f11f-45b5-8c42-c1d06721c6d7", "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": "c3fbe259-cb12-4a9f-a946-e54c1080f767", "documentation": "A collection of all diary appointment types", "method": "get", "endpoint": "v2/tier2/:shortName/diary/appointmenttypes", "responses": [ { "uuid": "a87d925d-0991-4459-9686-540ba7566b00", "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": "30a06d69-09e2-4963-8fc8-024275d9c72f", "documentation": "Get a specific diary appointment type given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier2/:shortName/diary/appointmenttypes/:diaryAppointmentTypeID", "responses": [ { "uuid": "5e2429e0-41b5-4664-bb48-06b4b2aaab09", "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": "f82d577c-7267-413c-8b28-cf5cd5efb46d", "documentation": "Search all properties available for rent given a range of search criteria.", "method": "get", "endpoint": "v2/tier2/:shortName/lettings/advertised", "responses": [ { "uuid": "fed452c2-2d18-4837-94a8-e5877770533a", "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": "6d9dcdcc-ff70-450a-9ba2-baff3b7cb24b", "documentation": "Search all properties available for rent given a range of search criteria and dates.", "method": "get", "endpoint": "v2/tier2/:shortName/lettings/advertisedbetweendates", "responses": [ { "uuid": "a7e3c082-9b60-44e5-9b14-9be08965efa6", "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": "f7949d48-42ec-4a24-b6d2-f8480338dfb8", "documentation": "A collection of all the company's tenancies", "method": "get", "endpoint": "v2/tier2/:shortName/lettings/tenancies", "responses": [ { "uuid": "2fb3d099-5a4a-4a07-9abc-62cbbca56847", "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": "3855485f-2b59-4882-9d8e-c00422b00697", "documentation": "Get a specific tenancy given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier2/:shortName/lettings/tenancies/:tenancyID", "responses": [ { "uuid": "7253a2a7-a6d7-4a15-a59e-5c7703e1033f", "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": "2ee28f3a-2940-483b-af7c-872f0c6bded4", "documentation": "Downloads the brochure relating to the latest advertised rental of a property", "method": "get", "endpoint": "v2/tier2/:shortName/lettings/tenancies/:tenancyID/brochure", "responses": [ { "uuid": "125d2302-e3c9-4505-bc6b-525d37d71e5e", "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": "25403925-b03c-404f-a1fd-12f53e96664b", "documentation": "A collection of all photos in the company", "method": "get", "endpoint": "v2/tier2/:shortName/photo/photos", "responses": [ { "uuid": "ee5ae9cf-7681-4799-85e1-03410721991b", "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": "e69ecf3c-50de-4c69-b744-afa3dd551be1", "documentation": "Get a specific photo given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier2/:shortName/photo/photos/:photoID", "responses": [ { "uuid": "57d89db4-ec18-4ff8-bdcd-8052f209ca1c", "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": "d0dcccda-4695-4298-918e-d0db91a9951b", "documentation": "Downloads the photo of a property given the property and photo ID.", "method": "get", "endpoint": "v2/tier2/:shortName/photos/photo/:photoID/download", "responses": [ { "uuid": "cb304c09-b281-4cda-a509-70ebec75b625", "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": "abace6c9-164b-42c0-a2d4-bc3b78839225", "documentation": "A collection of all properties within a company", "method": "get", "endpoint": "v2/tier2/:shortName/property/properties", "responses": [ { "uuid": "1aea2528-4708-42f0-b428-23b4be80facb", "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": "7833ebc9-a61d-4429-b176-5cf69a48467b", "documentation": "Get a specific property given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier2/:shortName/property/properties/:propertyID", "responses": [ { "uuid": "33310331-dcc8-40a3-ad8e-fc7bf88e2740", "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": "cd93d8bb-0e61-4f73-9ba6-18dcb4906383", "documentation": "A collection of facilities linked to a block, property or room", "method": "get", "endpoint": "v2/tier2/:shortName/property/properties/:propertyID/facilities", "responses": [ { "uuid": "b986ea9b-44e3-457c-ac7a-64d971d5c7de", "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": "665582d8-67e6-47ea-8b81-4716888f1f90", "documentation": "A collection showing all the photos linked to a specific block, property or room", "method": "get", "endpoint": "v2/tier2/:shortName/property/properties/:propertyID/photos", "responses": [ { "uuid": "d6227980-b776-4a5f-8e1a-72779dbb3900", "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": "223eb3b7-b941-4c7f-b5cf-bb2dabfe7cd2", "documentation": "A collection of the rooms that belong to this property or block", "method": "get", "endpoint": "v2/tier2/:shortName/property/properties/:propertyID/rooms", "responses": [ { "uuid": "1ef2dee1-8d3a-47b9-8838-a824f9f407f8", "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": "7f541d56-bcfb-49a2-a8a2-c1f2b1187cca", "documentation": "A collection of all tenancies associated with this block, property or room", "method": "get", "endpoint": "v2/tier2/:shortName/property/properties/:propertyID/tenancies", "responses": [ { "uuid": "2943d781-9d8a-42a6-83f6-0d4e5e7f9a4d", "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": "655adff3-62bb-43fe-8bbc-57656312db5d", "documentation": "Downloads the energy efficiency report (EER) graph for a property", "method": "get", "endpoint": "v2/tier2/:shortName/property/structures/:propertyStructureID/reports/eer", "responses": [ { "uuid": "f2dee2b8-be4d-49cd-8e98-781b53aae5b2", "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": "b392a1f4-1698-47eb-9fb6-a297c9a90f7a", "documentation": "Downloads the environmental impact report (EIR) graph for a property", "method": "get", "endpoint": "v2/tier2/:shortName/property/structures/:propertyStructureID/reports/eir", "responses": [ { "uuid": "bf99e28d-0b58-4c58-be99-5370ade351a1", "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": "9c8d2e06-cc15-445a-b216-b221bbb34bc0", "documentation": "Search all sales properties available given a range of search criteria", "method": "get", "endpoint": "v2/tier2/:shortName/sales/advertisedsales", "responses": [ { "uuid": "2cee8a2f-99f4-4ef1-bab4-66ba34b7e1ba", "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": "e72703cc-2cbc-46e3-a15f-15ab37d54c27", "documentation": "Downloads the energy efficiency report (EER) graph for a sales instruction", "method": "get", "endpoint": "v2/tier2/:shortName/sales/reports/eer/:salesInstructionID", "responses": [ { "uuid": "d7e9e530-aa50-4933-b416-63139eb93556", "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": "c7ec364a-8acd-4532-bf28-8f6a4193df76", "documentation": "Downloads the energy efficiency report (EIR) graph for a sales instruction", "method": "get", "endpoint": "v2/tier2/:shortName/sales/reports/eir/:salesInstructionID", "responses": [ { "uuid": "74c22b3d-bec9-469a-8165-49dc4c01d29e", "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": "4e6aeea9-e659-4054-abd4-81c29fa7b084", "documentation": "A collection of all sales feature types linked to a company", "method": "get", "endpoint": "v2/tier2/:shortName/sales/salesfeaturetypes", "responses": [ { "uuid": "b06acad1-1eca-4afd-ac0a-7e47a0cff8cd", "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": "ec369d3e-1ee5-496e-92ee-20333292a4d5", "documentation": "Get a specific sales feature type given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier2/:shortName/sales/salesfeaturetypes/:salesFeatureTypeID", "responses": [ { "uuid": "de671845-49f0-407f-8182-40153d59abb3", "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": "20c09ca1-d91d-48c0-8717-bff758ada088", "documentation": "A collection of all sales instructions linked to a company", "method": "get", "endpoint": "v2/tier2/:shortName/sales/salesinstructions", "responses": [ { "uuid": "bb17e12c-caf0-4e15-93d9-7f414cc892f3", "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": "ad0e21a6-ce41-4ab3-aeb1-5cc0afce02ba", "documentation": "Get a specific sales instruction given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier2/:shortName/sales/salesinstructions/:salesInstructionID", "responses": [ { "uuid": "ef26c5ee-b8a5-4dea-a32d-3a27b1cacef8", "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": "b25b18a3-b918-4377-b0d2-032459dc2ef4", "documentation": "A collection of all features linked to a sales instruction", "method": "get", "endpoint": "v2/tier2/:shortName/sales/salesinstructions/:salesInstructionID/features", "responses": [ { "uuid": "eba874b3-5391-4601-bda5-9fa7c2e3b843", "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": "15759d1c-d193-4296-8f07-8a6930e8ca46", "documentation": "A collection of floor plans linked to an instruction", "method": "get", "endpoint": "v2/tier2/:shortName/sales/salesinstructions/:salesInstructionID/floorplans", "responses": [ { "uuid": "8e2d1e18-fe19-4dff-a52a-b030543ad86c", "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": "73f087c5-f726-4269-b3e8-0bfeac3c84c6", "documentation": "A collection of photos linked to an instruction", "method": "get", "endpoint": "v2/tier2/:shortName/sales/salesinstructions/:salesInstructionID/photos", "responses": [ { "uuid": "09508ce7-60b2-4e48-84fe-12fa10ad4a15", "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": "a1de47dc-b1dc-4fb0-a6d2-fa1f54860386", "documentation": "A collection of rooms linked to an instruction", "method": "get", "endpoint": "v2/tier2/:shortName/sales/salesinstructions/:salesInstructionID/rooms", "responses": [ { "uuid": "a0ff0417-29c7-42f8-90ec-f1b96ef2142d", "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": "5a728ded-8bca-405e-af2d-1c8c7a214990", "documentation": "A collection of all the staff members linked to a specific company", "method": "get", "endpoint": "v2/tier2/:shortName/staff/staff", "responses": [ { "uuid": "25d1ed05-833d-4f84-82f0-b097178c62eb", "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": "63074f5a-1c47-4bf6-80fe-3b1786a8bf15", "documentation": "Get a specific application staff given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier2/:shortName/staff/staff/:applicationStaffID", "responses": [ { "uuid": "24683a41-38f7-4f3d-b2ff-6500bf378721", "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": "98ce9da4-9c54-4232-8483-d42d4589bc34", "documentation": "Gets a list of available viewing slots for one or more properties", "method": "get", "endpoint": "v2/tier2/:shortName/viewing/bookings", "responses": [ { "uuid": "c9b1ff7c-d329-448f-8709-e2803edb9cdc", "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": "7ed9ab76-4346-4453-82e3-69c3f4a0a4f7", "documentation": "Book an appointment for a viewing slot returned from the GET verb", "method": "post", "endpoint": "v2/tier2/:shortName/viewing/bookings", "responses": [ { "uuid": "fa5ba1fb-827b-4de0-96d4-6d054d2c0320", "body": "{{faker 'random.boolean'}}", "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": "" } ] }