{ "uuid": "ddec7f66-539c-419c-8681-885fe8d29f89", "lastMigration": 29, "name": "LetMC Api V2, Basic (Tier 2)", "endpointPrefix": "", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "1762d91a-a54c-433e-8aab-d87cf1c7779e", "documentation": "A collection of all the areas for a company", "method": "get", "endpoint": "v2/tier2/:shortName/area/areas", "responses": [ { "uuid": "3ca8911c-a559-4cd3-8f4b-ab5aea4959e0", "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": "11fd0876-d5e4-4b05-8135-8fbd2c2fe9b6", "documentation": "Get a specific area given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier2/:shortName/area/areas/:areaID", "responses": [ { "uuid": "68a24ceb-6ef1-4474-b037-eb10ce729095", "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": "e6c9597f-a459-494d-a091-5368d4770ce2", "documentation": "All branches defined for a company", "method": "get", "endpoint": "v2/tier2/:shortName/branch/branches", "responses": [ { "uuid": "2a1764de-db33-4c79-b467-5fa6319077ce", "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": "2e0460a7-eadc-46da-9a43-45ec75888a96", "documentation": "Get a specific branch given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier2/:shortName/branch/branches/:branchID", "responses": [ { "uuid": "352620ce-3f02-4c4a-8d6c-c112abf72b0f", "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": "04842d44-0bdf-48e7-b6d7-9e0df037f9e6", "documentation": "Information about a specific company", "method": "get", "endpoint": "v2/tier2/:shortName/company", "responses": [ { "uuid": "d92c6138-a2a6-45dc-b3b0-f434ac088e9c", "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": "6b4f34a9-1d92-4f3c-ad5a-7a9dcfb72958", "documentation": "A collection of all counties available for a company", "method": "get", "endpoint": "v2/tier2/:shortName/county/counties", "responses": [ { "uuid": "d029df59-cde1-47f1-a96b-1ce5bbe26857", "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": "39a978dd-bd18-42b0-aeef-0f2db8f0bcbe", "documentation": "Get a specific county given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier2/:shortName/county/counties/:countyID", "responses": [ { "uuid": "9bc5e3ea-59bd-4742-a50a-2d81fccf85ab", "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": "a650f0e9-dad7-426c-989d-f22aa00c8773", "documentation": "A collection of branches that manage a specific county", "method": "get", "endpoint": "v2/tier2/:shortName/county/counties/:countyID/branches", "responses": [ { "uuid": "18f4d15c-d182-4669-921a-d46c82f230f5", "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": "7505260c-6007-4567-8c5a-82f3c84d5a2a", "documentation": "A collection of all diary allocations", "method": "get", "endpoint": "v2/tier2/:shortName/diary/allocations", "responses": [ { "uuid": "60732e1c-08d0-4a02-8fe7-01f626683c1f", "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": "5455c673-0ffb-4a46-b286-4a70d2f5e98f", "documentation": "Get a specific diary allocation given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier2/:shortName/diary/allocations/:diaryAllocationID", "responses": [ { "uuid": "8f35dfc3-804d-4d04-a8ba-2e5ae4c008a3", "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": "87d69fc0-9c78-46f2-ac6c-18c7ccbb9759", "documentation": "A collection of all diary appointments", "method": "get", "endpoint": "v2/tier2/:shortName/diary/appointments", "responses": [ { "uuid": "cfb5afab-6779-4577-91a9-b38d184ba53b", "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": "e4dfd872-6088-4bd7-9462-1ab3d0dafa4c", "documentation": "Get a specific diary appointment given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier2/:shortName/diary/appointments/:diaryAppointmentID", "responses": [ { "uuid": "0c09e2ec-10fe-4820-8295-8f8542ebdff8", "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": "ff7dd3d5-a03c-43ff-9fd7-bb135edd9693", "documentation": "A collection of all diary appointment types", "method": "get", "endpoint": "v2/tier2/:shortName/diary/appointmenttypes", "responses": [ { "uuid": "bcba709c-c2b1-4079-9aca-232afadb1a0b", "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": "27f5197f-e0e7-4756-9d11-547119668e52", "documentation": "Get a specific diary appointment type given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier2/:shortName/diary/appointmenttypes/:diaryAppointmentTypeID", "responses": [ { "uuid": "ece7ad09-cc45-4f8f-a8b2-009b68b86857", "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": "8997a5fa-14ea-40c2-91dc-f981e9757286", "documentation": "Search all properties available for rent given a range of search criteria.", "method": "get", "endpoint": "v2/tier2/:shortName/lettings/advertised", "responses": [ { "uuid": "3f9a9017-5f6e-4dd4-9c7e-9c189e9c788f", "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": "0ec19e29-3096-4515-897f-4432d00372cf", "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": "b650c514-021d-4aea-addd-f1024fe557a7", "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": "a9ae5afb-28a3-426e-9f23-3c8c52235cc1", "documentation": "A collection of all the company's tenancies", "method": "get", "endpoint": "v2/tier2/:shortName/lettings/tenancies", "responses": [ { "uuid": "7e739043-7de1-4526-af81-7d7983bfce73", "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": "5ae4dcbb-a67a-4094-838d-7ef5a9956edc", "documentation": "Get a specific tenancy given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier2/:shortName/lettings/tenancies/:tenancyID", "responses": [ { "uuid": "c0948998-ac9a-4899-be75-6d71807e4e09", "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": "909b8b7d-966b-4a7f-980a-3dc253b2028e", "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": "aba0e778-dcd5-4fdb-aee2-20f33118fc58", "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": "1a4074a5-2cdf-42fa-b48f-05be3ad9f074", "documentation": "A collection of all photos in the company", "method": "get", "endpoint": "v2/tier2/:shortName/photo/photos", "responses": [ { "uuid": "9bc9ae44-acaa-4dc6-b5f5-fe4624ff76fe", "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": "d52a9cce-1e36-41b1-be44-dd55187feae0", "documentation": "Get a specific photo given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier2/:shortName/photo/photos/:photoID", "responses": [ { "uuid": "347b3d8c-37e7-4942-b34a-8f660abcb7c4", "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": "4ec6463a-0c72-4f6c-a0d4-1c1c1e64e502", "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": "2a330efd-92b7-4500-9e72-696e5512c806", "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": "d76cc288-c336-4270-915f-91be625c77c4", "documentation": "A collection of all properties within a company", "method": "get", "endpoint": "v2/tier2/:shortName/property/properties", "responses": [ { "uuid": "e0a42b4d-7089-40a7-9c23-31e1467cfd57", "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": "6ed1d2f1-8ee0-4fc5-984d-a8cebb6c25f0", "documentation": "Get a specific property given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier2/:shortName/property/properties/:propertyID", "responses": [ { "uuid": "cb1980d4-defc-4809-9e9a-c6238ee3fae8", "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": "69840b06-1600-472d-bc73-c3f93885c3e9", "documentation": "A collection of facilities linked to a block, property or room", "method": "get", "endpoint": "v2/tier2/:shortName/property/properties/:propertyID/facilities", "responses": [ { "uuid": "a3fa9579-6fec-4720-bc58-ddc13dbffc36", "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": "2d2beecf-55dd-4d99-a541-ae7acb6d470a", "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": "9ce7a527-a351-4834-9f5c-f43bec0a9e35", "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": "a59000c4-268f-466d-b0a5-0978f99bd0ce", "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": "dfc433de-4924-4dea-b22a-be00ec9491f7", "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": "39916392-c564-43fd-a9ce-bae4f0367f72", "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": "d6da193a-4807-48a9-9dc8-f470634bdfe1", "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": "e6aa831a-25ce-4bc1-a1b0-88c810f1554b", "documentation": "Downloads the energy efficiency report (EER) graph for a property", "method": "get", "endpoint": "v2/tier2/:shortName/property/structures/:propertyStructureID/reports/eer", "responses": [ { "uuid": "dc1726aa-53d8-403f-b709-d167497f5f93", "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": "b16e9416-93e9-4b12-9f0b-e33e20d376cc", "documentation": "Downloads the environmental impact report (EIR) graph for a property", "method": "get", "endpoint": "v2/tier2/:shortName/property/structures/:propertyStructureID/reports/eir", "responses": [ { "uuid": "cc62c5cb-9820-46ca-9e42-260ce21c1e4d", "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": "89847595-ee79-4176-a2e7-cdf2beb64237", "documentation": "Search all sales properties available given a range of search criteria", "method": "get", "endpoint": "v2/tier2/:shortName/sales/advertisedsales", "responses": [ { "uuid": "ba88f8d3-91e1-461b-9eb2-60a3f2eb98ef", "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": "768b3c56-2c2e-44d2-b045-3873c0539d39", "documentation": "Downloads the energy efficiency report (EER) graph for a sales instruction", "method": "get", "endpoint": "v2/tier2/:shortName/sales/reports/eer/:salesInstructionID", "responses": [ { "uuid": "83829da3-59f1-48f9-94d3-a11b87c46977", "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": "ebd2eaf8-192d-4e40-a4dd-e0e0925d7107", "documentation": "Downloads the energy efficiency report (EIR) graph for a sales instruction", "method": "get", "endpoint": "v2/tier2/:shortName/sales/reports/eir/:salesInstructionID", "responses": [ { "uuid": "2e9fb64a-95a1-4fd3-8d58-1a9e9873131b", "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": "1534d51a-0c5b-4f2f-9b9f-107da7c3fb53", "documentation": "A collection of all sales feature types linked to a company", "method": "get", "endpoint": "v2/tier2/:shortName/sales/salesfeaturetypes", "responses": [ { "uuid": "96cf84ef-63ce-45dc-9b78-a7a412cc6e5e", "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": "2b3c8f68-0ea7-4e01-ba7f-6913d7df8242", "documentation": "Get a specific sales feature type given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier2/:shortName/sales/salesfeaturetypes/:salesFeatureTypeID", "responses": [ { "uuid": "67180761-6dd4-44d3-a703-4ac58312c442", "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": "a0af0e7d-861e-47bc-bc4b-5e7bb1d32e5c", "documentation": "A collection of all sales instructions linked to a company", "method": "get", "endpoint": "v2/tier2/:shortName/sales/salesinstructions", "responses": [ { "uuid": "bc765e12-32f4-4fdd-bba3-8cf0540f47fa", "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": "9a120888-4e51-4594-95d3-2b1a4ab8355e", "documentation": "Get a specific sales instruction given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier2/:shortName/sales/salesinstructions/:salesInstructionID", "responses": [ { "uuid": "656c6015-dff9-4ccf-bff6-f68837d7ede3", "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": "2be65dce-21d8-467b-bb8b-4f08d0a3e209", "documentation": "A collection of all features linked to a sales instruction", "method": "get", "endpoint": "v2/tier2/:shortName/sales/salesinstructions/:salesInstructionID/features", "responses": [ { "uuid": "7d77c259-7bc6-4f4d-b363-2536a29c9dba", "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": "880bc644-ee69-470b-bd63-7a04e4e082f3", "documentation": "A collection of floor plans linked to an instruction", "method": "get", "endpoint": "v2/tier2/:shortName/sales/salesinstructions/:salesInstructionID/floorplans", "responses": [ { "uuid": "ec2c390b-cd11-492e-8665-94cc89c13716", "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": "57c8aa84-f285-48b2-8fe8-40db6181c7a9", "documentation": "A collection of photos linked to an instruction", "method": "get", "endpoint": "v2/tier2/:shortName/sales/salesinstructions/:salesInstructionID/photos", "responses": [ { "uuid": "42219450-fb6b-4295-a07a-1be35432268c", "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": "4e223614-23e0-4993-acf3-bc9b519bd276", "documentation": "A collection of rooms linked to an instruction", "method": "get", "endpoint": "v2/tier2/:shortName/sales/salesinstructions/:salesInstructionID/rooms", "responses": [ { "uuid": "79da2420-5c8b-4dcd-8c06-a7a44f8d13e8", "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": "38868745-6694-4bc9-9cbd-f4fab069487c", "documentation": "A collection of all the staff members linked to a specific company", "method": "get", "endpoint": "v2/tier2/:shortName/staff/staff", "responses": [ { "uuid": "81d0382c-0082-4289-88d4-17da01fd9ca6", "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": "5b7ae03b-71e6-434b-be90-6ccf1baacf0b", "documentation": "Get a specific application staff given its unique Object ID (OID)", "method": "get", "endpoint": "v2/tier2/:shortName/staff/staff/:applicationStaffID", "responses": [ { "uuid": "4e63aa42-f5a4-448b-bc0c-a82d1b875093", "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": "164ea1d8-1c1b-4967-aad5-fedef0bb39ab", "documentation": "Gets a list of available viewing slots for one or more properties", "method": "get", "endpoint": "v2/tier2/:shortName/viewing/bookings", "responses": [ { "uuid": "9c25af6e-a1ea-4b52-a3bd-6d53f3ca20fd", "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": "d1a70889-20ed-4a50-8c0e-9335d63a1468", "documentation": "Book an appointment for a viewing slot returned from the GET verb", "method": "post", "endpoint": "v2/tier2/:shortName/viewing/bookings", "responses": [ { "uuid": "662bd75b-fe23-4737-bd76-c0e7848fdd1b", "body": "{{faker 'datatype.boolean'}}", "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": "1762d91a-a54c-433e-8aab-d87cf1c7779e" }, { "type": "route", "uuid": "11fd0876-d5e4-4b05-8135-8fbd2c2fe9b6" }, { "type": "route", "uuid": "e6c9597f-a459-494d-a091-5368d4770ce2" }, { "type": "route", "uuid": "2e0460a7-eadc-46da-9a43-45ec75888a96" }, { "type": "route", "uuid": "04842d44-0bdf-48e7-b6d7-9e0df037f9e6" }, { "type": "route", "uuid": "6b4f34a9-1d92-4f3c-ad5a-7a9dcfb72958" }, { "type": "route", "uuid": "39a978dd-bd18-42b0-aeef-0f2db8f0bcbe" }, { "type": "route", "uuid": "a650f0e9-dad7-426c-989d-f22aa00c8773" }, { "type": "route", "uuid": "7505260c-6007-4567-8c5a-82f3c84d5a2a" }, { "type": "route", "uuid": "5455c673-0ffb-4a46-b286-4a70d2f5e98f" }, { "type": "route", "uuid": "87d69fc0-9c78-46f2-ac6c-18c7ccbb9759" }, { "type": "route", "uuid": "e4dfd872-6088-4bd7-9462-1ab3d0dafa4c" }, { "type": "route", "uuid": "ff7dd3d5-a03c-43ff-9fd7-bb135edd9693" }, { "type": "route", "uuid": "27f5197f-e0e7-4756-9d11-547119668e52" }, { "type": "route", "uuid": "8997a5fa-14ea-40c2-91dc-f981e9757286" }, { "type": "route", "uuid": "0ec19e29-3096-4515-897f-4432d00372cf" }, { "type": "route", "uuid": "a9ae5afb-28a3-426e-9f23-3c8c52235cc1" }, { "type": "route", "uuid": "5ae4dcbb-a67a-4094-838d-7ef5a9956edc" }, { "type": "route", "uuid": "909b8b7d-966b-4a7f-980a-3dc253b2028e" }, { "type": "route", "uuid": "1a4074a5-2cdf-42fa-b48f-05be3ad9f074" }, { "type": "route", "uuid": "d52a9cce-1e36-41b1-be44-dd55187feae0" }, { "type": "route", "uuid": "4ec6463a-0c72-4f6c-a0d4-1c1c1e64e502" }, { "type": "route", "uuid": "d76cc288-c336-4270-915f-91be625c77c4" }, { "type": "route", "uuid": "6ed1d2f1-8ee0-4fc5-984d-a8cebb6c25f0" }, { "type": "route", "uuid": "69840b06-1600-472d-bc73-c3f93885c3e9" }, { "type": "route", "uuid": "2d2beecf-55dd-4d99-a541-ae7acb6d470a" }, { "type": "route", "uuid": "a59000c4-268f-466d-b0a5-0978f99bd0ce" }, { "type": "route", "uuid": "39916392-c564-43fd-a9ce-bae4f0367f72" }, { "type": "route", "uuid": "e6aa831a-25ce-4bc1-a1b0-88c810f1554b" }, { "type": "route", "uuid": "b16e9416-93e9-4b12-9f0b-e33e20d376cc" }, { "type": "route", "uuid": "89847595-ee79-4176-a2e7-cdf2beb64237" }, { "type": "route", "uuid": "768b3c56-2c2e-44d2-b045-3873c0539d39" }, { "type": "route", "uuid": "ebd2eaf8-192d-4e40-a4dd-e0e0925d7107" }, { "type": "route", "uuid": "1534d51a-0c5b-4f2f-9b9f-107da7c3fb53" }, { "type": "route", "uuid": "2b3c8f68-0ea7-4e01-ba7f-6913d7df8242" }, { "type": "route", "uuid": "a0af0e7d-861e-47bc-bc4b-5e7bb1d32e5c" }, { "type": "route", "uuid": "9a120888-4e51-4594-95d3-2b1a4ab8355e" }, { "type": "route", "uuid": "2be65dce-21d8-467b-bb8b-4f08d0a3e209" }, { "type": "route", "uuid": "880bc644-ee69-470b-bd63-7a04e4e082f3" }, { "type": "route", "uuid": "57c8aa84-f285-48b2-8fe8-40db6181c7a9" }, { "type": "route", "uuid": "4e223614-23e0-4993-acf3-bc9b519bd276" }, { "type": "route", "uuid": "38868745-6694-4bc9-9cbd-f4fab069487c" }, { "type": "route", "uuid": "5b7ae03b-71e6-434b-be90-6ccf1baacf0b" }, { "type": "route", "uuid": "164ea1d8-1c1b-4967-aad5-fedef0bb39ab" }, { "type": "route", "uuid": "d1a70889-20ed-4a50-8c0e-9335d63a1468" } ] }