Read

5min

To read Conacts, please use the below parameters.
Field Name
Data Type
Description
customParameters
Map<String, ParamValue>
It is used to add filters to your search results
pageIndex
Integer
request any page from the search results reponse
searchId
String
request any page with the Search Id from the search results reponse
customPageSize
String
no. of records to return per search request.
Custom Parameters in the requestJSON are in the form of Param Name and Value Map which are used for filtering different search results. There is currently only one supported custom parameter.
Supported Custom Parameters
Field Name
Data Type
Description
where
keyValueMap
Pass the supported where filters in the Key-Value pair
Param Value can be passed in the following two ways.
ParamValue
Field Name
Data Type
Description
value
String
single param value
keyValueMap
Map<String, String>
adding multiple key value params (where filters)
Supported “where” Filters
Field Name
Data Type
Description
dateCreated
Long
This will filter on an exact match (equal). Use the “additionalFilter” option for a range of dates.
internalId
String
Internal ID of the Contact. Multiple values can be passed in a comma-separated string.
lastModifiedDate
Long
This will filter on an exact match (equal). Use the “additionalFilter” option for a range of dates.
stage
String
stage can be ‘_customer’, ‘_prospect’ or ‘_lead’. Multiple values can be passed in a comma-separated string Ex: _customer,_prospect
subsidiary
String
Internal ID of Subsidiary (Primary). Do Not Use this in additonalFilter. Multiple IDs can be passed in a comma-separated string Ex: 1,2
additonalFilter
String
construct the additional filter with a combination of above fields using ‘+and+’ separator and pass it as a single string. Make sure to wrap the whole string using EncodingUtil.urlEncode
Example
Request
Response
{
  action=readContact,
  timestamp=1657003583435,
  validRequest=true,
  version=1.0,
  responseJSON={
    "currentPageRecords": 1,
    "totalRecords": 1,
    "totalPages": 1,
    "searchId": "WEBSERVICES_5333445_SB1_07042022853794477184289863_609d54ebc",
    "pageIndex": 1,
    "errors": [
      
    ],
    "customParamters": {
      "where": {
        "value": null,
        "keyValueMap": {
          "subsidiary": "1,2"
        }
      }
    },
    "status": "200"
    "contacts": [
      {
        "title": null,
        "subsidiary": {
          "type": null,
          "name": "Australia",
          "internalId": "1",
          "externalId": null
        },
        "salutation": null,
        "salesforceID": null,
        "phone": null,
        "officePhone": null,
        "nullFieldList": null,
        "mobilePhone": null,
        "middleName": null,
        "lastName": null,
        "lastModifiedDate": 1628271541,
        "isPrivate": false,
        "isInactive": false,
        "internalId": "17769",
        "homePhone": null,
        "firstName": null,
        "fax": null,
        "externalId": null,
        "entityId": "tessttt",
        "email": null,
        "defaultAddress": null,
        "dateCreated": 1590052407,
        "customForm": null,
        "customFieldList": {
          "customField": [
            {
              "valueLookup": null,
              "value": "false",
              "scriptId": "custentity19",
              "internalId": "479",
              "fieldType": null
            },
            {
              "valueLookup": null,
              "value": "false",
              "scriptId": "custentity_checkbox",
              "internalId": "432",
              "fieldType": null
            }
          ]
        },
        "company": {
          "type": null,
          "name": "1:5 Havells : George Kim : Rakesh Reddy : Xilani Shops : Rakesh Reddy : Rakesh Babu N : test on 21'5",
          "internalId": "17768",
          "externalId": null
        },
        "comments": null,
        "assistant": null,
        "altEmail": null,
        "addressbookList": null
      },
      {
        "title": null,
        "subsidiary": {
          "type": null,
          "name": "Australia",
          "internalId": "9",
          "externalId": null
        },
        "salutation": null,
        "salesforceID": null,
        "phone": null,
        "officePhone": null,
        "mobilePhone": null,
        "middleName": null,
        "lastName": null,
        "lastModifiedDate": 1594366008,
        "isPrivate": false,
        "isInactive": false,
        "internalId": "19287",
        "homePhone": null,
        "firstName": null,
        "fax": null,
        "externalId": null,
        "entityId": "testttt",
        "email": null,
        "defaultAddress": null,
        "dateCreated": 1594366008,
        "customForm": null,
        "customFieldList": {
          "customField": [
            {
              "valueLookup": null,
              "value": "false",
              "scriptId": "custentity19",
              "internalId": "479",
              "fieldType": null
            },
            {
              "valueLookup": null,
              "value": "false",
              "scriptId": "custentity_checkbox",
              "internalId": "432",
              "fieldType": null
            }
          ]
        },
        "company": {
          "type": null,
          "name": "CUST453AT test on 7'10 aus",
          "internalId": "19286",
          "externalId": null
        },
        "addressbookList": null
      }
    ]
  }
}

