regis

<back to all web services

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.*;

public class dtos
{

    public static class CRMContactSearchRequest
    {
        public String email = null;
        
        public String getEmail() { return email; }
        public CRMContactSearchRequest setEmail(String value) { this.email = value; return this; }
    }

    public static class CRMContactResponse
    {
        public ResponseStatus responseStatus = null;
        public String guid = null;
        public Integer regent_id = null;
        public String full_name = null;
        public String first_name = null;
        public String last_name = null;
        public String middle_name = null;
        public String preferred_name = null;
        public String former_name = null;
        public String prefix = null;
        public String addressee = null;
        public String primary_salutation = null;
        public String spouse_name = null;
        public Boolean spouse_is_main_contact = null;
        public String addr1 = null;
        public String addr2 = null;
        public String city = null;
        public String state = null;
        public String country = null;
        public String code = null;
        public String citizenship = null;
        public String citizenship_other = null;
        public String permanent_resident = null;
        public Date dob = null;
        public String birth_month = null;
        public Date deceased_date = null;
        public Integer age = null;
        public String denomination = null;
        public String connection_to_regent = null;
        public String student_status = null;
        public String student_segment = null;
        public Integer engagement_score = null;
        public String reason_added = null;
        public String gender = null;
        public String marital_status = null;
        public Boolean financial_aid_received = null;
        public Boolean is_applicant = null;
        public String solicitation_method = null;
        public String solicitation_exceptions = null;
        public Boolean campaign_monitor_optin = null;
        public Boolean campaign_monitor_suppressed = null;
        public Date campaign_monitor_last_event_date = null;
        public Date campaign_monitor_last_reframe_purchase_dt = null;
        public String consent_to_receive_bulk_email = null;
        public String last_consent_source = null;
        public Date last_consent_date = null;
        public String campaign_monitor_lists = null;
        public String email = null;
        public String email_secondary = null;
        public String phone_home = null;
        public String phone_bus = null;
        public String phone_cell = null;
        public Boolean no_mail = null;
        public Boolean no_email = null;
        public Boolean no_bulk_email = null;
        public Boolean no_phone = null;
        public Boolean no_marketing_materials = null;
        public Boolean prefers_email = null;
        public Boolean prefers_phone = null;
        public String added_by = null;
        public Date added_date = null;
        public String changed_by = null;
        public Date changed_date = null;
        public String current_program = null;
        public BigDecimal total_audit_hours = null;
        public BigDecimal total_credit_hours = null;
        public Date last_credit_class = null;
        public Date last_audit_class = null;
        public Date last_oncampus_class = null;
        public Date last_distance_education_class = null;
        public Date last_evening_weekend_class = null;
        public Date last_summer_class = null;
        public Date last_marketplace_class = null;
        public Date last_anglican_studies_class = null;
        public String all_terms_registered = null;
        public String all_terms_registered_onsite = null;
        public String all_terms_registered_online = null;
        public Boolean has_regent_degree = null;
        public String owner_full_name = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public CRMContactResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public String getGuid() { return guid; }
        public CRMContactResponse setGuid(String value) { this.guid = value; return this; }
        public Integer getRegentId() { return regent_id; }
        public CRMContactResponse setRegentId(Integer value) { this.regent_id = value; return this; }
        public String getFullName() { return full_name; }
        public CRMContactResponse setFullName(String value) { this.full_name = value; return this; }
        public String getFirstName() { return first_name; }
        public CRMContactResponse setFirstName(String value) { this.first_name = value; return this; }
        public String getLastName() { return last_name; }
        public CRMContactResponse setLastName(String value) { this.last_name = value; return this; }
        public String getMiddleName() { return middle_name; }
        public CRMContactResponse setMiddleName(String value) { this.middle_name = value; return this; }
        public String getPreferredName() { return preferred_name; }
        public CRMContactResponse setPreferredName(String value) { this.preferred_name = value; return this; }
        public String getFormerName() { return former_name; }
        public CRMContactResponse setFormerName(String value) { this.former_name = value; return this; }
        public String getPrefix() { return prefix; }
        public CRMContactResponse setPrefix(String value) { this.prefix = value; return this; }
        public String getAddressee() { return addressee; }
        public CRMContactResponse setAddressee(String value) { this.addressee = value; return this; }
        public String getPrimarySalutation() { return primary_salutation; }
        public CRMContactResponse setPrimarySalutation(String value) { this.primary_salutation = value; return this; }
        public String getSpouseName() { return spouse_name; }
        public CRMContactResponse setSpouseName(String value) { this.spouse_name = value; return this; }
        public Boolean isSpouseIsMainContact() { return spouse_is_main_contact; }
        public CRMContactResponse setSpouseIsMainContact(Boolean value) { this.spouse_is_main_contact = value; return this; }
        public String getAddr1() { return addr1; }
        public CRMContactResponse setAddr1(String value) { this.addr1 = value; return this; }
        public String getAddr2() { return addr2; }
        public CRMContactResponse setAddr2(String value) { this.addr2 = value; return this; }
        public String getCity() { return city; }
        public CRMContactResponse setCity(String value) { this.city = value; return this; }
        public String getState() { return state; }
        public CRMContactResponse setState(String value) { this.state = value; return this; }
        public String getCountry() { return country; }
        public CRMContactResponse setCountry(String value) { this.country = value; return this; }
        public String getCode() { return code; }
        public CRMContactResponse setCode(String value) { this.code = value; return this; }
        public String getCitizenship() { return citizenship; }
        public CRMContactResponse setCitizenship(String value) { this.citizenship = value; return this; }
        public String getCitizenshipOther() { return citizenship_other; }
        public CRMContactResponse setCitizenshipOther(String value) { this.citizenship_other = value; return this; }
        public String getPermanentResident() { return permanent_resident; }
        public CRMContactResponse setPermanentResident(String value) { this.permanent_resident = value; return this; }
        public Date getDob() { return dob; }
        public CRMContactResponse setDob(Date value) { this.dob = value; return this; }
        public String getBirthMonth() { return birth_month; }
        public CRMContactResponse setBirthMonth(String value) { this.birth_month = value; return this; }
        public Date getDeceasedDate() { return deceased_date; }
        public CRMContactResponse setDeceasedDate(Date value) { this.deceased_date = value; return this; }
        public Integer getAge() { return age; }
        public CRMContactResponse setAge(Integer value) { this.age = value; return this; }
        public String getDenomination() { return denomination; }
        public CRMContactResponse setDenomination(String value) { this.denomination = value; return this; }
        public String getConnectionToRegent() { return connection_to_regent; }
        public CRMContactResponse setConnectionToRegent(String value) { this.connection_to_regent = value; return this; }
        public String getStudentStatus() { return student_status; }
        public CRMContactResponse setStudentStatus(String value) { this.student_status = value; return this; }
        public String getStudentSegment() { return student_segment; }
        public CRMContactResponse setStudentSegment(String value) { this.student_segment = value; return this; }
        public Integer getEngagementScore() { return engagement_score; }
        public CRMContactResponse setEngagementScore(Integer value) { this.engagement_score = value; return this; }
        public String getReasonAdded() { return reason_added; }
        public CRMContactResponse setReasonAdded(String value) { this.reason_added = value; return this; }
        public String getGender() { return gender; }
        public CRMContactResponse setGender(String value) { this.gender = value; return this; }
        public String getMaritalStatus() { return marital_status; }
        public CRMContactResponse setMaritalStatus(String value) { this.marital_status = value; return this; }
        public Boolean isFinancialAidReceived() { return financial_aid_received; }
        public CRMContactResponse setFinancialAidReceived(Boolean value) { this.financial_aid_received = value; return this; }
        public Boolean getIsApplicant() { return is_applicant; }
        public CRMContactResponse setIsApplicant(Boolean value) { this.is_applicant = value; return this; }
        public String getSolicitationMethod() { return solicitation_method; }
        public CRMContactResponse setSolicitationMethod(String value) { this.solicitation_method = value; return this; }
        public String getSolicitationExceptions() { return solicitation_exceptions; }
        public CRMContactResponse setSolicitationExceptions(String value) { this.solicitation_exceptions = value; return this; }
        public Boolean isCampaignMonitorOptin() { return campaign_monitor_optin; }
        public CRMContactResponse setCampaignMonitorOptin(Boolean value) { this.campaign_monitor_optin = value; return this; }
        public Boolean isCampaignMonitorSuppressed() { return campaign_monitor_suppressed; }
        public CRMContactResponse setCampaignMonitorSuppressed(Boolean value) { this.campaign_monitor_suppressed = value; return this; }
        public Date getCampaignMonitorLastEventDate() { return campaign_monitor_last_event_date; }
        public CRMContactResponse setCampaignMonitorLastEventDate(Date value) { this.campaign_monitor_last_event_date = value; return this; }
        public Date getCampaignMonitorLastReframePurchaseDt() { return campaign_monitor_last_reframe_purchase_dt; }
        public CRMContactResponse setCampaignMonitorLastReframePurchaseDt(Date value) { this.campaign_monitor_last_reframe_purchase_dt = value; return this; }
        public String getConsentToReceiveBulkEmail() { return consent_to_receive_bulk_email; }
        public CRMContactResponse setConsentToReceiveBulkEmail(String value) { this.consent_to_receive_bulk_email = value; return this; }
        public String getLastConsentSource() { return last_consent_source; }
        public CRMContactResponse setLastConsentSource(String value) { this.last_consent_source = value; return this; }
        public Date getLastConsentDate() { return last_consent_date; }
        public CRMContactResponse setLastConsentDate(Date value) { this.last_consent_date = value; return this; }
        public String getCampaignMonitorLists() { return campaign_monitor_lists; }
        public CRMContactResponse setCampaignMonitorLists(String value) { this.campaign_monitor_lists = value; return this; }
        public String getEmail() { return email; }
        public CRMContactResponse setEmail(String value) { this.email = value; return this; }
        public String getEmailSecondary() { return email_secondary; }
        public CRMContactResponse setEmailSecondary(String value) { this.email_secondary = value; return this; }
        public String getPhoneHome() { return phone_home; }
        public CRMContactResponse setPhoneHome(String value) { this.phone_home = value; return this; }
        public String getPhoneBus() { return phone_bus; }
        public CRMContactResponse setPhoneBus(String value) { this.phone_bus = value; return this; }
        public String getPhoneCell() { return phone_cell; }
        public CRMContactResponse setPhoneCell(String value) { this.phone_cell = value; return this; }
        public Boolean isNoMail() { return no_mail; }
        public CRMContactResponse setNoMail(Boolean value) { this.no_mail = value; return this; }
        public Boolean isNoEmail() { return no_email; }
        public CRMContactResponse setNoEmail(Boolean value) { this.no_email = value; return this; }
        public Boolean isNoBulkEmail() { return no_bulk_email; }
        public CRMContactResponse setNoBulkEmail(Boolean value) { this.no_bulk_email = value; return this; }
        public Boolean isNoPhone() { return no_phone; }
        public CRMContactResponse setNoPhone(Boolean value) { this.no_phone = value; return this; }
        public Boolean isNoMarketingMaterials() { return no_marketing_materials; }
        public CRMContactResponse setNoMarketingMaterials(Boolean value) { this.no_marketing_materials = value; return this; }
        public Boolean isPrefersEmail() { return prefers_email; }
        public CRMContactResponse setPrefersEmail(Boolean value) { this.prefers_email = value; return this; }
        public Boolean isPrefersPhone() { return prefers_phone; }
        public CRMContactResponse setPrefersPhone(Boolean value) { this.prefers_phone = value; return this; }
        public String getAddedBy() { return added_by; }
        public CRMContactResponse setAddedBy(String value) { this.added_by = value; return this; }
        public Date getAddedDate() { return added_date; }
        public CRMContactResponse setAddedDate(Date value) { this.added_date = value; return this; }
        public String getChangedBy() { return changed_by; }
        public CRMContactResponse setChangedBy(String value) { this.changed_by = value; return this; }
        public Date getChangedDate() { return changed_date; }
        public CRMContactResponse setChangedDate(Date value) { this.changed_date = value; return this; }
        public String getCurrentProgram() { return current_program; }
        public CRMContactResponse setCurrentProgram(String value) { this.current_program = value; return this; }
        public BigDecimal getTotalAuditHours() { return total_audit_hours; }
        public CRMContactResponse setTotalAuditHours(BigDecimal value) { this.total_audit_hours = value; return this; }
        public BigDecimal getTotalCreditHours() { return total_credit_hours; }
        public CRMContactResponse setTotalCreditHours(BigDecimal value) { this.total_credit_hours = value; return this; }
        public Date getLastCreditClass() { return last_credit_class; }
        public CRMContactResponse setLastCreditClass(Date value) { this.last_credit_class = value; return this; }
        public Date getLastAuditClass() { return last_audit_class; }
        public CRMContactResponse setLastAuditClass(Date value) { this.last_audit_class = value; return this; }
        public Date getLastOncampusClass() { return last_oncampus_class; }
        public CRMContactResponse setLastOncampusClass(Date value) { this.last_oncampus_class = value; return this; }
        public Date getLastDistanceEducationClass() { return last_distance_education_class; }
        public CRMContactResponse setLastDistanceEducationClass(Date value) { this.last_distance_education_class = value; return this; }
        public Date getLastEveningWeekendClass() { return last_evening_weekend_class; }
        public CRMContactResponse setLastEveningWeekendClass(Date value) { this.last_evening_weekend_class = value; return this; }
        public Date getLastSummerClass() { return last_summer_class; }
        public CRMContactResponse setLastSummerClass(Date value) { this.last_summer_class = value; return this; }
        public Date getLastMarketplaceClass() { return last_marketplace_class; }
        public CRMContactResponse setLastMarketplaceClass(Date value) { this.last_marketplace_class = value; return this; }
        public Date getLastAnglicanStudiesClass() { return last_anglican_studies_class; }
        public CRMContactResponse setLastAnglicanStudiesClass(Date value) { this.last_anglican_studies_class = value; return this; }
        public String getAllTermsRegistered() { return all_terms_registered; }
        public CRMContactResponse setAllTermsRegistered(String value) { this.all_terms_registered = value; return this; }
        public String getAllTermsRegisteredOnsite() { return all_terms_registered_onsite; }
        public CRMContactResponse setAllTermsRegisteredOnsite(String value) { this.all_terms_registered_onsite = value; return this; }
        public String getAllTermsRegisteredOnline() { return all_terms_registered_online; }
        public CRMContactResponse setAllTermsRegisteredOnline(String value) { this.all_terms_registered_online = value; return this; }
        public Boolean isHasRegentDegree() { return has_regent_degree; }
        public CRMContactResponse setHasRegentDegree(Boolean value) { this.has_regent_degree = value; return this; }
        public String getOwnerFullName() { return owner_full_name; }
        public CRMContactResponse setOwnerFullName(String value) { this.owner_full_name = value; return this; }
    }

}

