POST 17.0/database/contactreferences/list

Description

Retrieve a list of Contact References

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

integer

None.
ContactID

integer

None.
RefereeID

integer

None.
TenancyID

integer

None.
AddedDate

date

None.
Response

byte

None.
ResponseDate

date

None.
Name

string

String length: inclusive between 0 and 50
Company

string

String length: inclusive between 0 and 50
PropertyName

string

String length: inclusive between 0 and 30
Street

string

String length: inclusive between 0 and 30
Locality

string

String length: inclusive between 0 and 30
Town

string

String length: inclusive between 0 and 30
Postcode

string

String length: inclusive between 0 and 30
Region

string

String length: inclusive between 0 and 30
Country

string

String length: inclusive between 0 and 30
CountryCode

integer

None.
Notes

string

None.
SiteID

integer

None.
Reference

string

String length: inclusive between 0 and 50
URL

string

String length: inclusive between 0 and 255
ReviewRequired

byte

None.

application/json, text/json
Sample: 
[
  {
    "id": 1,
    "contactID": 1,
    "refereeID": 1,
    "tenancyID": 1,
    "addedDate": "2025-01-09T20:48",
    "response": 64,
    "responseDate": "2025-01-09T20:48",
    "name": "sample string 1",
    "company": "sample string 2",
    "propertyName": "sample string 3",
    "street": "sample string 4",
    "locality": "sample string 5",
    "town": "sample string 6",
    "postcode": "sample string 7",
    "region": "sample string 8",
    "country": "sample string 9",
    "countryCode": 1,
    "notes": "sample string 10",
    "siteID": 1,
    "reference": "sample string 11",
    "url": "sample string 12",
    "reviewRequired": 64
  },
  {
    "id": 1,
    "contactID": 1,
    "refereeID": 1,
    "tenancyID": 1,
    "addedDate": "2025-01-09T20:48",
    "response": 64,
    "responseDate": "2025-01-09T20:48",
    "name": "sample string 1",
    "company": "sample string 2",
    "propertyName": "sample string 3",
    "street": "sample string 4",
    "locality": "sample string 5",
    "town": "sample string 6",
    "postcode": "sample string 7",
    "region": "sample string 8",
    "country": "sample string 9",
    "countryCode": 1,
    "notes": "sample string 10",
    "siteID": 1,
    "reference": "sample string 11",
    "url": "sample string 12",
    "reviewRequired": 64
  }
]

application/xml, text/xml
Sample: 
<ArrayOfContactReferencesUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ContactReferencesUpdate>
    <ID>1</ID>
    <ContactID>1</ContactID>
    <RefereeID>1</RefereeID>
    <TenancyID>1</TenancyID>
    <AddedDate>2025-01-09T20:48:10.8925189+00:00</AddedDate>
    <Response>64</Response>
    <ResponseDate>2025-01-09T20:48:10.8925189+00:00</ResponseDate>
    <Name>sample string 1</Name>
    <Company>sample string 2</Company>
    <PropertyName>sample string 3</PropertyName>
    <Street>sample string 4</Street>
    <Locality>sample string 5</Locality>
    <Town>sample string 6</Town>
    <Postcode>sample string 7</Postcode>
    <Region>sample string 8</Region>
    <Country>sample string 9</Country>
    <CountryCode>1</CountryCode>
    <Notes>sample string 10</Notes>
    <SiteID>1</SiteID>
    <Reference>sample string 11</Reference>
    <URL>sample string 12</URL>
    <ReviewRequired>64</ReviewRequired>
  </ContactReferencesUpdate>
  <ContactReferencesUpdate>
    <ID>1</ID>
    <ContactID>1</ContactID>
    <RefereeID>1</RefereeID>
    <TenancyID>1</TenancyID>
    <AddedDate>2025-01-09T20:48:10.8925189+00:00</AddedDate>
    <Response>64</Response>
    <ResponseDate>2025-01-09T20:48:10.8925189+00:00</ResponseDate>
    <Name>sample string 1</Name>
    <Company>sample string 2</Company>
    <PropertyName>sample string 3</PropertyName>
    <Street>sample string 4</Street>
    <Locality>sample string 5</Locality>
    <Town>sample string 6</Town>
    <Postcode>sample string 7</Postcode>
    <Region>sample string 8</Region>
    <Country>sample string 9</Country>
    <CountryCode>1</CountryCode>
    <Notes>sample string 10</Notes>
    <SiteID>1</SiteID>
    <Reference>sample string 11</Reference>
    <URL>sample string 12</URL>
    <ReviewRequired>64</ReviewRequired>
  </ContactReferencesUpdate>
</ArrayOfContactReferencesUpdate>