The Settings methods are associated with the retrieval of user settings. The intent of this article to provide you with the information you need to retrieve such settings.
The purpose of each of the methods are outlined more specifically below.
Method Type: GET
returns a list of activity types with the corresponding Activity Code
'/settings/activitytypes'
Method Type: GET
returns a list of contact statuses with the corresponding Contact Status Code.
'/settings/csl'
optional Parameter: {deleted}*
{0} shows current records, {1} shows deleted records
Method Type: GET
returns a list of Contact Categories with the corresponding Contact Category Code
'/settings/mccl'
optional Parameter: {deleted}*
{0} shows current records, {1} shows deleted records
Method Type: GET
returns a Master Category List with the corresponding MCL Code.
'/settings/mcl'
Method Type: GET
returns a list of Contact Sources with the corresponding Contact Source Code
'/settings/mcsl'
optional Parameter: {deleted}*
{0} shows current records, {1} shows deleted records
Method Type: GET
returns a list of Salutations with the corresponding Salutation Code
'/settings/salutations'
Method Type: GET
returns a list of Servicing Advisors with the corresponding Servicing Advisor Code.
'/settings/sal'
optional Parameter: {deleted}*
{0} shows current records, {1} shows deleted records
Method Type: GET
returns a list of Writing Advisors with the corresponding Writing Advisor Code.
'/settings/wal'
optional Parameter: {deleted}*
{0} shows current records, {1} shows deleted records
Method Type: GET
returns a list of User-defined fields with the corresponding UDF Code.
'/settings/udf'
Method Type: GET
returns a list of Tag Groups for a user's Database.
'/settings/taggroups'
Activity Type List Fetch
The URI '/settings/activitytypes', when coupled with Method Type 'GET', returns the list of Activity Types with their corresponding Activity Code Value
https://api2.redtailtechnology.com/crm/v1/rest/settings/activitytypes
Using the optional Query String parameter of deleted=1 would return deleted ActivityTypes.
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/settings/activitytypes"); //?deleted=1 to return all deleted statuses
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());
Contact Status List Fetch
The URI '/settings/csl', when coupled with Method Type 'GET', returns the list of Contact Statuses with their corresponding Status Code Value
https://api2.redtailtechnology.com/crm/v1/rest/settings/csl
Using the optional Query String parameter of deleted=1 would return in a list of deleted Statuses.
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/settings/csl"); //?deleted=1 to return all deleted statuses
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());
Contact Category List Fetch
The URI '/settings/mccl', when coupled with Method Type 'GET', returns the list of Contact Categories with their corresponding Contact Category Code Value
https://api2.redtailtechnology.com/crm/v1/rest/settings/mccl
Using the optional Query String parameter of deleted=1 would return in a list of deleted Categories.
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/settings/mccl"); //?deleted=1 to return all deleted Categories
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());
Master Category List Fetch
The URI '/settings/mcl', when coupled with Method Type 'GET', returns the list of Master Categories accompanied with their corresponding Master Category Code Value
https://api2.redtailtechnology.com/crm/v1/rest/settings/mcl
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/settings/mcl");
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());
Contact Source List Fetch
The URI '/settings/mcl', when coupled with Method Type 'GET', returns the list of Contact Sources accompanied with their corresponding Contact Source Code Value
https://api2.redtailtechnology.com/crm/v1/rest/settings/mcsl
Using the optional Query String parameter of deleted=1 would return in a list of deleted Sources.
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/settings/mcsl"); //?deleted=1 to return all deleted sources
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());
Salutation List Fetch
The URI '/settings/salutations', when coupled with Method Type 'GET', returns the list of Contact Salutations with their corresponding Status Code Value
https://api2.redtailtechnology.com/crm/v1/rest/settings/salutations
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/settings/salutations");
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());
Servicing Advisor List Fetch
The URI '/settings/sal', when coupled with Method Type 'GET', returns the list of Servicing Advisors accompanied with their corresponding SAL Value
https://api2.redtailtechnology.com/crm/v1/rest/settings/sal
Using the optional Query String parameter of deleted=1 would return in a list of deleted Advisors.
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/settings/sal"); //?deleted=1 to return all deleted advisors
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());
Writing Advisor List Fetch
The URI '/settings/wal', when coupled with Method Type 'GET', returns the list of Writing Advisors accompanied with their corresponding WAL Value
https://api2.redtailtechnology.com/crm/v1/rest/settings/wal
Using the optional Query String parameter of deleted=1 would return in a list of deleted Advisors.
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/settings/wal"); //?deleted=1 to return all deleted advisors
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());
User-Defined Fields Fetch
The URI '/settings/udf', when coupled with Method Type 'GET', returns a list of User-Defined fields with their corresponding UDF Code Value
https://api2.redtailtechnology.com/crm/v1/rest/settings/udf
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/settings/udf");
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());
Tag Groups Fetch
The URI '/settings/taggroups', when coupled with Method Type 'GET', returns a list of Tag Groups associated with the authenticated User's Database
https://api2.redtailtechnology.com/crm/v1/rest/settings/taggroups
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/settings/taggroups");
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());
Comments