Java CRMContactSearchRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

{"email":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
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","regent_id":0,"full_name":"String","first_name":"String","last_name":"String","middle_name":"String","preferred_name":"String","former_name":"String","prefix":"String","addressee":"String","primary_salutation":"String","spouse_name":"String","spouse_is_main_contact":false,"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","birth_month":"String","deceased_date":"0001-01-01T00:00:00.0000000","age":0,"denomination":"String","connection_to_regent":"String","student_status":"String","student_segment":"String","engagement_score":0,"reason_added":"String","gender":"String","marital_status":"String","financial_aid_received":false,"is_applicant":false,"solicitation_method":"String","solicitation_exceptions":"String","campaign_monitor_optin":false,"campaign_monitor_suppressed":false,"campaign_monitor_last_event_date":"0001-01-01T00:00:00.0000000","campaign_monitor_last_reframe_purchase_dt":"0001-01-01T00:00:00.0000000","consent_to_receive_bulk_email":"String","last_consent_source":"String","last_consent_date":"0001-01-01T00:00:00.0000000","campaign_monitor_lists":"String","email":"String","email_secondary":"String","phone_home":"String","phone_bus":"String","phone_cell":"String","no_mail":false,"no_email":false,"no_bulk_email":false,"no_phone":false,"no_marketing_materials":false,"prefers_email":false,"prefers_phone":false,"added_by":"String","added_date":"0001-01-01T00:00:00.0000000","changed_by":"String","changed_date":"0001-01-01T00:00:00.0000000","current_program":"String","total_audit_hours":0,"total_credit_hours":0,"last_credit_class":"0001-01-01T00:00:00.0000000","last_audit_class":"0001-01-01T00:00:00.0000000","last_oncampus_class":"0001-01-01T00:00:00.0000000","last_distance_education_class":"0001-01-01T00:00:00.0000000","last_evening_weekend_class":"0001-01-01T00:00:00.0000000","last_summer_class":"0001-01-01T00:00:00.0000000","last_marketplace_class":"0001-01-01T00:00:00.0000000","last_anglican_studies_class":"0001-01-01T00:00:00.0000000","all_terms_registered":"String","all_terms_registered_onsite":"String","all_terms_registered_online":"String","has_regent_degree":false,"owner_full_name":"String"}