POST 17.0/database/contacttasks/list

Description

Retrieve a list of Contact Tasks

URI Parameters

None.

ListOptions
Name Description Type Additional information
Fields

Collection of string

None.
Filters

Collection of DatabaseFilter

None.
Order

string

None.

application/json, text/json
Sample: 
{
  "fields": [
    "sample string 1",
    "sample string 2"
  ],
  "filters": [
    {
      "fieldName": "sample string 1",
      "value": "sample string 2",
      "operator": "sample string 3",
      "valueType": "sample string 4"
    },
    {
      "fieldName": "sample string 1",
      "value": "sample string 2",
      "operator": "sample string 3",
      "valueType": "sample string 4"
    }
  ],
  "order": "sample string 1"
}

application/xml, text/xml
Sample: 
<ListOptions xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Fields>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </Fields>
  <Filters>
    <DatabaseFilter>
      <FieldName>sample string 1</FieldName>
      <Value>sample string 2</Value>
      <Operator>sample string 3</Operator>
      <ValueType>sample string 4</ValueType>
    </DatabaseFilter>
    <DatabaseFilter>
      <FieldName>sample string 1</FieldName>
      <Value>sample string 2</Value>
      <Operator>sample string 3</Operator>
      <ValueType>sample string 4</ValueType>
    </DatabaseFilter>
  </Filters>
  <Order>sample string 1</Order>
</ListOptions>

application/x-www-form-urlencoded
Sample:

Sample not available.

Collection of ContactTasksUpdate
Name Description Type Additional information
ID

integer

None.
Type

byte

None.
Status

byte

None.
ContactID

integer

None.
PropertyID

integer

None.
WorkOrderID

integer

None.
PropertyOfferID

integer

None.
CertificateID

integer

None.
ContactTaskID

integer

None.
Subject

string

String length: inclusive between 0 and 255
Body

string

None.
AddedDate

date

None.
StartDate

date

None.
DueDate

date

None.
UpdatedDate

date

None.
CompletedDate

date

None.
UserID

integer

None.
AssignedUserID

integer

None.
AppointmentID

integer

None.
Priority

byte

None.
SiteID

integer

None.
TaskTypeID

integer

None.
AssignedUserAcknowledged

byte

None.
AlwaysShowAtTop

byte

None.
DesktopAlert

byte

None.
DesktopAlertShowOnProperties

byte

None.

application/json, text/json
Sample: 
[
  {
    "id": 1,
    "type": 64,
    "status": 64,
    "contactID": 1,
    "propertyID": 1,
    "workOrderID": 1,
    "propertyOfferID": 1,
    "certificateID": 1,
    "contactTaskID": 1,
    "subject": "sample string 1",
    "body": "sample string 2",
    "addedDate": "2025-01-09T20:52",
    "startDate": "2025-01-09T20:52",
    "dueDate": "2025-01-09T20:52",
    "updatedDate": "2025-01-09T20:52",
    "completedDate": "2025-01-09T20:52",
    "userID": 1,
    "assignedUserID": 1,
    "appointmentID": 1,
    "priority": 64,
    "siteID": 1,
    "taskTypeID": 1,
    "assignedUserAcknowledged": 64,
    "alwaysShowAtTop": 64,
    "desktopAlert": 64,
    "desktopAlertShowOnProperties": 64
  },
  {
    "id": 1,
    "type": 64,
    "status": 64,
    "contactID": 1,
    "propertyID": 1,
    "workOrderID": 1,
    "propertyOfferID": 1,
    "certificateID": 1,
    "contactTaskID": 1,
    "subject": "sample string 1",
    "body": "sample string 2",
    "addedDate": "2025-01-09T20:52",
    "startDate": "2025-01-09T20:52",
    "dueDate": "2025-01-09T20:52",
    "updatedDate": "2025-01-09T20:52",
    "completedDate": "2025-01-09T20:52",
    "userID": 1,
    "assignedUserID": 1,
    "appointmentID": 1,
    "priority": 64,
    "siteID": 1,
    "taskTypeID": 1,
    "assignedUserAcknowledged": 64,
    "alwaysShowAtTop": 64,
    "desktopAlert": 64,
    "desktopAlertShowOnProperties": 64
  }
]

application/xml, text/xml
Sample: 
<ArrayOfContactTasksUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ContactTasksUpdate>
    <ID>1</ID>
    <Type>64</Type>
    <Status>64</Status>
    <ContactID>1</ContactID>
    <PropertyID>1</PropertyID>
    <WorkOrderID>1</WorkOrderID>
    <PropertyOfferID>1</PropertyOfferID>
    <CertificateID>1</CertificateID>
    <ContactTaskID>1</ContactTaskID>
    <Subject>sample string 1</Subject>
    <Body>sample string 2</Body>
    <AddedDate>2025-01-09T20:52:56.0471616+00:00</AddedDate>
    <StartDate>2025-01-09T20:52:56.0471616+00:00</StartDate>
    <DueDate>2025-01-09T20:52:56.0471616+00:00</DueDate>
    <UpdatedDate>2025-01-09T20:52:56.0471616+00:00</UpdatedDate>
    <CompletedDate>2025-01-09T20:52:56.0471616+00:00</CompletedDate>
    <UserID>1</UserID>
    <AssignedUserID>1</AssignedUserID>
    <AppointmentID>1</AppointmentID>
    <Priority>64</Priority>
    <SiteID>1</SiteID>
    <TaskTypeID>1</TaskTypeID>
    <AssignedUserAcknowledged>64</AssignedUserAcknowledged>
    <AlwaysShowAtTop>64</AlwaysShowAtTop>
    <DesktopAlert>64</DesktopAlert>
    <DesktopAlertShowOnProperties>64</DesktopAlertShowOnProperties>
  </ContactTasksUpdate>
  <ContactTasksUpdate>
    <ID>1</ID>
    <Type>64</Type>
    <Status>64</Status>
    <ContactID>1</ContactID>
    <PropertyID>1</PropertyID>
    <WorkOrderID>1</WorkOrderID>
    <PropertyOfferID>1</PropertyOfferID>
    <CertificateID>1</CertificateID>
    <ContactTaskID>1</ContactTaskID>
    <Subject>sample string 1</Subject>
    <Body>sample string 2</Body>
    <AddedDate>2025-01-09T20:52:56.0471616+00:00</AddedDate>
    <StartDate>2025-01-09T20:52:56.0471616+00:00</StartDate>
    <DueDate>2025-01-09T20:52:56.0471616+00:00</DueDate>
    <UpdatedDate>2025-01-09T20:52:56.0471616+00:00</UpdatedDate>
    <CompletedDate>2025-01-09T20:52:56.0471616+00:00</CompletedDate>
    <UserID>1</UserID>
    <AssignedUserID>1</AssignedUserID>
    <AppointmentID>1</AppointmentID>
    <Priority>64</Priority>
    <SiteID>1</SiteID>
    <TaskTypeID>1</TaskTypeID>
    <AssignedUserAcknowledged>64</AssignedUserAcknowledged>
    <AlwaysShowAtTop>64</AlwaysShowAtTop>
    <DesktopAlert>64</DesktopAlert>
    <DesktopAlertShowOnProperties>64</DesktopAlertShowOnProperties>
  </ContactTasksUpdate>
</ArrayOfContactTasksUpdate>