POST 17.0/database/contactdocuments/list

Description

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

integer

None.
ContactID

integer

None.
DocumentID

integer

None.
Description

string

String length: inclusive between 0 and 255
FileName

string

String length: inclusive between 0 and 255
UserID

integer

None.
PropertyID

integer

None.
WorkOrderID

integer

None.
PropertyOfferID

integer

None.
CertificateID

integer

None.
TenancyID

integer

None.
ContactTaskID

integer

None.
AlwaysShowAtTop

byte

None.
WebUpload

byte

None.
ReviewRequired

byte

None.
ShowOnClientLogin

byte

None.
Signed

byte

None.
AddedDate

date

None.

application/json, text/json
Sample: 
[
  {
    "id": 1,
    "contactID": 1,
    "documentID": 1,
    "description": "sample string 1",
    "fileName": "sample string 2",
    "userID": 1,
    "propertyID": 1,
    "workOrderID": 1,
    "propertyOfferID": 1,
    "certificateID": 1,
    "tenancyID": 1,
    "contactTaskID": 1,
    "alwaysShowAtTop": 64,
    "webUpload": 64,
    "reviewRequired": 64,
    "showOnClientLogin": 64,
    "signed": 64,
    "addedDate": "2025-01-09T20:37"
  },
  {
    "id": 1,
    "contactID": 1,
    "documentID": 1,
    "description": "sample string 1",
    "fileName": "sample string 2",
    "userID": 1,
    "propertyID": 1,
    "workOrderID": 1,
    "propertyOfferID": 1,
    "certificateID": 1,
    "tenancyID": 1,
    "contactTaskID": 1,
    "alwaysShowAtTop": 64,
    "webUpload": 64,
    "reviewRequired": 64,
    "showOnClientLogin": 64,
    "signed": 64,
    "addedDate": "2025-01-09T20:37"
  }
]

application/xml, text/xml
Sample: 
<ArrayOfContactDocumentsUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ContactDocumentsUpdate>
    <ID>1</ID>
    <ContactID>1</ContactID>
    <DocumentID>1</DocumentID>
    <Description>sample string 1</Description>
    <FileName>sample string 2</FileName>
    <UserID>1</UserID>
    <PropertyID>1</PropertyID>
    <WorkOrderID>1</WorkOrderID>
    <PropertyOfferID>1</PropertyOfferID>
    <CertificateID>1</CertificateID>
    <TenancyID>1</TenancyID>
    <ContactTaskID>1</ContactTaskID>
    <AlwaysShowAtTop>64</AlwaysShowAtTop>
    <WebUpload>64</WebUpload>
    <ReviewRequired>64</ReviewRequired>
    <ShowOnClientLogin>64</ShowOnClientLogin>
    <Signed>64</Signed>
    <AddedDate>2025-01-09T20:37:44.5931098+00:00</AddedDate>
  </ContactDocumentsUpdate>
  <ContactDocumentsUpdate>
    <ID>1</ID>
    <ContactID>1</ContactID>
    <DocumentID>1</DocumentID>
    <Description>sample string 1</Description>
    <FileName>sample string 2</FileName>
    <UserID>1</UserID>
    <PropertyID>1</PropertyID>
    <WorkOrderID>1</WorkOrderID>
    <PropertyOfferID>1</PropertyOfferID>
    <CertificateID>1</CertificateID>
    <TenancyID>1</TenancyID>
    <ContactTaskID>1</ContactTaskID>
    <AlwaysShowAtTop>64</AlwaysShowAtTop>
    <WebUpload>64</WebUpload>
    <ReviewRequired>64</ReviewRequired>
    <ShowOnClientLogin>64</ShowOnClientLogin>
    <Signed>64</Signed>
    <AddedDate>2025-01-09T20:37:44.5931098+00:00</AddedDate>
  </ContactDocumentsUpdate>
</ArrayOfContactDocumentsUpdate>