POST 17.0/database/documents/list

Description

Retrieve a list of Documents

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

integer

None.
Description

string

String length: inclusive between 0 and 75
FileName

string

String length: inclusive between 0 and 255
TypeID

integer

None.
Letterhead

byte

None.
LetterheadID

integer

None.
LetterheadPages

byte

None.
LetterPackageID

integer

None.
MergeFields

string

None.
SaveAsCorrespondence

byte

None.
FollowUpTaskInterval

integer

None.
FollowUpTaskPriority

byte

None.
MailshotGroupID

integer

None.
ContentTypeID

byte

None.
ShowOnClientLogin

byte

None.
SigningInstructions

string

None.
InActive

byte

None.

application/json, text/json
Sample: 
[
  {
    "id": 1,
    "description": "sample string 1",
    "fileName": "sample string 2",
    "typeID": 1,
    "letterhead": 64,
    "letterheadID": 1,
    "letterheadPages": 64,
    "letterPackageID": 1,
    "mergeFields": "sample string 3",
    "saveAsCorrespondence": 64,
    "followUpTaskInterval": 1,
    "followUpTaskPriority": 64,
    "mailshotGroupID": 1,
    "contentTypeID": 64,
    "showOnClientLogin": 64,
    "signingInstructions": "sample string 4",
    "inActive": 64
  },
  {
    "id": 1,
    "description": "sample string 1",
    "fileName": "sample string 2",
    "typeID": 1,
    "letterhead": 64,
    "letterheadID": 1,
    "letterheadPages": 64,
    "letterPackageID": 1,
    "mergeFields": "sample string 3",
    "saveAsCorrespondence": 64,
    "followUpTaskInterval": 1,
    "followUpTaskPriority": 64,
    "mailshotGroupID": 1,
    "contentTypeID": 64,
    "showOnClientLogin": 64,
    "signingInstructions": "sample string 4",
    "inActive": 64
  }
]

application/xml, text/xml
Sample: 
<ArrayOfDocumentsUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <DocumentsUpdate>
    <ID>1</ID>
    <Description>sample string 1</Description>
    <FileName>sample string 2</FileName>
    <TypeID>1</TypeID>
    <Letterhead>64</Letterhead>
    <LetterheadID>1</LetterheadID>
    <LetterheadPages>64</LetterheadPages>
    <LetterPackageID>1</LetterPackageID>
    <MergeFields>sample string 3</MergeFields>
    <SaveAsCorrespondence>64</SaveAsCorrespondence>
    <FollowUpTaskInterval>1</FollowUpTaskInterval>
    <FollowUpTaskPriority>64</FollowUpTaskPriority>
    <MailshotGroupID>1</MailshotGroupID>
    <ContentTypeID>64</ContentTypeID>
    <ShowOnClientLogin>64</ShowOnClientLogin>
    <SigningInstructions>sample string 4</SigningInstructions>
    <InActive>64</InActive>
  </DocumentsUpdate>
  <DocumentsUpdate>
    <ID>1</ID>
    <Description>sample string 1</Description>
    <FileName>sample string 2</FileName>
    <TypeID>1</TypeID>
    <Letterhead>64</Letterhead>
    <LetterheadID>1</LetterheadID>
    <LetterheadPages>64</LetterheadPages>
    <LetterPackageID>1</LetterPackageID>
    <MergeFields>sample string 3</MergeFields>
    <SaveAsCorrespondence>64</SaveAsCorrespondence>
    <FollowUpTaskInterval>1</FollowUpTaskInterval>
    <FollowUpTaskPriority>64</FollowUpTaskPriority>
    <MailshotGroupID>1</MailshotGroupID>
    <ContentTypeID>64</ContentTypeID>
    <ShowOnClientLogin>64</ShowOnClientLogin>
    <SigningInstructions>sample string 4</SigningInstructions>
    <InActive>64</InActive>
  </DocumentsUpdate>
</ArrayOfDocumentsUpdate>