regis

CRMLeadSearchRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/DynamicsCRM/Lead/Search

"use strict";
export class CRMLeadResponse {
    /** @param {{responseStatus?:ResponseStatus,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?:string,denomination?:string,gender?:string,marital_status?:string,send_admissions_marketing_materials?:boolean,email?:string,email_secondary?:string,phone_home?:string,phone_bus?:string,phone_cell?:string,added_by?:string,added_date?:string,changed_by?:string,changed_date?:string,owner_full_name?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {string} */
    guid;
    /** @type {string} */
    first_name;
    /** @type {string} */
    last_name;
    /** @type {string} */
    middle_name;
    /** @type {string} */
    preferred_name;
    /** @type {string} */
    former_name;
    /** @type {string} */
    prefix;
    /** @type {string} */
    spouse_name;
    /** @type {string} */
    addr1;
    /** @type {string} */
    addr2;
    /** @type {string} */
    city;
    /** @type {string} */
    state;
    /** @type {string} */
    country;
    /** @type {string} */
    code;
    /** @type {string} */
    citizenship;
    /** @type {string} */
    citizenship_other;
    /** @type {string} */
    permanent_resident;
    /** @type {?string} */
    dob;
    /** @type {string} */
    denomination;
    /** @type {string} */
    gender;
    /** @type {string} */
    marital_status;
    /** @type {boolean} */
    send_admissions_marketing_materials;
    /** @type {string} */
    email;
    /** @type {string} */
    email_secondary;
    /** @type {string} */
    phone_home;
    /** @type {string} */
    phone_bus;
    /** @type {string} */
    phone_cell;
    /** @type {string} */
    added_by;
    /** @type {?string} */
    added_date;
    /** @type {string} */
    changed_by;
    /** @type {?string} */
    changed_date;
    /** @type {string} */
    owner_full_name;
}
export class CRMLeadSearchRequest {
    /** @param {{email?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    email;
}

JavaScript 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
}