regis

<back to all web services

CRMLeadSearchRequest

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

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

    public constructor(init?: Partial<CRMLeadResponse>) { (Object as any).assign(this, init); }
}

export class CRMLeadSearchRequest
{
    public email: string;

    public constructor(init?: Partial<CRMLeadSearchRequest>) { (Object as any).assign(this, init); }
}

TypeScript CRMLeadSearchRequest DTOs

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

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
Content-Length: length

{"email":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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-01T00:00:00.0000000","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-01T00:00:00.0000000","changed_by":"String","changed_date":"0001-01-01T00:00:00.0000000","owner_full_name":"String"}