GET api/tasks/GetTaskByTaskID?taskID={taskID}&showInactive={showInactive}

Request Information

URI Parameters

Name	Description	Type	Additional information
taskID		integer	Required
showInactive		boolean	Required

Body Parameters

None.

Response Information

Resource Description

TaskEditVM

Name	Type	Additional information
Task	TaskModel	None.
TaskAssingeeList	Collection of TaskAssigneeForList	None.
WorkflowLineList	Collection of WorkflowLineForList	None.
TaskCategoryList	Collection of TaskCategoryForList	None.
TaskTypeList	Collection of TaskTypeForList	None.
EntryEdit	EntryEditVM	None.
TaskCompleted	boolean	None.
RecurrenceRuleList	Collection of RecurrenceRule	None.
Response	IResponse	None.
AssignedToMode	TaskAssignedToMode	None.

Response Formats

application/json, text/json

Sample:

{
  "AssignedToMode": 1,
  "Task": {
    "TaskID": 1,
    "Task": "sample string 1",
    "TaskTypeID": 1,
    "TaskCategoryID": 1,
    "CommunicationID": 1,
    "EntryID": 1,
    "AssignedTo_ContactID": 1,
    "AssignedTo_UserGroupID": 1,
    "From_ContactID": 2,
    "Due": "2025-09-02T23:04:39.0929226+00:00",
    "Completed": "2025-09-02T23:04:39.0929226+00:00",
    "MediaAndDocumentGroupID": 1,
    "WorkflowLineID": 1,
    "StatusID": 1,
    "CreatedByAndDateTime": "sample string 3",
    "IsEntityTask": true,
    "IsUserGroupTask": true,
    "Recurrence": "sample string 4",
    "PrincipalID": 1,
    "AccountID": 1,
    "TaskPriorityID": 1,
    "TaskOutcomeID": 1
  },
  "TaskAssingeeList": [
    {
      "ID": 1,
      "Name": "sample string 2"
    },
    {
      "ID": 1,
      "Name": "sample string 2"
    }
  ],
  "WorkflowLineList": [
    {
      "WorkflowLineID": 1,
      "WorkflowLine": "sample string 2"
    },
    {
      "WorkflowLineID": 1,
      "WorkflowLine": "sample string 2"
    }
  ],
  "TaskCategoryList": [
    {
      "TaskCategoryID": 1,
      "TaskCategory": "sample string 2"
    },
    {
      "TaskCategoryID": 1,
      "TaskCategory": "sample string 2"
    }
  ],
  "TaskTypeList": [
    {
      "TaskTypeID": 1,
      "TaskType": "sample string 2"
    },
    {
      "TaskTypeID": 1,
      "TaskType": "sample string 2"
    }
  ],
  "EntryEdit": {
    "EntryModel": {
      "EntryID": 1,
      "EntryTypeID": 1,
      "EntryStatusID": 1,
      "AccountID": 1,
      "EntityID": 1,
      "ContactID": 1,
      "EntryContactID": 1,
      "MergeTemplateID": 1,
      "Entry": "sample string 2",
      "CompleteEntry": "sample string 3",
      "EntryDate": "2025-09-02T23:04:39.0929226+00:00",
      "AccountStatusID": 1,
      "CreateID": 1,
      "CreateSessionID": 1,
      "CreateTS": "2025-09-02T23:04:39.0929226+00:00",
      "ModifyID": 1,
      "ModifySessionID": 1,
      "ModifyTS": "2025-09-02T23:04:39.0929226+00:00",
      "InactiveID": 1,
      "InactiveSessionID": 1,
      "InactiveTS": "2025-09-02T23:04:39.0929226+00:00",
      "StatusID": 5,
      "Z_DB": 1,
      "Z_ID": 1,
      "WorkflowID": 1,
      "PrincipalID": 1
    },
    "ContactWithList": [
      {
        "ContactID": 1,
        "Name": "sample string 2",
        "IsChecked": true,
        "ContactIDEncrypted": "sample string 4",
        "RelationshipID": 5
      },
      {
        "ContactID": 1,
        "Name": "sample string 2",
        "IsChecked": true,
        "ContactIDEncrypted": "sample string 4",
        "RelationshipID": 5
      }
    ],
    "MasterNoteList": [
      {
        "MergeTemplateID": 1,
        "MergeTemplate": "sample string 2"
      },
      {
        "MergeTemplateID": 1,
        "MergeTemplate": "sample string 2"
      }
    ],
    "EntryTypeList": [
      {
        "EntryTypeID": 1,
        "EntryType": "sample string 2",
        "EntryTypeIDEncrypted": "sample string 3"
      },
      {
        "EntryTypeID": 1,
        "EntryType": "sample string 2",
        "EntryTypeIDEncrypted": "sample string 3"
      }
    ],
    "Response": null
  },
  "TaskCompleted": true,
  "RecurrenceRuleList": [
    {
      "DisplayName": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "DisplayName": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "Response": null
}

application/xml, text/xml

Sample:

<TaskEditVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels.Task">
  <Response i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels" />
  <AssignedToMode>EntityContact</AssignedToMode>
  <EntryEdit xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels.Entry">
    <Response i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels" />
    <d2p1:ContactWithList xmlns:d3p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.Contact">
      <d3p1:ContactForList>
        <d3p1:ContactID>1</d3p1:ContactID>
        <d3p1:ContactIDEncrypted>sample string 4</d3p1:ContactIDEncrypted>
        <d3p1:IsChecked>true</d3p1:IsChecked>
        <d3p1:Name>sample string 2</d3p1:Name>
        <d3p1:RelationshipID>5</d3p1:RelationshipID>
      </d3p1:ContactForList>
      <d3p1:ContactForList>
        <d3p1:ContactID>1</d3p1:ContactID>
        <d3p1:ContactIDEncrypted>sample string 4</d3p1:ContactIDEncrypted>
        <d3p1:IsChecked>true</d3p1:IsChecked>
        <d3p1:Name>sample string 2</d3p1:Name>
        <d3p1:RelationshipID>5</d3p1:RelationshipID>
      </d3p1:ContactForList>
    </d2p1:ContactWithList>
    <d2p1:EntryModel xmlns:d3p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.Entry">
      <d3p1:AccountID>1</d3p1:AccountID>
      <d3p1:AccountStatusID>1</d3p1:AccountStatusID>
      <d3p1:CompleteEntry>sample string 3</d3p1:CompleteEntry>
      <d3p1:ContactID>1</d3p1:ContactID>
      <d3p1:CreateID>1</d3p1:CreateID>
      <d3p1:CreateSessionID>1</d3p1:CreateSessionID>
      <d3p1:CreateTS>2025-09-02T23:04:39.0929226+00:00</d3p1:CreateTS>
      <d3p1:EntityID>1</d3p1:EntityID>
      <d3p1:Entry>sample string 2</d3p1:Entry>
      <d3p1:EntryContactID>1</d3p1:EntryContactID>
      <d3p1:EntryDate>2025-09-02T23:04:39.0929226+00:00</d3p1:EntryDate>
      <d3p1:EntryID>1</d3p1:EntryID>
      <d3p1:EntryStatusID>1</d3p1:EntryStatusID>
      <d3p1:EntryTypeID>1</d3p1:EntryTypeID>
      <d3p1:InactiveID>1</d3p1:InactiveID>
      <d3p1:InactiveSessionID>1</d3p1:InactiveSessionID>
      <d3p1:InactiveTS>2025-09-02T23:04:39.0929226+00:00</d3p1:InactiveTS>
      <d3p1:MergeTemplateID>1</d3p1:MergeTemplateID>
      <d3p1:ModifyID>1</d3p1:ModifyID>
      <d3p1:ModifySessionID>1</d3p1:ModifySessionID>
      <d3p1:ModifyTS>2025-09-02T23:04:39.0929226+00:00</d3p1:ModifyTS>
      <d3p1:PrincipalID>1</d3p1:PrincipalID>
      <d3p1:StatusID>5</d3p1:StatusID>
      <d3p1:WorkflowID>1</d3p1:WorkflowID>
      <d3p1:Z_DB>1</d3p1:Z_DB>
      <d3p1:Z_ID>1</d3p1:Z_ID>
    </d2p1:EntryModel>
    <d2p1:EntryTypeList xmlns:d3p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.EntryType">
      <d3p1:EntryTypeForList>
        <d3p1:EntryType>sample string 2</d3p1:EntryType>
        <d3p1:EntryTypeID>1</d3p1:EntryTypeID>
        <d3p1:EntryTypeIDEncrypted>sample string 3</d3p1:EntryTypeIDEncrypted>
      </d3p1:EntryTypeForList>
      <d3p1:EntryTypeForList>
        <d3p1:EntryType>sample string 2</d3p1:EntryType>
        <d3p1:EntryTypeID>1</d3p1:EntryTypeID>
        <d3p1:EntryTypeIDEncrypted>sample string 3</d3p1:EntryTypeIDEncrypted>
      </d3p1:EntryTypeForList>
    </d2p1:EntryTypeList>
    <d2p1:MasterNoteList xmlns:d3p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.MergeTemplate">
      <d3p1:MergeTemplateForList>
        <d3p1:MergeTemplate>sample string 2</d3p1:MergeTemplate>
        <d3p1:MergeTemplateID>1</d3p1:MergeTemplateID>
      </d3p1:MergeTemplateForList>
      <d3p1:MergeTemplateForList>
        <d3p1:MergeTemplate>sample string 2</d3p1:MergeTemplate>
        <d3p1:MergeTemplateID>1</d3p1:MergeTemplateID>
      </d3p1:MergeTemplateForList>
    </d2p1:MasterNoteList>
  </EntryEdit>
  <RecurrenceRuleList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.Task">
    <d2p1:RecurrenceRule>
      <d2p1:DisplayName>sample string 1</d2p1:DisplayName>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:RecurrenceRule>
    <d2p1:RecurrenceRule>
      <d2p1:DisplayName>sample string 1</d2p1:DisplayName>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:RecurrenceRule>
  </RecurrenceRuleList>
  <Task xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.Task">
    <d2p1:AccountID>1</d2p1:AccountID>
    <d2p1:AssignedTo_ContactID>1</d2p1:AssignedTo_ContactID>
    <d2p1:AssignedTo_UserGroupID>1</d2p1:AssignedTo_UserGroupID>
    <d2p1:CommunicationID>1</d2p1:CommunicationID>
    <d2p1:Completed>2025-09-02T23:04:39.0929226+00:00</d2p1:Completed>
    <d2p1:CreatedByAndDateTime>sample string 3</d2p1:CreatedByAndDateTime>
    <d2p1:Due>2025-09-02T23:04:39.0929226+00:00</d2p1:Due>
    <d2p1:EntryID>1</d2p1:EntryID>
    <d2p1:From_ContactID>2</d2p1:From_ContactID>
    <d2p1:IsEntityTask>true</d2p1:IsEntityTask>
    <d2p1:IsUserGroupTask>true</d2p1:IsUserGroupTask>
    <d2p1:MediaAndDocumentGroupID>1</d2p1:MediaAndDocumentGroupID>
    <d2p1:PrincipalID>1</d2p1:PrincipalID>
    <d2p1:Recurrence>sample string 4</d2p1:Recurrence>
    <d2p1:StatusID>1</d2p1:StatusID>
    <d2p1:Task>sample string 1</d2p1:Task>
    <d2p1:TaskCategoryID>1</d2p1:TaskCategoryID>
    <d2p1:TaskID>1</d2p1:TaskID>
    <d2p1:TaskOutcomeID>1</d2p1:TaskOutcomeID>
    <d2p1:TaskPriorityID>1</d2p1:TaskPriorityID>
    <d2p1:TaskTypeID>1</d2p1:TaskTypeID>
    <d2p1:WorkflowLineID>1</d2p1:WorkflowLineID>
  </Task>
  <TaskAssingeeList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.Task">
    <d2p1:TaskAssigneeForList>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:TaskAssigneeForList>
    <d2p1:TaskAssigneeForList>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:TaskAssigneeForList>
  </TaskAssingeeList>
  <TaskCategoryList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.TaskCategory">
    <d2p1:TaskCategoryForList>
      <d2p1:TaskCategory>sample string 2</d2p1:TaskCategory>
      <d2p1:TaskCategoryID>1</d2p1:TaskCategoryID>
    </d2p1:TaskCategoryForList>
    <d2p1:TaskCategoryForList>
      <d2p1:TaskCategory>sample string 2</d2p1:TaskCategory>
      <d2p1:TaskCategoryID>1</d2p1:TaskCategoryID>
    </d2p1:TaskCategoryForList>
  </TaskCategoryList>
  <TaskCompleted>true</TaskCompleted>
  <TaskTypeList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.TaskType">
    <d2p1:TaskTypeForList>
      <d2p1:TaskType>sample string 2</d2p1:TaskType>
      <d2p1:TaskTypeID>1</d2p1:TaskTypeID>
    </d2p1:TaskTypeForList>
    <d2p1:TaskTypeForList>
      <d2p1:TaskType>sample string 2</d2p1:TaskType>
      <d2p1:TaskTypeID>1</d2p1:TaskTypeID>
    </d2p1:TaskTypeForList>
  </TaskTypeList>
  <WorkflowLineList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.WorkflowLine">
    <d2p1:WorkflowLineForList>
      <d2p1:WorkflowLine>sample string 2</d2p1:WorkflowLine>
      <d2p1:WorkflowLineID>1</d2p1:WorkflowLineID>
    </d2p1:WorkflowLineForList>
    <d2p1:WorkflowLineForList>
      <d2p1:WorkflowLine>sample string 2</d2p1:WorkflowLine>
      <d2p1:WorkflowLineID>1</d2p1:WorkflowLineID>
    </d2p1:WorkflowLineForList>
  </WorkflowLineList>
</TaskEditVM>