POST 17.0/find/contact/count

Description

Gets number of contacts that match 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.

FindCountResult
Name Description Type Additional information
Total

integer

None.

application/json, text/json
Sample: 
{
  "total": 1
}

application/xml, text/xml
Sample: 
<FindCountResult xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Total>1</Total>
</FindCountResult>