POST 17.0/database/smstexts/list

Description

Retrieve a list of 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 SMSTextsUpdate
Name Description Type Additional information
ID

integer

None.
Description

string

String length: inclusive between 0 and 75
Body

string

None.
SaveAsCorrespondence

byte

None.
FollowUpTaskInterval

integer

None.
FollowUpTaskPriority

byte

None.
MailshotGroupID

integer

None.
ContentTypeID

byte

None.
ShowOnClientLogin

byte

None.
InActive

byte

None.

application/json, text/json
Sample: 
[
  {
    "id": 1,
    "description": "sample string 1",
    "body": "sample string 2",
    "saveAsCorrespondence": 64,
    "followUpTaskInterval": 1,
    "followUpTaskPriority": 64,
    "mailshotGroupID": 1,
    "contentTypeID": 64,
    "showOnClientLogin": 64,
    "inActive": 64
  },
  {
    "id": 1,
    "description": "sample string 1",
    "body": "sample string 2",
    "saveAsCorrespondence": 64,
    "followUpTaskInterval": 1,
    "followUpTaskPriority": 64,
    "mailshotGroupID": 1,
    "contentTypeID": 64,
    "showOnClientLogin": 64,
    "inActive": 64
  }
]

application/xml, text/xml
Sample: 
<ArrayOfSMSTextsUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <SMSTextsUpdate>
    <ID>1</ID>
    <Description>sample string 1</Description>
    <Body>sample string 2</Body>
    <SaveAsCorrespondence>64</SaveAsCorrespondence>
    <FollowUpTaskInterval>1</FollowUpTaskInterval>
    <FollowUpTaskPriority>64</FollowUpTaskPriority>
    <MailshotGroupID>1</MailshotGroupID>
    <ContentTypeID>64</ContentTypeID>
    <ShowOnClientLogin>64</ShowOnClientLogin>
    <InActive>64</InActive>
  </SMSTextsUpdate>
  <SMSTextsUpdate>
    <ID>1</ID>
    <Description>sample string 1</Description>
    <Body>sample string 2</Body>
    <SaveAsCorrespondence>64</SaveAsCorrespondence>
    <FollowUpTaskInterval>1</FollowUpTaskInterval>
    <FollowUpTaskPriority>64</FollowUpTaskPriority>
    <MailshotGroupID>1</MailshotGroupID>
    <ContentTypeID>64</ContentTypeID>
    <ShowOnClientLogin>64</ShowOnClientLogin>
    <InActive>64</InActive>
  </SMSTextsUpdate>
</ArrayOfSMSTextsUpdate>