POST 17.0/database/messages/list

Description

Retrieve a list of Messages

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 MessagesUpdate
Name Description Type Additional information
ID

integer

None.
Title

string

String length: inclusive between 0 and 50
Message

string

String length: inclusive between 0 and 512
ContactID

integer

None.
PropertyID

integer

None.
UserID

integer

None.
TaskID

integer

None.
AppointmentID

integer

None.
ContactDocumentID

integer

None.
AltID

integer

None.
AddedDate

date

None.
Type

byte

None.
URL

string

String length: inclusive between 0 and 100

application/json, text/json
Sample: 
[
  {
    "id": 1,
    "title": "sample string 1",
    "message": "sample string 2",
    "contactID": 1,
    "propertyID": 1,
    "userID": 1,
    "taskID": 1,
    "appointmentID": 1,
    "contactDocumentID": 1,
    "altID": 1,
    "addedDate": "2025-01-09T20:31",
    "type": 64,
    "url": "sample string 3"
  },
  {
    "id": 1,
    "title": "sample string 1",
    "message": "sample string 2",
    "contactID": 1,
    "propertyID": 1,
    "userID": 1,
    "taskID": 1,
    "appointmentID": 1,
    "contactDocumentID": 1,
    "altID": 1,
    "addedDate": "2025-01-09T20:31",
    "type": 64,
    "url": "sample string 3"
  }
]

application/xml, text/xml
Sample: 
<ArrayOfMessagesUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <MessagesUpdate>
    <ID>1</ID>
    <Title>sample string 1</Title>
    <Message>sample string 2</Message>
    <ContactID>1</ContactID>
    <PropertyID>1</PropertyID>
    <UserID>1</UserID>
    <TaskID>1</TaskID>
    <AppointmentID>1</AppointmentID>
    <ContactDocumentID>1</ContactDocumentID>
    <AltID>1</AltID>
    <AddedDate>2025-01-09T20:31:04.5624363+00:00</AddedDate>
    <Type>64</Type>
    <URL>sample string 3</URL>
  </MessagesUpdate>
  <MessagesUpdate>
    <ID>1</ID>
    <Title>sample string 1</Title>
    <Message>sample string 2</Message>
    <ContactID>1</ContactID>
    <PropertyID>1</PropertyID>
    <UserID>1</UserID>
    <TaskID>1</TaskID>
    <AppointmentID>1</AppointmentID>
    <ContactDocumentID>1</ContactDocumentID>
    <AltID>1</AltID>
    <AddedDate>2025-01-09T20:31:04.5624363+00:00</AddedDate>
    <Type>64</Type>
    <URL>sample string 3</URL>
  </MessagesUpdate>
</ArrayOfMessagesUpdate>