{ "opencollection": "1.0.0", "info": { "name": "Arthur Maintenance API", "version": "2.0.0" }, "request": { "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.arthuronline.co.uk/oauth/authorize", "accessTokenUrl": "https://auth.arthuronline.co.uk/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "Tasks", "type": "folder" }, "items": [ { "info": { "name": "List Subtasks on Task", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/tasks/:task_id/subtasks", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "task_id", "value": "", "type": "path", "description": "Arthur task id." }, { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "This endpoint retrieves a list of subtasks associated with the given task ID." }, { "info": { "name": "Create Subtask on Task", "type": "http" }, "http": { "method": "POST", "url": "https://api.arthuronline.co.uk/v2/tasks/:task_id/subtasks", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "task_id", "value": "", "type": "path", "description": "Arthur task id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a new subtask record for a  task . The API will return the saved data and a unique subtask ID.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ndescription \n subtask nb1 \n String \n Yes \n\ndue_date \n 2020-09-22 \n Date \n No \n\ncompleted \n true \n Boolean \n No" }, { "info": { "name": "View Subtask On Task", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/tasks/:task_id/subtasks/:subtask_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "task_id", "value": "", "type": "path", "description": "Arthur task id." }, { "name": "subtask_id", "value": "", "type": "path", "description": "Arthur subtask id." } ] }, "docs": "This API endpoint retrieves the details of a single subtask, identified by its unique  subtask_id .\n\nUse this endpoint to view the specific details of a subtask on a task." }, { "info": { "name": "Update Subtask On Task", "type": "http" }, "http": { "method": "PUT", "url": "https://api.arthuronline.co.uk/v2/tasks/:task_id/subtasks/:subtask_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "task_id", "value": "", "type": "path", "description": "Arthur task id." }, { "name": "subtask_id", "value": "", "type": "path", "description": "Arthur subtask id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint updates an existing subtask on a task using the same fields as the 'Add Subtask' endpoint. The API will return the updated data for the note in the response.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ndescription \n subtask nb1 \n String \n No \n\ndue_date \n 2020-09-22 \n Date \n No \n\ncompleted \n true \n Boolean \n No" }, { "info": { "name": "Delete Subtask On Task", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.arthuronline.co.uk/v2/tasks/:task_id/subtasks/:subtask_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "task_id", "value": "", "type": "path", "description": "Arthur task id." }, { "name": "subtask_id", "value": "", "type": "path", "description": "Arthur subtask id." } ] }, "docs": "This endpoint deletes an existing subtask note using the subtask  id ." }, { "info": { "name": "List Workorders On Task", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/tasks/:task_id/workorders", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "task_id", "value": "", "type": "path", "description": "Arthur task id." }, { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "This endpoint retrieves a list of workorders associated with the given task ID." }, { "info": { "name": "Create Workorder On Task", "type": "http" }, "http": { "method": "POST", "url": "https://api.arthuronline.co.uk/v2/tasks/:task_id/workorders", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "task_id", "value": "", "type": "path", "description": "Arthur task id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a new workorder record for a  task . The API will return the saved data and a unique workorder ID.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ntitle \n workorder title \n String \n No \n\ndescription \n workorder description \n String \n No \n\ninvite_contractors \n [123,1234] \n Array(integer) \n No \n\nservice_type \n Carpet Layer \n String \n Yes \n\nstart_date \n 2020-02-20 \n Date \n No \n\ndue_date \n 2020-02-20 \n Date" }, { "info": { "name": "View Workorder On Task", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/tasks/:task_id/workorders/:workorder_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "task_id", "value": "", "type": "path", "description": "Arthur task id." }, { "name": "workorder_id", "value": "", "type": "path", "description": "Arthur workorder id." } ] }, "docs": "This API endpoint retrieves the details of a single task  workorder , identified by its unique  id ." }, { "info": { "name": "Update Workorder On Task", "type": "http" }, "http": { "method": "PUT", "url": "https://api.arthuronline.co.uk/v2/tasks/:task_id/workorders/:workorder_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "task_id", "value": "", "type": "path", "description": "Arthur task id." }, { "name": "workorder_id", "value": "", "type": "path", "description": "Arthur workorder id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint updates an existing workorder on a task using the same fields as the 'Add Workorder' endpoint. The API will return the updated data for the tenancy in the response.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ntitle \n workorder title \n String \n No \n\ndescription \n workorder description \n String \n No \n\ninvite_contractors \n [123,1234] \n Array(integer) \n No \n\nservice_type \n Carpet Layer \n String \n No \n\nstart_date \n 20" }, { "info": { "name": "List Tags on Task", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/tasks/:task_id/tags", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "task_id", "value": "", "type": "path", "description": "Arthur task id." }, { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "This endpoint retrieves a list of tags associated with the given Task ID." }, { "info": { "name": "Tag Task", "type": "http" }, "http": { "method": "PUT", "url": "https://api.arthuronline.co.uk/v2/tasks/:task_id/tags", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "task_id", "value": "", "type": "path", "description": "Arthur task id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a new tag record for a  task . The API will return the saved data and a unique tag ID.\n\nSupported Fields \n The following fields are supported for the request body\nTag field should be a valid tag ID or name.\n\nField \n Example \n Type \n Required? \n\ntag \n [\"123\"] \n Array(String) \n Yes" }, { "info": { "name": "Untag Task", "type": "http" }, "http": { "method": "PUT", "url": "https://api.arthuronline.co.uk/v2/tasks/:task_id/untag", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "task_id", "value": "", "type": "path", "description": "Arthur task id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to unassign tag record from a  task . The API will return the saved data. Tag field should be a valid tag ID or name.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ntag \n \"123\" \n String \n Yes" }, { "info": { "name": "Untag All Task Tags", "type": "http" }, "http": { "method": "PUT", "url": "https://api.arthuronline.co.uk/v2/tasks/:task_id/untag_all", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "task_id", "value": "", "type": "path", "description": "Arthur task id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ] }, "docs": "Use this endpoint to unassign all tags from the  task ." }, { "info": { "name": "List Notes on Task", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/tasks/:task_id/notes", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "task_id", "value": "", "type": "path", "description": "Arthur task id." }, { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "This endpoint retrieves a list of  notes  associated with the given task ID." }, { "info": { "name": "Create Note on Task", "type": "http" }, "http": { "method": "POST", "url": "https://api.arthuronline.co.uk/v2/tasks/:task_id/notes", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "task_id", "value": "", "type": "path", "description": "Arthur task id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a new note record for a  task . The API will return the saved data and a unique note ID.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ncontent \n Moving away \n String \n Yes \n\ntags \n ['one','two'] \n Array(String) \n No" }, { "info": { "name": "View Note on Task", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/tasks/:task_id/notes/:note_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "task_id", "value": "", "type": "path", "description": "Arthur task id." }, { "name": "note_id", "value": "", "type": "path", "description": "Arthur note id." } ] }, "docs": "This API endpoint retrieves the details of a single task  note , identified by its unique  id" }, { "info": { "name": "Update Note on Task", "type": "http" }, "http": { "method": "PUT", "url": "https://api.arthuronline.co.uk/v2/tasks/:task_id/notes/:note_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "task_id", "value": "", "type": "path", "description": "Arthur task id." }, { "name": "note_id", "value": "", "type": "path", "description": "Arthur note id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint updates an existing note on a task using the same fields as the 'Add Note' endpoint. The API will return the updated data for the note in the response.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ncontent \n Moving away \n String \n No \n\ntags \n ['one','two'] \n Array(String) \n No" }, { "info": { "name": "Delete Note on Task", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.arthuronline.co.uk/v2/tasks/:task_id/notes/:note_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "task_id", "value": "", "type": "path", "description": "Arthur task id." }, { "name": "note_id", "value": "", "type": "path", "description": "Arthur note id." } ] }, "docs": "This endpoint deletes an existing task note using the note  id ." }, { "info": { "name": "Get Recipients for Task", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/tasks/:task_id/conversation_recipients", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "task_id", "value": "", "type": "path", "description": "Arthur task id." } ] }, "docs": "This endpoint retrieves a list of conversation recipients on a task record, identified by its unique  task_id ." }, { "info": { "name": "List Conversations on Task", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/tasks/:task_id/conversations", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "task_id", "value": "", "type": "path", "description": "Arthur task id." }, { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "This endpoint retrieves a list of conversations on a task, identified by its unique  task_id ." }, { "info": { "name": "Add Conversation on Task", "type": "http" }, "http": { "method": "POST", "url": "https://api.arthuronline.co.uk/v2/tasks/:task_id/conversations", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "task_id", "value": "", "type": "path", "description": "Arthur task id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a new conversation on a task record. The API will return the saved data and a unique Conversation ID.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\nmessage \n It's done \n String \n Yes \n\nsubject \n Meeting tomorrow \n String \n Yes \n\nperson_ids \n ['1','2'] \n Array(String) \n Yes" }, { "info": { "name": "List Assets on Task", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/tasks/:task_id/assets", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "task_id", "value": "", "type": "path", "description": "Arthur task id." }, { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "This endpoint retrieves a list of assets associated with the given task ID." }, { "info": { "name": "View Asset on Task", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/tasks/:task_id/assets/:asset_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "task_id", "value": "", "type": "path", "description": "Arthur task id." }, { "name": "asset_id", "value": "", "type": "path", "description": "Arthur asset id." } ] }, "docs": "This API endpoint retrieves the details of a single task  asset , identified by its unique  id ." }, { "info": { "name": "List Tenants on Task", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/tasks/:task_id/tenants", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "task_id", "value": "", "type": "path", "description": "Arthur task id." }, { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "This retrieves a list of tenants related to a task" }, { "info": { "name": "View Tenant on Task", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/tasks/:task_id/tenants/:tenant_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "task_id", "value": "", "type": "path", "description": "Arthur task id." }, { "name": "tenant_id", "value": "", "type": "path", "description": "Arthur tenant id." } ] }, "docs": "This API endpoint retrieves the details of a single tenant on a task, identified by its unique  id ." }, { "info": { "name": "List Tasks", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/tasks", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "status", "value": "", "type": "query", "description": "Filter by task status, which should be provided as a comma-separated list" }, { "name": "assigned_to", "value": "", "type": "query", "description": "Filter by assigned property manager name" }, { "name": "created_date_from", "value": "", "type": "query", "description": "Filters tasks by the due date, starting from the specified date. Use the format yyyy-mm-dd to input the date" }, { "name": "created_date_to", "value": "", "type": "query", "description": "Filters tasks by the created date, up to the specified date. Use the format yyyy-mm-dd to input the date" }, { "name": "due_date_from", "value": "", "type": "query", "description": "Filters tasks by the due date, starting from the specified date. Use the format yyyy-mm-dd to input the date" }, { "name": "due_date_to", "value": "", "type": "query", "description": "Filters tasks by the due date, up to the specified date. Use the format yyyy-mm-dd to input the date" }, { "name": "task_type", "value": "", "type": "query", "description": "Filter tasks by type" }, { "name": "tags", "value": "", "type": "query", "description": "Filter by tags associated with the tasks, which should be provided as a comma-separated list" }, { "name": "_q", "value": "", "type": "query", "description": "Filter by a keyword" }, { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "This retrieves a list of tasks.\n\nSee available filters below to customize the list of tasks returned." }, { "info": { "name": "List Tasks By Status", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/tasks/:status", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "status", "value": "", "type": "path", "description": "Arthur status." }, { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "List all Task with status provided: live, pending, cancelled or completed" }, { "info": { "name": "View Task", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/tasks/:task_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "task_id", "value": "", "type": "path", "description": "Arthur task id." } ] }, "docs": "This API endpoint retrieves the details of a single task, identified by its unique  task_id .\n\nUse this endpoint to view the specific details of a task." }, { "info": { "name": "Update Task", "type": "http" }, "http": { "method": "PUT", "url": "https://api.arthuronline.co.uk/v2/tasks/:task_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "task_id", "value": "", "type": "path", "description": "Arthur task id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint updates an existing task. Any fields that are not provided will not be changed. The API will return the updated data for the task in the response.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ntask_type \n Inspection \n String \n No \n\ndescription \n Radiator not working \n String \n No \n\ntags \n ['one','two'] \n Array(String) \n No \n\ndue_date \n 2020-10-11 \n Date \n No \n\ndue_time \n 15:32 \n Time \n No \n\nassigned_managers \n [123" }, { "info": { "name": "Delete Task", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.arthuronline.co.uk/v2/tasks/:task_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "task_id", "value": "", "type": "path", "description": "Arthur task id." } ] }, "docs": "This endpoint deletes an existing task using the task  id ." }, { "info": { "name": "Update Status On Task", "type": "http" }, "http": { "method": "PUT", "url": "https://api.arthuronline.co.uk/v2/tasks/:task_id/status", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "task_id", "value": "", "type": "path", "description": "Arthur task id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint updates an existing task status. The API will return the updated data for the task in the response.\n\nSupported Fields \n The following fields are supported for the request body\nStatus must be one of these: live, pending, cancelled, completed\n\nField \n Example \n Type \n Required? \n\nstatus \n live \n String \n Yes" } ] }, { "info": { "name": "Subtasks", "type": "folder" }, "items": [ { "info": { "name": "List Subtasks", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/subtasks", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "Get all Subtasks" }, { "info": { "name": "View Subtask", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/subtasks/:subtask_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "subtask_id", "value": "", "type": "path", "description": "Arthur subtask id." } ] }, "docs": "Get Subtask" }, { "info": { "name": "Update Subtask", "type": "http" }, "http": { "method": "PUT", "url": "https://api.arthuronline.co.uk/v2/subtasks/:subtask_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "subtask_id", "value": "", "type": "path", "description": "Arthur subtask id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Subtask\n\nSupported Fields \n\nField \n Example \n Type \n Default \n Required? \n\ndescription \n subtask nb1 \n String \n\nNo \n\ndue_date \n 2020-09-22 \n Date \n\nNo \n\ncompleted \n true \n Boolean \n\nNo" }, { "info": { "name": "Delete Subtask", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.arthuronline.co.uk/v2/subtasks/:subtask_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "subtask_id", "value": "", "type": "path", "description": "Arthur subtask id." } ] }, "docs": "Delete Subtask" } ] }, { "info": { "name": "Workorders", "type": "folder" }, "items": [ { "info": { "name": "List Transactions On Workorder", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/workorders/:workorder_id/transactions", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "workorder_id", "value": "", "type": "path", "description": "Arthur workorder id." }, { "name": "statement", "value": "", "type": "query", "description": "Filters the transactions by statement. The available options are tenant , tenant-deposit , property-owner , \n property-owner-consolidated , contractor , tenancy-closing-statement , late-rents , contingency-statement , invoices" }, { "name": "status", "value": "", "type": "query", "description": "The status of the transaction. The available options are paid , unpaid , partpaid , outstanding , or overdue . Use this parameter to filter transactions based on their payment status." }, { "name": "date_from", "value": "", "type": "query", "description": "Filters the transactions by the date, starting from the specified date. Use the format yyyy-mm-dd to input the date." }, { "name": "date_to", "value": "", "type": "query", "description": "Filters the transactions by the date, up to the specified date. Use the format yyyy-mm-dd to input the date." }, { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "This retrieves a list of transactions for a Workorder .\n\nSee available filters below to customize the list of transactions returned." }, { "info": { "name": "List Certificates On Workorder", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/workorders/:workorder_id/certificates", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "workorder_id", "value": "", "type": "path", "description": "Arthur workorder id." }, { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "This endpoint retrieves a list of certificates associated with the given workorder ID." }, { "info": { "name": "List Quotes On Workorder", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/workorders/:workorder_id/quotes", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "workorder_id", "value": "", "type": "path", "description": "Arthur workorder id." }, { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "This endpoint retrieves a list of quotes associated with the given Workorder ID." }, { "info": { "name": "View Quote On Workorder", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/workorders/:workorder_id/quotes/:quote_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "workorder_id", "value": "", "type": "path", "description": "Arthur workorder id." }, { "name": "quote_id", "value": "", "type": "path", "description": "Arthur quote id." } ] }, "docs": "This API endpoint retrieves the details of a single quote, identified by its unique quote_id .\n\nUse this endpoint to view the specific details of a quote on a workorder." }, { "info": { "name": "List Invoices On Workorder", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/workorders/:workorder_id/invoices", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "workorder_id", "value": "", "type": "path", "description": "Arthur workorder id." }, { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "This endpoint retrieves a list of contractor invoices associated with the given Workorder ID." }, { "info": { "name": "View Invoice On Workorder", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/workorders/:workorder_id/invoices/:invoice_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "workorder_id", "value": "", "type": "path", "description": "Arthur workorder id." }, { "name": "invoice_id", "value": "", "type": "path", "description": "Arthur invoice id." } ] }, "docs": "This API endpoint retrieves the details of a single invoice, identified by its unique  invoice_id .\n\nUse this endpoint to view the specific details of a contractor invoice on a workorder." }, { "info": { "name": "List Assets on Workorder", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/workorders/:workorder_id/assets", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "workorder_id", "value": "", "type": "path", "description": "Arthur workorder id." }, { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "This endpoint retrieves a list of assets associated with the given workorder ID." }, { "info": { "name": "Create Asset on Workorder", "type": "http" }, "http": { "method": "POST", "url": "https://api.arthuronline.co.uk/v2/workorders/:workorder_id/assets", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "workorder_id", "value": "", "type": "path", "description": "Arthur workorder id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a new asset related to an  workorder . The API will return the saved data.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\nasset_type \n image \n String \n No \n\nname \n inventory \n String \n No \n\nshare_manager \n true \n Boolean \n No \n\nshare_tenant \n false \n Boolean \n No \n\nshare_contractor \n true \n Boolean \n No \n\nshare_owner \n true \n Boolean \n No \n\nfile \n base64 \n String \n Yes \n\nmime_type \n application/pdf \n S" }, { "info": { "name": "View Asset on Workorder", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/workorders/:workorder_id/assets/:edge_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "workorder_id", "value": "", "type": "path", "description": "Arthur workorder id." } ] }, "docs": "This API endpoint retrieves the details of a single asset, identified by its unique  asset_id .\n\nUse this endpoint to view the specific details of an asset on a workorder." }, { "info": { "name": "Get Recipients for Workorder", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/workorders/:workorder_id/conversation_recipients", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "workorder_id", "value": "", "type": "path", "description": "Arthur workorder id." } ] }, "docs": "This endpoint retrieves a list of conversation recipients on a workorder record, identified by its unique  workorder_id ." }, { "info": { "name": "List Conversations on Workorder", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/workorders/:workorder_id/conversations", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "workorder_id", "value": "", "type": "path", "description": "Arthur workorder id." }, { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "This endpoint retrieves a list of conversations on a workorder, identified by its unique  workorder_id ." }, { "info": { "name": "Create Conversation on Workorder", "type": "http" }, "http": { "method": "POST", "url": "https://api.arthuronline.co.uk/v2/workorders/:workorder_id/conversations", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "workorder_id", "value": "", "type": "path", "description": "Arthur workorder id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a new conversation on a workorder record. The API will return the saved data and a unique Conversation ID.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\nmessage \n It's done \n String \n Yes \n\nsubject \n Meeting tomorrow \n String \n Yes \n\nperson_ids \n ['1','2'] \n Array(String) \n Yes" }, { "info": { "name": "List Notes on Workorder", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/workorders/:workorder_id/notes", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "workorder_id", "value": "", "type": "path", "description": "Arthur workorder id." }, { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "This endpoint retrieves a list of  notes  associated with the given workorder ID." }, { "info": { "name": "Add Note on Workorder", "type": "http" }, "http": { "method": "POST", "url": "https://api.arthuronline.co.uk/v2/workorders/:workorder_id/notes", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "workorder_id", "value": "", "type": "path", "description": "Arthur workorder id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a new note record for a  workorder . The API will return the saved data and a unique note ID.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ncontent \n Moving away \n String \n Yes \n\ntags \n ['one','two'] \n Array(String) \n No" }, { "info": { "name": "View Note on Workorder", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/workorders/:workorder_id/notes/:edge_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "workorder_id", "value": "", "type": "path", "description": "Arthur workorder id." } ] }, "docs": "This API endpoint retrieves the details of a single workorder  note , identified by its unique  id" }, { "info": { "name": "Update Note on Workorder", "type": "http" }, "http": { "method": "PUT", "url": "https://api.arthuronline.co.uk/v2/workorders/:workorder_id/notes/:note_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "workorder_id", "value": "", "type": "path", "description": "Arthur workorder id." }, { "name": "note_id", "value": "", "type": "path", "description": "Arthur note id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint updates an existing note on a workorder using the same fields as the 'Add Note' endpoint. The API will return the updated data for the note in the response.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ncontent \n Moving away \n String \n No \n\ntags \n ['one','two'] \n Array(String) \n No" }, { "info": { "name": "Delete Note on Workorder", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.arthuronline.co.uk/v2/workorders/:workorder_id/notes/:note_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "workorder_id", "value": "", "type": "path", "description": "Arthur workorder id." }, { "name": "note_id", "value": "", "type": "path", "description": "Arthur note id." } ] }, "docs": "This endpoint deletes an existing workorder note using the note  id ." }, { "info": { "name": "List Tags on Workorder", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/workorders/:workorder_id/tags", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "workorder_id", "value": "", "type": "path", "description": "Arthur workorder id." }, { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "This endpoint retrieves a list of tags associated with the given Workorder ID." }, { "info": { "name": "Tag Workorder", "type": "http" }, "http": { "method": "PUT", "url": "https://api.arthuronline.co.uk/v2/workorders/:workorder_id/tags", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "workorder_id", "value": "", "type": "path", "description": "Arthur workorder id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a new tag record for a  workorder . The API will return the saved data and a unique tag ID.\n\nSupported Fields \n The following fields are supported for the request body\nTag field should be a valid tag ID or name.\n\nField \n Example \n Type \n Required? \n\ntag \n [\"123\"] \n Array(String) \n Yes" }, { "info": { "name": "Untag Workorder", "type": "http" }, "http": { "method": "PUT", "url": "https://api.arthuronline.co.uk/v2/workorders/:workorder_id/untag", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "workorder_id", "value": "", "type": "path", "description": "Arthur workorder id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to unassign tag record from a  workorder . The API will return the saved data. Tag field should be a valid tag ID or name.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ntag \n \"1234\" \n String \n Yes" }, { "info": { "name": "Untag All Workorder Tags", "type": "http" }, "http": { "method": "PUT", "url": "https://api.arthuronline.co.uk/v2/workorders/:workorder_id/untag_all", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "workorder_id", "value": "", "type": "path", "description": "Arthur workorder id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ] }, "docs": "Use this endpoint to unassign all tags from the  workorder ." }, { "info": { "name": "List Contractors on Workorder", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/workorders/:workorder_id/contractors", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "workorder_id", "value": "", "type": "path", "description": "Arthur workorder id." }, { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "This endpoint retrieves a list of  contractors  associated with the given workorder ID." }, { "info": { "name": "View Contractor on Workorder", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/workorders/:workorder_id/contractors/:contractor_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "workorder_id", "value": "", "type": "path", "description": "Arthur workorder id." }, { "name": "contractor_id", "value": "", "type": "path", "description": "Arthur contractor id." } ] }, "docs": "This API endpoint retrieves the details of a single workorder, identified by its unique  workorder_id .\n\nUse this endpoint to view the specific details of a workorder." }, { "info": { "name": "Delete Contractor on Workorder", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.arthuronline.co.uk/v2/workorders/:workorder_id/contractors/:contractor_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "workorder_id", "value": "", "type": "path", "description": "Arthur workorder id." }, { "name": "contractor_id", "value": "", "type": "path", "description": "Arthur contractor id." } ] }, "docs": "This endpoint deletes an existing contractor related to the workorder using the contractor  id ." }, { "info": { "name": "List Tenants on Workorder", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/workorders/:workorder_id/tenants", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "workorder_id", "value": "", "type": "path", "description": "Arthur workorder id." }, { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "This endpoint retrieves a list of  tenants  associated with the given workorder ID." }, { "info": { "name": "View Tenant on Workorder", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/workorders/:workorder_id/tenants/:tenant_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "workorder_id", "value": "", "type": "path", "description": "Arthur workorder id." }, { "name": "tenant_id", "value": "", "type": "path", "description": "Arthur tenant id." } ] }, "docs": "This API endpoint retrieves the details of a single tenant on a workorder, identified by its unique  tenant_id .\n\nUse this endpoint to view the specific details of a tenant on a workorder." }, { "info": { "name": "List Workorders", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/workorders", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "query", "description": "Filter workorder by id" }, { "name": "ref", "value": "", "type": "query", "description": "Filter workorders by workorder reference number" }, { "name": "status", "value": "", "type": "query", "description": "Filter by workorder status (overdue, pending, live, completed, cancelled, onHold)" }, { "name": "title", "value": "", "type": "query", "description": "Filter workorders by title" }, { "name": "description", "value": "", "type": "query", "description": "Filter workorders by description" }, { "name": "service_type", "value": "", "type": "query", "description": "Filter by workorder service type" }, { "name": "start_date", "value": "", "type": "query", "description": "Filters workorders by the start date. Use the format yyyy-mm-dd to input the date" }, { "name": "due_date", "value": "", "type": "query", "description": "Filters workorders by the due date. Use the format yyyy-mm-dd to input the date" }, { "name": "contractor_accepted_date", "value": "", "type": "query", "description": "Filters workorders by the contractor accepted date. Use the format yyyy-mm-dd to input the date" }, { "name": "emergency", "value": "", "type": "query", "description": "Filter status by emergency status (Boolean)" }, { "name": "budget", "value": "", "type": "query", "description": "Filter workorders by budget" }, { "name": "allocated_time_hours", "value": "", "type": "query", "description": "Filter by allocated time" }, { "name": "actual_time_hours", "value": "", "type": "query", "description": "Filter by actual time spent" }, { "name": "price_per_hour", "value": "", "type": "query", "description": "Filter by workorder price per hour" }, { "name": "created", "value": "", "type": "query", "description": "Filters workorders by the created date. Use the format yyyy-mm-dd to input the date" }, { "name": "modified", "value": "", "type": "query", "description": "Filters workorders by the modified date. Use the format yyyy-mm-dd to input the date" }, { "name": "quote_required", "value": "", "type": "query", "description": "Filter by quote required status (Boolean)" }, { "name": "contractor", "value": "", "type": "query", "description": "Filter by assigned contractor" }, { "name": "condition", "value": "", "type": "query", "description": "Filter by conditions available on the web (emergency, related (brings back related task), quoted, approvalContractor (brings back awaiting sign-off), recurring, quoteRequired)" }, { "name": "tags", "value": "", "type": "query", "description": "Filter by tags associated with the workorder, which should be provided as a comma-separated list" }, { "name": "_q", "value": "", "type": "query", "description": "Filter by a keyword" }, { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "This retrieves a list of workorders.\n\nSee available filters below to customize the list of workorders returned." }, { "info": { "name": "View Workorder", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/workorders/:workorder_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "workorder_id", "value": "", "type": "path", "description": "Arthur workorder id." } ] }, "docs": "This API endpoint retrieves the details of a single workorder, identified by its unique  workorder_id .\n\nUse this endpoint to view the specific details of a workorder." }, { "info": { "name": "Update Workorder", "type": "http" }, "http": { "method": "PUT", "url": "https://api.arthuronline.co.uk/v2/workorders/:workorder_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "workorder_id", "value": "", "type": "path", "description": "Arthur workorder id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint updates an existing workorder. Any fields that are not provided will not be changed. The API will return the updated data for the unit in the response.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ntitle \n workorder title \n String \n No \n\ndescription \n workorder description \n String \n No \n\ninvite_contractors \n [123,1234] \n Array(integer) \n No \n\nservice_type \n Carpet Layer \n String \n No \n\nstart_date \n 2020-02-20 \n Da" } ] }, { "info": { "name": "Quotes", "type": "folder" }, "items": [ { "info": { "name": "List Quotes", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/quotes", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "This endpoint retrieves a list of  quotes  ." }, { "info": { "name": "View Quote", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/quotes/:quote_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "quote_id", "value": "", "type": "path", "description": "Arthur quote id." } ] }, "docs": "View Quote related to your property manager account." } ] } ], "bundled": true }