Follow

Contacts Search '/contacts/search'

The methods for Contacat Search are listed below

The purpose of these methods are to return a list of ContactIDs based on a searched Name or Character. Once the ContactIDs are obtained, they can be used as variables in the other available Contact Methods.

 

Contact Search by Name Fetch 

Method Type: GET

returns a paged list of limited Contact Information, including the ContactID

'/contacts/search?value={VALUE}&page={PAGE}'

*value = searched name


Contact Search by Letter Fetch 

Method Type: GET

returns a paged list of limited Contact Information, including the ContactID, based on a partial name or a single character.

'/contacts/search/beginswith?value={VALUE}&page={PAGE}'

*value = searched beginning letter(s)


Contact Search by Name Fetch

 The URI '/contacts/{contactid}/search?value={VALUE}&page={PAGE}', when coupled with Method Type 'GET',  returns a paged list of Contacts, associated with the search value. The searched value is based on a contact's or contacts' name.

https://api2.redtailtechnology.com/crm/v1/rest/contacts/search?value={value}&page={page}

https://api2.redtailtechnology.com/crm/v1/rest/contacts/search?value=Investor&page=1


Below is a sample request in C# using our URI, sample credentials, and the method type. The content type "text/json" work equally well.

HttpWebRequest req = (HttpWebRequest)HttpWebRequest.Create("https://api2.redtailtechnology.com/crm/v1/rest/contacts/search?value=Investor&page=1");
req.Headers[System.Net.HttpRequestHeader.Authorization] = "Basic " + Convert.ToBase64String(System.Text.Encoding.Default.GetBytes("6C135EDF-C37C-4039-AEF3-5DFC079F9E6A:Statementone:sonedemo"));
req.Method = "GET";
req.ContentType = "text/xml";

//and here's the response stream.
HttpWebResponse resp = (HttpWebResponse)req.GetResponse();
System.IO.StreamReader sr = new System.IO.StreamReader(resp.GetResponseStream());

The following is a condensed XML response. The XML response will include up to 50 Contacts per page and provide a total count of the related Contact records.

ContactsSearch.png


Contact Search by Letter Fetch

 The URI '/contacts/{contactid}/search/beginswith?value={VALUE}&page={PAGE}', when coupled with Method Type 'GET',  returns a paged list of Contacts, associated with the search value. The searched value is based on a character or a few characters supplied.

https://api2.redtailtechnology.com/crm/v1/rest/contacts/search?value={value}&page={page}

https://api2.redtailtechnology.com/crm/v1/rest/contacts/search?value=i&page=1


Below is a sample request in C# using our URI, sample credentials, and the method type. The content type "text/json" work equally well.

HttpWebRequest req = (HttpWebRequest)HttpWebRequest.Create("https://api2.redtailtechnology.com/crm/v1/rest/contacts/search/basic?value=i&page=1");
req.Headers[System.Net.HttpRequestHeader.Authorization] = "Basic " + Convert.ToBase64String(System.Text.Encoding.Default.GetBytes("6C135EDF-C37C-4039-AEF3-5DFC079F9E6A:Statementone:sonedemo"));
req.Method = "GET";
req.ContentType = "text/xml";

//and here's the response stream.
HttpWebResponse resp = (HttpWebResponse)req.GetResponse();
System.IO.StreamReader sr = new System.IO.StreamReader(resp.GetResponseStream());

The following is a condensed XML response. The XML response will include up to 50 Contacts per page and provide a total count of the related Contact records.

ContactsSearch.png


Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk