regis

CRMLeadSearchRequest

**Requires Authentication**
Required role:	REGISUserRole

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

**CRMLeadSearchRequest** Parameters:
Name	Parameter	Data Type	Required	Description
email	body	string	No

**CRMLeadResponse** Parameters:
Name	Parameter	Data Type	Required
ResponseStatus	form	ResponseStatus	No
guid	form	string	No
first_name	form	string	No
last_name	form	string	No
middle_name	form	string	No
preferred_name	form	string	No
former_name	form	string	No
prefix	form	string	No
spouse_name	form	string	No
addr1	form	string	No
addr2	form	string	No
city	form	string	No
state	form	string	No
country	form	string	No
code	form	string	No
citizenship	form	string	No
citizenship_other	form	string	No
permanent_resident	form	string	No
dob	form	DateTime?	No
denomination	form	string	No
gender	form	string	No
marital_status	form	string	No
send_admissions_marketing_materials	form	bool	No
email	form	string	No
email_secondary	form	string	No
phone_home	form	string	No
phone_bus	form	string	No
phone_cell	form	string	No
added_by	form	string	No
added_date	form	DateTime?	No
changed_by	form	string	No
changed_date	form	DateTime?	No
owner_full_name	form	string	No

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<CRMLeadSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.DynamicsCRM.Requests">
  <email>String</email>
</CRMLeadSearchRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CRMLeadResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.DynamicsCRM.Responses">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <added_by>String</added_by>
  <added_date>0001-01-01T00:00:00</added_date>
  <addr1>String</addr1>
  <addr2>String</addr2>
  <changed_by>String</changed_by>
  <changed_date>0001-01-01T00:00:00</changed_date>
  <citizenship>String</citizenship>
  <citizenship_other>String</citizenship_other>
  <city>String</city>
  <code>String</code>
  <country>String</country>
  <denomination>String</denomination>
  <dob>0001-01-01T00:00:00</dob>
  <email>String</email>
  <email_secondary>String</email_secondary>
  <first_name>String</first_name>
  <former_name>String</former_name>
  <gender>String</gender>
  <guid>String</guid>
  <last_name>String</last_name>
  <marital_status>String</marital_status>
  <middle_name>String</middle_name>
  <owner_full_name>String</owner_full_name>
  <permanent_resident>String</permanent_resident>
  <phone_bus>String</phone_bus>
  <phone_cell>String</phone_cell>
  <phone_home>String</phone_home>
  <preferred_name>String</preferred_name>
  <prefix>String</prefix>
  <send_admissions_marketing_materials>false</send_admissions_marketing_materials>
  <spouse_name>String</spouse_name>
  <state>String</state>
</CRMLeadResponse>