{
  action=readContact,
  timestamp=1657003583435,
  validRequest=true,
  version=1.0,
  responseJSON={
    "currentPageRecords": 1,
    "totalRecords": 1,
    "totalPages": 1,
    "searchId": "WEBSERVICES_5333445_SB1_07042022853794477184289863_609d54ebc",
    "pageIndex": 1,
    "errors": [
      
    ],
    "customParamters": {
      "where": {
        "value": null,
        "keyValueMap": {
          "subsidiary": "1,2"
        }
      }
    },
    "status": "200"
    "contacts": [
      {
        "title": null,
        "subsidiary": {
          "type": null,
          "name": "Australia",
          "internalId": "1",
          "externalId": null
        },
        "salutation": null,
        "salesforceID": null,
        "phone": null,
        "officePhone": null,
        "nullFieldList": null,
        "mobilePhone": null,
        "middleName": null,
        "lastName": null,
        "lastModifiedDate": 1628271541,
        "isPrivate": false,
        "isInactive": false,
        "internalId": "17769",
        "homePhone": null,
        "firstName": null,
        "fax": null,
        "externalId": null,
        "entityId": "tessttt",
        "email": null,
        "defaultAddress": null,
        "dateCreated": 1590052407,
        "customForm": null,
        "customFieldList": {
          "customField": [
            {
              "valueLookup": null,
              "value": "false",
              "scriptId": "custentity19",
              "internalId": "479",
              "fieldType": null
            },
            {
              "valueLookup": null,
              "value": "false",
              "scriptId": "custentity_checkbox",
              "internalId": "432",
              "fieldType": null
            }
          ]
        },
        "company": {
          "type": null,
          "name": "1:5 Havells : George Kim : Rakesh Reddy : Xilani Shops : Rakesh Reddy : Rakesh Babu N : test on 21'5",
          "internalId": "17768",
          "externalId": null
        },
        "comments": null,
        "assistant": null,
        "altEmail": null,
        "addressbookList": null
      },
      {
        "title": null,
        "subsidiary": {
          "type": null,
          "name": "Australia",
          "internalId": "9",
          "externalId": null
        },
        "salutation": null,
        "salesforceID": null,
        "phone": null,
        "officePhone": null,
        "mobilePhone": null,
        "middleName": null,
        "lastName": null,
        "lastModifiedDate": 1594366008,
        "isPrivate": false,
        "isInactive": false,
        "internalId": "19287",
        "homePhone": null,
        "firstName": null,
        "fax": null,
        "externalId": null,
        "entityId": "testttt",
        "email": null,
        "defaultAddress": null,
        "dateCreated": 1594366008,
        "customForm": null,
        "customFieldList": {
          "customField": [
            {
              "valueLookup": null,
              "value": "false",
              "scriptId": "custentity19",
              "internalId": "479",
              "fieldType": null
            },
            {
              "valueLookup": null,
              "value": "false",
              "scriptId": "custentity_checkbox",
              "internalId": "432",
              "fieldType": null
            }
          ]
        },
        "company": {
          "type": null,
          "name": "CUST453AT test on 7'10 aus",
          "internalId": "19286",
          "externalId": null
        },
        "addressbookList": null
      }
    ]
  }
}
﻿
﻿

Field Name	Data Type	Description
customParameters	Map<String, ParamValue>	It is used to add filters to your search results
pageIndex	Integer	request any page from the search results reponse
searchId	String	request any page with the Search Id from the search results reponse
customPageSize	String	no. of records to return per search request.

Field Name	Data Type	Description
where	keyValueMap	Pass the supported where filters in the Key-Value pair

Field Name	Data Type	Description
value	String	single param value
keyValueMap	Map<String, String>	adding multiple key value params (where filters)

Field Name	Data Type	Description
dateCreated	Long	This will filter on an exact match (equal). Use the “additionalFilter” option for a range of dates.
internalId	String	Internal ID of the Contact. Multiple values can be passed in a comma-separated string.
lastModifiedDate	Long	This will filter on an exact match (equal). Use the “additionalFilter” option for a range of dates.
stage	String	stage can be ‘_customer’, ‘_prospect’ or ‘_lead’. Multiple values can be passed in a comma-separated string Ex: _customer,_prospect
subsidiary	String	Internal ID of Subsidiary (Primary). Do Not Use this in additonalFilter. Multiple IDs can be passed in a comma-separated string Ex: 1,2
additonalFilter	String	construct the additional filter with a combination of above fields using ‘+and+’ separator and pass it as a single string. Make sure to wrap the whole string using EncodingUtil.urlEncode

Updated 26 Jul 2023

Did this page help you?

Contact

Create