regis

<back to all web services

CRMContactSearchRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/DynamicsCRM/Contact/Search
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using regis.DynamicsCRM.Requests;
using regis.DynamicsCRM.Responses;

namespace regis.DynamicsCRM.Requests
{
    public partial class CRMContactSearchRequest
    {
        public virtual string email { get; set; }
    }

}

namespace regis.DynamicsCRM.Responses
{
    public partial class CRMContactResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual string guid { get; set; }
        public virtual int regent_id { get; set; }
        public virtual string full_name { get; set; }
        public virtual string first_name { get; set; }
        public virtual string last_name { get; set; }
        public virtual string middle_name { get; set; }
        public virtual string preferred_name { get; set; }
        public virtual string former_name { get; set; }
        public virtual string prefix { get; set; }
        public virtual string addressee { get; set; }
        public virtual string primary_salutation { get; set; }
        public virtual string spouse_name { get; set; }
        public virtual bool spouse_is_main_contact { get; set; }
        public virtual string addr1 { get; set; }
        public virtual string addr2 { get; set; }
        public virtual string city { get; set; }
        public virtual string state { get; set; }
        public virtual string country { get; set; }
        public virtual string code { get; set; }
        public virtual string citizenship { get; set; }
        public virtual string citizenship_other { get; set; }
        public virtual string permanent_resident { get; set; }
        public virtual DateTime? dob { get; set; }
        public virtual string birth_month { get; set; }
        public virtual DateTime? deceased_date { get; set; }
        public virtual int? age { get; set; }
        public virtual string denomination { get; set; }
        public virtual string connection_to_regent { get; set; }
        public virtual string student_status { get; set; }
        public virtual string student_segment { get; set; }
        public virtual int? engagement_score { get; set; }
        public virtual string reason_added { get; set; }
        public virtual string gender { get; set; }
        public virtual string marital_status { get; set; }
        public virtual bool financial_aid_received { get; set; }
        public virtual bool is_applicant { get; set; }
        public virtual string solicitation_method { get; set; }
        public virtual string solicitation_exceptions { get; set; }
        public virtual bool campaign_monitor_optin { get; set; }
        public virtual bool campaign_monitor_suppressed { get; set; }
        public virtual DateTime? campaign_monitor_last_event_date { get; set; }
        public virtual DateTime? campaign_monitor_last_reframe_purchase_dt { get; set; }
        public virtual string consent_to_receive_bulk_email { get; set; }
        public virtual string last_consent_source { get; set; }
        public virtual DateTime? last_consent_date { get; set; }
        public virtual string campaign_monitor_lists { get; set; }
        public virtual string email { get; set; }
        public virtual string email_secondary { get; set; }
        public virtual string phone_home { get; set; }
        public virtual string phone_bus { get; set; }
        public virtual string phone_cell { get; set; }
        public virtual bool no_mail { get; set; }
        public virtual bool no_email { get; set; }
        public virtual bool no_bulk_email { get; set; }
        public virtual bool no_phone { get; set; }
        public virtual bool no_marketing_materials { get; set; }
        public virtual bool prefers_email { get; set; }
        public virtual bool prefers_phone { get; set; }
        public virtual string added_by { get; set; }
        public virtual DateTime? added_date { get; set; }
        public virtual string changed_by { get; set; }
        public virtual DateTime? changed_date { get; set; }
        public virtual string current_program { get; set; }
        public virtual decimal? total_audit_hours { get; set; }
        public virtual decimal? total_credit_hours { get; set; }
        public virtual DateTime? last_credit_class { get; set; }
        public virtual DateTime? last_audit_class { get; set; }
        public virtual DateTime? last_oncampus_class { get; set; }
        public virtual DateTime? last_distance_education_class { get; set; }
        public virtual DateTime? last_evening_weekend_class { get; set; }
        public virtual DateTime? last_summer_class { get; set; }
        public virtual DateTime? last_marketplace_class { get; set; }
        public virtual DateTime? last_anglican_studies_class { get; set; }
        public virtual string all_terms_registered { get; set; }
        public virtual string all_terms_registered_onsite { get; set; }
        public virtual string all_terms_registered_online { get; set; }
        public virtual bool has_regent_degree { get; set; }
        public virtual string owner_full_name { get; set; }
    }

}

C# CRMContactSearchRequest 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/Contact/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","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"}