regis

<back to all web services

CRMLeadSearchRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/DynamicsCRM/Lead/Search
CRMLeadSearchRequest Parameters:
NameParameterData TypeRequiredDescription
emailbodystringNo
CRMLeadResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
guidformstringNo
first_nameformstringNo
last_nameformstringNo
middle_nameformstringNo
preferred_nameformstringNo
former_nameformstringNo
prefixformstringNo
spouse_nameformstringNo
addr1formstringNo
addr2formstringNo
cityformstringNo
stateformstringNo
countryformstringNo
codeformstringNo
citizenshipformstringNo
citizenship_otherformstringNo
permanent_residentformstringNo
dobformDateTime?No
denominationformstringNo
genderformstringNo
marital_statusformstringNo
send_admissions_marketing_materialsformboolNo
emailformstringNo
email_secondaryformstringNo
phone_homeformstringNo
phone_busformstringNo
phone_cellformstringNo
added_byformstringNo
added_dateformDateTime?No
changed_byformstringNo
changed_dateformDateTime?No
owner_full_nameformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /DynamicsCRM/Lead/Search HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	email: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	guid: String,
	first_name: String,
	last_name: String,
	middle_name: String,
	preferred_name: String,
	former_name: String,
	prefix: String,
	spouse_name: String,
	addr1: String,
	addr2: String,
	city: String,
	state: String,
	country: String,
	code: String,
	citizenship: String,
	citizenship_other: String,
	permanent_resident: String,
	dob: 0001-01-01,
	denomination: String,
	gender: String,
	marital_status: String,
	send_admissions_marketing_materials: False,
	email: String,
	email_secondary: String,
	phone_home: String,
	phone_bus: String,
	phone_cell: String,
	added_by: String,
	added_date: 0001-01-01,
	changed_by: String,
	changed_date: 0001-01-01,
	owner_full_name: String
}