3.0
API change historyREST API with full access to Enquire Objects and meta-data for CRUD operations.
Type GET
A Type is typically used as a drop down list in EnquireLEADS. Popular Types are Market Source, Activity Type, Activity Status, and Lead Score. Below is a list of types available.
CurrentArrangements = 1
ExpectedNeeds = 2
LeadScore = 3
MarketSource = 4
Plans = 5
ActivityStatus = 6
ActivityTypes = 7
Care = 8
PayMethod = 9
RelationshipType = 10
FloorPlanGroupType = 11
ContractType = 12
ContactType = 13
CareGroupType = 14
SalesStage = 15
ReferralCategory = 16
AssistanceType = 17
MoveOutReason = 18
MemoryLoss = 19
ApartmentPreference = 20
ReferralCompanyType = 21
WaitlistPriorityType = 22
UnqualifiedReason = 23
TransactionTypes = 24
TransactionStatus = 25
StatementMethodType = 26
NotificationType = 27
LostLeadDestinationType = 28
DecisonStatusType = 29
CampaignIndividualStatus = 30
CampaignStatus = 31
CampaignType = 32
AmbulationType = 33
BestMethodOfContact = 34
InquiryMethodType = 35
Titles = 36
LostLeadType = 37
ActivityResolution = 38
SaleStatus = 39
CompanyType = 40
EyeColor = 41
HairColor = 42
PreferredTime = 43
MaritalStatus = 44
Ethnicity = 45
Religion = 46
Occupation = 47
YesNo = 48
Language = 49
Gender = 50
Organization = 51
State = 52
Country = 53
CampaignResponse = 54
Individual = 55
Medical = 56
AgeCode = 58
FloorPreference = 59
NetWorth = 60
HomeValue = 61
AnnualIncome = 62
FinanciallyQualified = 63
LeadCategory = 64
Source = 65
Location = 66
ReferringSource = 67
Tier = 68
CompanySub = 69
Campaign = 70
Users = 71
IndividualStatus = 72
Unit = 74
OrganizationCompanyType = 76
UnitType = 77
Ambulation = 1004
IndividualType = 1001
IndividualList = 1002
Status = 1008
Request
Request URL
Request parameters
-
number
This is your company Id. You can request this value from EnquireLEADS support when registering for the API.
-
number
This gives the type you would like returned. Options are: CurrentArrangements = 1, ExpectedNeeds = 2,LeadScore = 3,MarketSource = 4,Plans = 5,ActivityStatus = 6,ActivityTypes = 7,Care = 8,PayMethod = 9,RelationshipType = 10,FloorPlanGroupType = 11,ContractType = 12,ContactType = 13,CareGroupType = 14,SalesStage = 15,ReferralCategory = 16,AppointmentType,AssistanceType = 17,MoveOutReason = 18,MemoryLoss = 19,ApartmentPreference = 20,ReferralCompanyType = 21,WaitlistPriorityType = 22,UnqualifiedReason = 23,TransactionTypes = 24,TransactionStatus = 25,StatementMethodType = 26,NotificationType = 27,LostLeadDestinationType = 28,DecisonStatusType = 29,CampaignIndividualStatus = 30,CampaignStatus = 31,CampaignType = 32,AmbulationType = 33,BestMethodOfContact = 34,InquiryMethodType = 35,Titles = 36,LostLeadType = 37,ActivityResolution = 38,SaleStatus = 39,CompanyType = 40,Ambulation = 43,Empty = 44,Religious = 45,Ethnicity = 46,Occupation = 47,Language = 48,EyeColor = 49,HairColor = 50,MaritalStatus = 51,Gender = 52,User = 53,CampaignResponse = 54,YesNo = 55,Status = 56,Organization = 57,AgeCodeType = 58,FloorPreferenceType = 59
-
(optional)number
Master Id of the type.
-
(optional)number
Id of the type record you want returned
-
(optional)string
Query the name of the type
-
(optional)number
How many records you would like returned
-
(optional)string
Community filter types returned
Request headers
Request body
Responses
200 OK
Representations
[
{
"Id": 483,
"Name": "Advertising-Internet",
"DateCreated": "2014-07-28T15:13:35.3830000-06:00",
"LastModifiedBy": 114,
"UserId": 114,
"MasterName": "Advertising",
"MasterId": 11,
"SortOrder": 10,
"UserFullName": "Enquire Support"
},
{
"Id": 484,
"Name": "Advertising-Print",
"DateCreated": "2014-07-28T15:13:45.4200000-06:00",
"LastModifiedBy": 114,
"UserId": 114,
"MasterName": "Advertising",
"MasterId": 11,
"SortOrder": 20,
"UserFullName": "Enquire Support"
},
{
"Id": 485,
"Name": "Advertising-Radio",
"DateCreated": "2014-07-28T15:13:54.1230000-06:00",
"LastModifiedBy": 114,
"UserId": 114,
"MasterName": "Advertising",
"MasterId": 11,
"SortOrder": 30,
"UserFullName": "Enquire Support"
},
{
"Id": 486,
"Name": "Advertising-Television",
"DateCreated": "2014-07-28T15:14:00.6830000-06:00",
"LastModifiedBy": 114,
"UserId": 114,
"MasterName": "Advertising",
"MasterId": 11,
"SortOrder": 40,
"UserFullName": "Enquire Support"
},
{
"Id": 487,
"Name": "Brochure",
"DateCreated": "2014-07-28T15:14:07.0230000-06:00",
"LastModifiedBy": 114,
"UserId": 114,
"MasterName": "Other",
"MasterId": 16,
"SortOrder": 50,
"UserFullName": "Enquire Support"
},
{
"Id": 488,
"Name": "Community Website",
"DateCreated": "2014-07-28T15:14:14.4430000-06:00",
"LastModifiedBy": 114,
"UserId": 114,
"MasterName": "Website/Social Media",
"MasterId": 15,
"SortOrder": 60,
"UserFullName": "Enquire Support"
},
{
"Id": 489,
"Name": "Direct Mail",
"DateCreated": "2014-07-28T15:14:20.2600000-06:00",
"LastModifiedBy": 114,
"UserId": 114,
"MasterName": "Other",
"MasterId": 16,
"SortOrder": 70,
"UserFullName": "Enquire Support"
},
{
"Id": 490,
"Name": "Online Directory",
"DateCreated": "2014-07-28T15:14:32.4000000-06:00",
"LastModifiedBy": 114,
"UserId": 114,
"MasterName": "Website/Social Media",
"MasterId": 15,
"SortOrder": 80,
"UserFullName": "Enquire Support"
},
{
"Id": 491,
"Name": "Referral",
"DateCreated": "2014-07-28T15:14:40.6200000-06:00",
"LastModifiedBy": 114,
"UserId": 114,
"MasterName": "Professional Referrals",
"MasterId": 14,
"SortOrder": 90,
"UserFullName": "Enquire Support"
},
{
"Id": 492,
"Name": "Unknown-Not Yet Classified",
"DateCreated": "2014-07-28T15:14:53.1970000-06:00",
"LastModifiedBy": 114,
"UserId": 114,
"MasterName": "Other",
"MasterId": 16,
"SortOrder": 100,
"UserFullName": "Enquire Support"
}
]400 Bad Request
Invalid Type parameter
Code samples
@ECHO OFF
curl -v -X GET "https://api2.enquiresolutions.com/v3/Type?PortalId={number}&Type={number}&MasterId={number}&Id={number}&Search={string}&Limit={number}&CommunityId={string}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request parameters
queryString["PortalId"] = "{number}";
queryString["Type"] = "{number}";
queryString["MasterId"] = "{number}";
queryString["Id"] = "{number}";
queryString["Search"] = "{string}";
queryString["Limit"] = "{number}";
queryString["CommunityId"] = "{string}";
var uri = "https://api2.enquiresolutions.com/v3/Type?" + queryString;
var response = await client.GetAsync(uri);
}
}
} // // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://api2.enquiresolutions.com/v3/Type");
builder.setParameter("PortalId", "{number}");
builder.setParameter("Type", "{number}");
builder.setParameter("MasterId", "{number}");
builder.setParameter("Id", "{number}");
builder.setParameter("Search", "{string}");
builder.setParameter("Limit", "{number}");
builder.setParameter("CommunityId", "{string}");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
"PortalId": "{number}",
"Type": "{number}",
"MasterId": "{number}",
"Id": "{number}",
"Search": "{string}",
"Limit": "{number}",
"CommunityId": "{string}",
};
$.ajax({
url: "https://api2.enquiresolutions.com/v3/Type?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "GET",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://api2.enquiresolutions.com/v3/Type";
NSArray* array = @[
// Request parameters
@"entities=true",
@"PortalId={number}",
@"Type={number}",
@"MasterId={number}",
@"Id={number}",
@"Search={string}",
@"Limit={number}",
@"CommunityId={string}",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"GET"];
// Request headers
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://api2.enquiresolutions.com/v3/Type');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'PortalId' => '{number}',
'Type' => '{number}',
'MasterId' => '{number}',
'Id' => '{number}',
'Search' => '{string}',
'Limit' => '{number}',
'CommunityId' => '{string}',
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_GET);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
# Request parameters
'PortalId': '{number}',
'Type': '{number}',
'MasterId': '{number}',
'Id': '{number}',
'Search': '{string}',
'Limit': '{number}',
'CommunityId': '{string}',
})
try:
conn = httplib.HTTPSConnection('api2.enquiresolutions.com')
conn.request("GET", "/v3/Type?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
# Request parameters
'PortalId': '{number}',
'Type': '{number}',
'MasterId': '{number}',
'Id': '{number}',
'Search': '{string}',
'Limit': '{number}',
'CommunityId': '{string}',
})
try:
conn = http.client.HTTPSConnection('api2.enquiresolutions.com')
conn.request("GET", "/v3/Type?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################require 'net/http'
uri = URI('https://api2.enquiresolutions.com/v3/Type')
query = URI.encode_www_form({
# Request parameters
'PortalId' => '{number}',
'Type' => '{number}',
'MasterId' => '{number}',
'Id' => '{number}',
'Search' => '{string}',
'Limit' => '{number}',
'CommunityId' => '{string}'
})
if uri.query && uri.query.length > 0
uri.query += '&' + query
else
uri.query = query
end
request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body