regis

<back to all web services

CRMLeadSearchRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/DynamicsCRM/Lead/Search
import Foundation
import ServiceStack

public class CRMLeadSearchRequest : Codable
{
    public var email:String

    required public init(){}
}

public class CRMLeadResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var guid:String
    public var first_name:String
    public var last_name:String
    public var middle_name:String
    public var preferred_name:String
    public var former_name:String
    public var `prefix`:String
    public var spouse_name:String
    public var addr1:String
    public var addr2:String
    public var city:String
    public var state:String
    public var country:String
    public var code:String
    public var citizenship:String
    public var citizenship_other:String
    public var permanent_resident:String
    public var dob:Date?
    public var denomination:String
    public var gender:String
    public var marital_status:String
    public var send_admissions_marketing_materials:Bool
    public var email:String
    public var email_secondary:String
    public var phone_home:String
    public var phone_bus:String
    public var phone_cell:String
    public var added_by:String
    public var added_date:Date?
    public var changed_by:String
    public var changed_date:Date?
    public var owner_full_name:String

    required public init(){}
}


Swift CRMLeadSearchRequest DTOs

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
}