POST 17.0/database/contactsmstexts/list

Description

Retrieve a list of Contact SMS Texts

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

integer

None.
ContactID

integer

None.
SMSTextID

integer

None.
Body

string

None.
UserID

integer

None.
PropertyID

integer

None.
WorkOrderID

integer

None.
PropertyOfferID

integer

None.
CertificateID

integer

None.
TenancyID

integer

None.
ContactTaskID

integer

None.
AlwaysShowAtTop

byte

None.
Type

byte

None.
AddedDate

date

None.
Status

byte

None.
StatusDate

date

None.

application/json, text/json
Sample: 
[
  {
    "id": 1,
    "contactID": 1,
    "smsTextID": 1,
    "body": "sample string 1",
    "userID": 1,
    "propertyID": 1,
    "workOrderID": 1,
    "propertyOfferID": 1,
    "certificateID": 1,
    "tenancyID": 1,
    "contactTaskID": 1,
    "alwaysShowAtTop": 64,
    "type": 64,
    "addedDate": "2025-01-09T20:15",
    "status": 64,
    "statusDate": "2025-01-09T20:15"
  },
  {
    "id": 1,
    "contactID": 1,
    "smsTextID": 1,
    "body": "sample string 1",
    "userID": 1,
    "propertyID": 1,
    "workOrderID": 1,
    "propertyOfferID": 1,
    "certificateID": 1,
    "tenancyID": 1,
    "contactTaskID": 1,
    "alwaysShowAtTop": 64,
    "type": 64,
    "addedDate": "2025-01-09T20:15",
    "status": 64,
    "statusDate": "2025-01-09T20:15"
  }
]

application/xml, text/xml
Sample: 
<ArrayOfContactSMSTextsUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ContactSMSTextsUpdate>
    <ID>1</ID>
    <ContactID>1</ContactID>
    <SMSTextID>1</SMSTextID>
    <Body>sample string 1</Body>
    <UserID>1</UserID>
    <PropertyID>1</PropertyID>
    <WorkOrderID>1</WorkOrderID>
    <PropertyOfferID>1</PropertyOfferID>
    <CertificateID>1</CertificateID>
    <TenancyID>1</TenancyID>
    <ContactTaskID>1</ContactTaskID>
    <AlwaysShowAtTop>64</AlwaysShowAtTop>
    <Type>64</Type>
    <AddedDate>2025-01-09T20:15:12.2190636+00:00</AddedDate>
    <Status>64</Status>
    <StatusDate>2025-01-09T20:15:12.2190636+00:00</StatusDate>
  </ContactSMSTextsUpdate>
  <ContactSMSTextsUpdate>
    <ID>1</ID>
    <ContactID>1</ContactID>
    <SMSTextID>1</SMSTextID>
    <Body>sample string 1</Body>
    <UserID>1</UserID>
    <PropertyID>1</PropertyID>
    <WorkOrderID>1</WorkOrderID>
    <PropertyOfferID>1</PropertyOfferID>
    <CertificateID>1</CertificateID>
    <TenancyID>1</TenancyID>
    <ContactTaskID>1</ContactTaskID>
    <AlwaysShowAtTop>64</AlwaysShowAtTop>
    <Type>64</Type>
    <AddedDate>2025-01-09T20:15:12.2190636+00:00</AddedDate>
    <Status>64</Status>
    <StatusDate>2025-01-09T20:15:12.2190636+00:00</StatusDate>
  </ContactSMSTextsUpdate>
</ArrayOfContactSMSTextsUpdate>