POST 17.0/find/contact

Description

Finds contact records based on the passed query

URI Parameters

None.

ContactFindQuery
Name Description Type Additional information
Filters

ContactFindFilters

None.
CurrentContactId

integer

None.
FindTypeRestriction

byte

None.
TextToFind

string

Required
MaxResults

integer

None.

application/json, text/json
Sample: 
{
  "filters": {
    "branchID": 1,
    "typeID": 2,
    "statusID": 3,
    "userID": 4
  },
  "currentContactId": 1,
  "findTypeRestriction": 64,
  "textToFind": "sample string 2",
  "maxResults": 3
}

application/xml, text/xml
Sample: 
<ContactFindQuery xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <TextToFind>sample string 2</TextToFind>
  <MaxResults>3</MaxResults>
  <Filters>
    <BranchID>1</BranchID>
    <TypeID>2</TypeID>
    <StatusID>3</StatusID>
    <UserID>4</UserID>
  </Filters>
  <CurrentContactId>1</CurrentContactId>
  <FindTypeRestriction>64</FindTypeRestriction>
</ContactFindQuery>

application/x-www-form-urlencoded
Sample:

Sample not available.

A list of contacts that match the passed query

Collection of ContactFindResult
Name Description Type Additional information
ID

integer

None.
Name

string

None.
Address

string

None.
TelephoneNumber

string

None.
MobileNumber

string

None.
EmailAddress

string

None.
Type

IDDescriptionPair

None.
Status

IDDescriptionPair

None.
AltReference

string

None.
IsRestricted

boolean

None.
MarketingPreferences

BasicMarketingPreferences

None.

application/json, text/json
Sample: 
[
  {
    "id": 1,
    "name": "sample string 2",
    "address": "sample string 3",
    "telephoneNumber": "sample string 4",
    "mobileNumber": "sample string 5",
    "emailAddress": "sample string 6",
    "type": {
      "id": 1,
      "description": "sample string 2"
    },
    "status": {
      "id": 1,
      "description": "sample string 2"
    },
    "altReference": "sample string 7",
    "isRestricted": true,
    "marketingPreferences": {
      "email": true,
      "telephone": true,
      "smsText": true,
      "confirmed": true
    }
  },
  {
    "id": 1,
    "name": "sample string 2",
    "address": "sample string 3",
    "telephoneNumber": "sample string 4",
    "mobileNumber": "sample string 5",
    "emailAddress": "sample string 6",
    "type": {
      "id": 1,
      "description": "sample string 2"
    },
    "status": {
      "id": 1,
      "description": "sample string 2"
    },
    "altReference": "sample string 7",
    "isRestricted": true,
    "marketingPreferences": {
      "email": true,
      "telephone": true,
      "smsText": true,
      "confirmed": true
    }
  }
]

application/xml, text/xml
Sample: 
<ArrayOfContactFindResult xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ContactFindResult>
    <ID>1</ID>
    <Name>sample string 2</Name>
    <Address>sample string 3</Address>
    <TelephoneNumber>sample string 4</TelephoneNumber>
    <MobileNumber>sample string 5</MobileNumber>
    <EmailAddress>sample string 6</EmailAddress>
    <Type>
      <ID>1</ID>
      <Description>sample string 2</Description>
    </Type>
    <Status>
      <ID>1</ID>
      <Description>sample string 2</Description>
    </Status>
    <AltReference>sample string 7</AltReference>
    <IsRestricted>true</IsRestricted>
    <MarketingPreferences>
      <Email>true</Email>
      <Telephone>true</Telephone>
      <SmsText>true</SmsText>
      <Confirmed>true</Confirmed>
    </MarketingPreferences>
  </ContactFindResult>
  <ContactFindResult>
    <ID>1</ID>
    <Name>sample string 2</Name>
    <Address>sample string 3</Address>
    <TelephoneNumber>sample string 4</TelephoneNumber>
    <MobileNumber>sample string 5</MobileNumber>
    <EmailAddress>sample string 6</EmailAddress>
    <Type>
      <ID>1</ID>
      <Description>sample string 2</Description>
    </Type>
    <Status>
      <ID>1</ID>
      <Description>sample string 2</Description>
    </Status>
    <AltReference>sample string 7</AltReference>
    <IsRestricted>true</IsRestricted>
    <MarketingPreferences>
      <Email>true</Email>
      <Telephone>true</Telephone>
      <SmsText>true</SmsText>
      <Confirmed>true</Confirmed>
    </MarketingPreferences>
  </ContactFindResult>
</ArrayOfContactFindResult>