{ "uuid": "dd380b54-669d-4f03-b368-d949d8b7f6ae", "lastMigration": 29, "name": "agentOS API V3, Diary Call Group", "endpointPrefix": "", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "88e8455c-e3a6-444a-9f92-d9c122950c1f", "documentation": "Get a list of all available allocations for a date + 7 days for a specified appointment type", "method": "get", "endpoint": "v3/diary/:shortName/allocations", "responses": [ { "uuid": "1ff0ba3b-8f5f-43b2-a7e7-f3f41b6c1000", "body": "[\n {\n \"End\": \"{{faker 'date.recent' 365}}\",\n \"StaffID\": \"\",\n \"StaffName\": \"\",\n \"Start\": \"{{faker 'date.recent' 365}}\"\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": "7e040d3a-dc62-44d5-bc03-c6ac880fb205", "documentation": "Delete an existing appointment using its unique identifier", "method": "delete", "endpoint": "v3/diary/:shortName/appointment", "responses": [ { "uuid": "ca3597ef-affe-47a2-8b8a-227e330123f4", "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": "7a363d78-d5a7-4a73-a7f6-340f8d439220", "documentation": "Get an appointment by ID", "method": "get", "endpoint": "v3/diary/:shortName/appointment", "responses": [ { "uuid": "4681210a-fe47-459d-973c-3fdc75960eec", "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 \"LinkedProperties\": [\n {\n \"Address1\": \"\",\n \"Address2\": \"\",\n \"Address3\": \"\",\n \"Address4\": \"\",\n \"AddressFlatRoomNumber\": \"\",\n \"AddressNumber\": \"\",\n \"ETag\": \"\",\n \"LatestTenancy\": {\n \"ETag\": \"\",\n \"EndDate\": \"{{faker 'date.recent' 365}}\",\n \"FixedDate\": \"{{faker 'date.recent' 365}}\",\n \"GlobalReference\": \"\",\n \"IsTenancyEnded\": {{faker 'datatype.boolean'}},\n \"IsTenancyProposed\": {{faker 'datatype.boolean'}},\n \"IsTenancySigned\": {{faker 'datatype.boolean'}},\n \"LinkedTenants\": [\n {\n \"ETag\": \"\",\n \"Email\": \"\",\n \"Forename\": \"\",\n \"OID\": \"\",\n \"PhoneNumber\": \"\",\n \"Surname\": \"\",\n \"Title\": \"\"\n }\n ],\n \"OID\": \"\",\n \"StartDate\": \"{{faker 'date.recent' 365}}\"\n },\n \"MainLandlord\": {\n \"ETag\": \"\",\n \"Email\": \"\",\n \"Forename\": \"\",\n \"OID\": \"\",\n \"PhoneNumber\": \"\",\n \"Surname\": \"\",\n \"Title\": \"\"\n },\n \"OID\": \"\",\n \"Postcode\": \"\"\n }\n ],\n \"NextRecurringDate\": \"{{faker 'date.recent' 365}}\",\n \"OID\": \"\",\n \"Recurrence\": {{faker 'number.int' max=99999}},\n \"RecurrenceType\": \"\",\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": "2c9287f3-8dc1-4a9e-a7ed-1f90ba5d1142", "documentation": "Post an appointment into a valid diary allocation", "method": "post", "endpoint": "v3/diary/:shortName/appointment", "responses": [ { "uuid": "188dcad2-0cc6-48b2-94f5-4a43d7dd1116", "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": "07e6160c-b47d-4a79-922d-0141088f2db3", "documentation": "Update an existing appointment using its unique identifier", "method": "put", "endpoint": "v3/diary/:shortName/appointment", "responses": [ { "uuid": "9c1ac178-8454-4c57-9bae-e27f95bd8122", "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": "557923a6-6bef-45f0-9cb3-3386cc65dc7d", "documentation": "Submit appointment feedback", "method": "post", "endpoint": "v3/diary/:shortName/appointment/feedback", "responses": [ { "uuid": "8a097def-b8a6-430e-a1cc-2e2752519620", "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": "1c25958f-3d96-4034-a69f-2da86363385f", "documentation": "A collection of diary appointments linked to a company filtered between specific dates and by appointment type", "method": "get", "endpoint": "v3/diary/:shortName/appointmentsbetweendates", "responses": [ { "uuid": "6b72ff8c-cb56-424f-ac99-3ffb41873296", "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 \"LinkedProperties\": [\n {\n \"Address1\": \"\",\n \"Address2\": \"\",\n \"Address3\": \"\",\n \"Address4\": \"\",\n \"AddressFlatRoomNumber\": \"\",\n \"AddressNumber\": \"\",\n \"ETag\": \"\",\n \"LatestTenancy\": {\n \"ETag\": \"\",\n \"EndDate\": \"{{faker 'date.recent' 365}}\",\n \"FixedDate\": \"{{faker 'date.recent' 365}}\",\n \"GlobalReference\": \"\",\n \"IsTenancyEnded\": {{faker 'datatype.boolean'}},\n \"IsTenancyProposed\": {{faker 'datatype.boolean'}},\n \"IsTenancySigned\": {{faker 'datatype.boolean'}},\n \"LinkedTenants\": [\n {\n \"ETag\": \"\",\n \"Email\": \"\",\n \"Forename\": \"\",\n \"OID\": \"\",\n \"PhoneNumber\": \"\",\n \"Surname\": \"\",\n \"Title\": \"\"\n }\n ],\n \"OID\": \"\",\n \"StartDate\": \"{{faker 'date.recent' 365}}\"\n },\n \"MainLandlord\": {\n \"ETag\": \"\",\n \"Email\": \"\",\n \"Forename\": \"\",\n \"OID\": \"\",\n \"PhoneNumber\": \"\",\n \"Surname\": \"\",\n \"Title\": \"\"\n },\n \"OID\": \"\",\n \"Postcode\": \"\"\n }\n ],\n \"NextRecurringDate\": \"{{faker 'date.recent' 365}}\",\n \"OID\": \"\",\n \"Recurrence\": {{faker 'number.int' max=99999}},\n \"RecurrenceType\": \"\",\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": "ab3d7c33-40c8-4e0c-8c22-47f928f240e3", "documentation": "A collection of all diary appointment types", "method": "get", "endpoint": "v3/diary/:shortName/appointmenttypes", "responses": [ { "uuid": "f81d8e83-1dca-40c1-b3ad-ec8d020e484c", "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": "9af41ab9-a5a7-44f9-b25c-56eeff5b252f", "documentation": "Retrieves all recurring appointments:-", "method": "get", "endpoint": "v3/diary/:shortName/recurringappointment", "responses": [ { "uuid": "ff59c687-fbe5-4ac6-a5d4-c1fb4b54dfdc", "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 \"LinkedProperties\": [\n {\n \"Address1\": \"\",\n \"Address2\": \"\",\n \"Address3\": \"\",\n \"Address4\": \"\",\n \"AddressFlatRoomNumber\": \"\",\n \"AddressNumber\": \"\",\n \"ETag\": \"\",\n \"LatestTenancy\": {\n \"ETag\": \"\",\n \"EndDate\": \"{{faker 'date.recent' 365}}\",\n \"FixedDate\": \"{{faker 'date.recent' 365}}\",\n \"GlobalReference\": \"\",\n \"IsTenancyEnded\": {{faker 'datatype.boolean'}},\n \"IsTenancyProposed\": {{faker 'datatype.boolean'}},\n \"IsTenancySigned\": {{faker 'datatype.boolean'}},\n \"LinkedTenants\": [\n {\n \"ETag\": \"\",\n \"Email\": \"\",\n \"Forename\": \"\",\n \"OID\": \"\",\n \"PhoneNumber\": \"\",\n \"Surname\": \"\",\n \"Title\": \"\"\n }\n ],\n \"OID\": \"\",\n \"StartDate\": \"{{faker 'date.recent' 365}}\"\n },\n \"MainLandlord\": {\n \"ETag\": \"\",\n \"Email\": \"\",\n \"Forename\": \"\",\n \"OID\": \"\",\n \"PhoneNumber\": \"\",\n \"Surname\": \"\",\n \"Title\": \"\"\n },\n \"OID\": \"\",\n \"Postcode\": \"\"\n }\n ],\n \"NextRecurringDate\": \"{{faker 'date.recent' 365}}\",\n \"OID\": \"\",\n \"Recurrence\": {{faker 'number.int' max=99999}},\n \"RecurrenceType\": \"\",\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" } ], "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": "88e8455c-e3a6-444a-9f92-d9c122950c1f" }, { "type": "route", "uuid": "7e040d3a-dc62-44d5-bc03-c6ac880fb205" }, { "type": "route", "uuid": "7a363d78-d5a7-4a73-a7f6-340f8d439220" }, { "type": "route", "uuid": "2c9287f3-8dc1-4a9e-a7ed-1f90ba5d1142" }, { "type": "route", "uuid": "07e6160c-b47d-4a79-922d-0141088f2db3" }, { "type": "route", "uuid": "557923a6-6bef-45f0-9cb3-3386cc65dc7d" }, { "type": "route", "uuid": "1c25958f-3d96-4034-a69f-2da86363385f" }, { "type": "route", "uuid": "ab3d7c33-40c8-4e0c-8c22-47f928f240e3" }, { "type": "route", "uuid": "9af41ab9-a5a7-44f9-b25c-56eeff5b252f" } ] }