Adding formula and function to contact search(Advanced search)
The API provides feature to execute a search based on formula, functions and other Boolean equations against a contact search, in order to use advanced search we need to integrate the formula, group and operators in a correct syntax, please refer admin/contact/download/searchmetadata for metadata available for advanced search.
Request Information
Body Parameters
Body parameters need to be integrated as json key value collection followed by valid object notations, below if the list of parameters can be sent as request body by an integrator.
Advanced Search Criteria Query
| Name | Description | Type | Additional information |
|---|---|---|---|
| PageNo | integer |
None. |
|
| PageSize | integer |
None. |
|
| TotalRecords | integer |
None. |
|
| Criteria | AdvancedSearchCriteria |
None. |
|
| ActiveRecords | integer |
None. |
|
| InActiveRecords | integer |
None. |
Request Format
Below is the typical object of the request, in order to use the API for various requirement, refer the documentation.
{
"PageNo": 1,
"PageSize": 2,
"TotalRecords": 3,
"Criteria": {
"IsSavedSearch": true,
"Criteria": "String Parameter 2"
},
"ActiveRecords": 4,
"InActiveRecords": 5
}
Response Information
Resource Description
ITypedResponse with list of Contacts (Individual+Organization) that match the specified search filter be wrapped inside.
ITypedResponseOfListOfContactBasic| Name | Description | Type | Additional information |
|---|---|---|---|
| Result | Collection of ContactBasic |
None. |
|
| Category | string |
None. |
Response Formats
Sample not available.