regis

CRMContactSearchRequest

**Requires Authentication**
Required role:	REGISUserRole

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

import java.math.*
import java.util.*
import net.servicestack.client.*


open class CRMContactSearchRequest
{
    var email:String? = null
}

open class CRMContactResponse
{
    var responseStatus:ResponseStatus? = null
    var guid:String? = null
    var regent_id:Int? = null
    var full_name:String? = null
    var first_name:String? = null
    var last_name:String? = null
    var middle_name:String? = null
    var preferred_name:String? = null
    var former_name:String? = null
    var prefix:String? = null
    var addressee:String? = null
    var primary_salutation:String? = null
    var spouse_name:String? = null
    var spouse_is_main_contact:Boolean? = null
    var addr1:String? = null
    var addr2:String? = null
    var city:String? = null
    var state:String? = null
    var country:String? = null
    var code:String? = null
    var citizenship:String? = null
    var citizenship_other:String? = null
    var permanent_resident:String? = null
    var dob:Date? = null
    var birth_month:String? = null
    var deceased_date:Date? = null
    var age:Int? = null
    var denomination:String? = null
    var connection_to_regent:String? = null
    var student_status:String? = null
    var student_segment:String? = null
    var engagement_score:Int? = null
    var reason_added:String? = null
    var gender:String? = null
    var marital_status:String? = null
    var financial_aid_received:Boolean? = null
    var is_applicant:Boolean? = null
    var solicitation_method:String? = null
    var solicitation_exceptions:String? = null
    var campaign_monitor_optin:Boolean? = null
    var campaign_monitor_suppressed:Boolean? = null
    var campaign_monitor_last_event_date:Date? = null
    var campaign_monitor_last_reframe_purchase_dt:Date? = null
    var consent_to_receive_bulk_email:String? = null
    var last_consent_source:String? = null
    var last_consent_date:Date? = null
    var campaign_monitor_lists:String? = null
    var email:String? = null
    var email_secondary:String? = null
    var phone_home:String? = null
    var phone_bus:String? = null
    var phone_cell:String? = null
    var no_mail:Boolean? = null
    var no_email:Boolean? = null
    var no_bulk_email:Boolean? = null
    var no_phone:Boolean? = null
    var no_marketing_materials:Boolean? = null
    var prefers_email:Boolean? = null
    var prefers_phone:Boolean? = null
    var added_by:String? = null
    var added_date:Date? = null
    var changed_by:String? = null
    var changed_date:Date? = null
    var current_program:String? = null
    var total_audit_hours:BigDecimal? = null
    var total_credit_hours:BigDecimal? = null
    var last_credit_class:Date? = null
    var last_audit_class:Date? = null
    var last_oncampus_class:Date? = null
    var last_distance_education_class:Date? = null
    var last_evening_weekend_class:Date? = null
    var last_summer_class:Date? = null
    var last_marketplace_class:Date? = null
    var last_anglican_studies_class:Date? = null
    var all_terms_registered:String? = null
    var all_terms_registered_onsite:String? = null
    var all_terms_registered_online:String? = null
    var has_regent_degree:Boolean? = null
    var owner_full_name:String? = null
}

Kotlin CRMContactSearchRequest DTOs

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/Contact/Search HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

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

<CRMContactResponse 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>
  <addressee>String</addressee>
  <age>0</age>
  <all_terms_registered>String</all_terms_registered>
  <all_terms_registered_online>String</all_terms_registered_online>
  <all_terms_registered_onsite>String</all_terms_registered_onsite>
  <birth_month>String</birth_month>
  <campaign_monitor_last_event_date>0001-01-01T00:00:00</campaign_monitor_last_event_date>
  <campaign_monitor_last_reframe_purchase_dt>0001-01-01T00:00:00</campaign_monitor_last_reframe_purchase_dt>
  <campaign_monitor_lists>String</campaign_monitor_lists>
  <campaign_monitor_optin>false</campaign_monitor_optin>
  <campaign_monitor_suppressed>false</campaign_monitor_suppressed>
  <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>
  <connection_to_regent>String</connection_to_regent>
  <consent_to_receive_bulk_email>String</consent_to_receive_bulk_email>
  <country>String</country>
  <current_program>String</current_program>
  <deceased_date>0001-01-01T00:00:00</deceased_date>
  <denomination>String</denomination>
  <dob>0001-01-01T00:00:00</dob>
  <email>String</email>
  <email_secondary>String</email_secondary>
  <engagement_score>0</engagement_score>
  <financial_aid_received>false</financial_aid_received>
  <first_name>String</first_name>
  <former_name>String</former_name>
  <full_name>String</full_name>
  <gender>String</gender>
  <guid>String</guid>
  <has_regent_degree>false</has_regent_degree>
  <is_applicant>false</is_applicant>
  <last_anglican_studies_class>0001-01-01T00:00:00</last_anglican_studies_class>
  <last_audit_class>0001-01-01T00:00:00</last_audit_class>
  <last_consent_date>0001-01-01T00:00:00</last_consent_date>
  <last_consent_source>String</last_consent_source>
  <last_credit_class>0001-01-01T00:00:00</last_credit_class>
  <last_distance_education_class>0001-01-01T00:00:00</last_distance_education_class>
  <last_evening_weekend_class>0001-01-01T00:00:00</last_evening_weekend_class>
  <last_marketplace_class>0001-01-01T00:00:00</last_marketplace_class>
  <last_name>String</last_name>
  <last_oncampus_class>0001-01-01T00:00:00</last_oncampus_class>
  <last_summer_class>0001-01-01T00:00:00</last_summer_class>
  <marital_status>String</marital_status>
  <middle_name>String</middle_name>
  <no_bulk_email>false</no_bulk_email>
  <no_email>false</no_email>
  <no_mail>false</no_mail>
  <no_marketing_materials>false</no_marketing_materials>
  <no_phone>false</no_phone>
  <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>
  <prefers_email>false</prefers_email>
  <prefers_phone>false</prefers_phone>
  <prefix>String</prefix>
  <primary_salutation>String</primary_salutation>
  <reason_added>String</reason_added>
  <regent_id>0</regent_id>
  <solicitation_exceptions>String</solicitation_exceptions>
  <solicitation_method>String</solicitation_method>
  <spouse_is_main_contact>false</spouse_is_main_contact>
  <spouse_name>String</spouse_name>
  <state>String</state>
  <student_segment>String</student_segment>
  <student_status>String</student_status>
  <total_audit_hours>0</total_audit_hours>
  <total_credit_hours>0</total_credit_hours>
</CRMContactResponse>