regis

CRMContactSearchRequest

**Requires Authentication**
Required role:	REGISUserRole

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

"use strict";
export class CRMContactResponse {
    /** @param {{responseStatus?:ResponseStatus,guid?:string,regent_id?:number,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?:boolean,addr1?:string,addr2?:string,city?:string,state?:string,country?:string,code?:string,citizenship?:string,citizenship_other?:string,permanent_resident?:string,dob?:string,birth_month?:string,deceased_date?:string,age?:number,denomination?:string,connection_to_regent?:string,student_status?:string,student_segment?:string,engagement_score?:number,reason_added?:string,gender?:string,marital_status?:string,financial_aid_received?:boolean,is_applicant?:boolean,solicitation_method?:string,solicitation_exceptions?:string,campaign_monitor_optin?:boolean,campaign_monitor_suppressed?:boolean,campaign_monitor_last_event_date?:string,campaign_monitor_last_reframe_purchase_dt?:string,consent_to_receive_bulk_email?:string,last_consent_source?:string,last_consent_date?:string,campaign_monitor_lists?:string,email?:string,email_secondary?:string,phone_home?:string,phone_bus?:string,phone_cell?:string,no_mail?:boolean,no_email?:boolean,no_bulk_email?:boolean,no_phone?:boolean,no_marketing_materials?:boolean,prefers_email?:boolean,prefers_phone?:boolean,added_by?:string,added_date?:string,changed_by?:string,changed_date?:string,current_program?:string,total_audit_hours?:number,total_credit_hours?:number,last_credit_class?:string,last_audit_class?:string,last_oncampus_class?:string,last_distance_education_class?:string,last_evening_weekend_class?:string,last_summer_class?:string,last_marketplace_class?:string,last_anglican_studies_class?:string,all_student_fee_terms?:string,all_terms_registered?:string,all_terms_registered_onsite?:string,all_terms_registered_online?:string,has_regent_degree?:boolean,owner_full_name?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {string} */
    guid;
    /** @type {number} */
    regent_id;
    /** @type {string} */
    full_name;
    /** @type {string} */
    first_name;
    /** @type {string} */
    last_name;
    /** @type {string} */
    middle_name;
    /** @type {string} */
    preferred_name;
    /** @type {string} */
    former_name;
    /** @type {string} */
    prefix;
    /** @type {string} */
    addressee;
    /** @type {string} */
    primary_salutation;
    /** @type {string} */
    spouse_name;
    /** @type {boolean} */
    spouse_is_main_contact;
    /** @type {string} */
    addr1;
    /** @type {string} */
    addr2;
    /** @type {string} */
    city;
    /** @type {string} */
    state;
    /** @type {string} */
    country;
    /** @type {string} */
    code;
    /** @type {string} */
    citizenship;
    /** @type {string} */
    citizenship_other;
    /** @type {string} */
    permanent_resident;
    /** @type {?string} */
    dob;
    /** @type {string} */
    birth_month;
    /** @type {?string} */
    deceased_date;
    /** @type {?number} */
    age;
    /** @type {string} */
    denomination;
    /** @type {string} */
    connection_to_regent;
    /** @type {string} */
    student_status;
    /** @type {string} */
    student_segment;
    /** @type {?number} */
    engagement_score;
    /** @type {string} */
    reason_added;
    /** @type {string} */
    gender;
    /** @type {string} */
    marital_status;
    /** @type {boolean} */
    financial_aid_received;
    /** @type {boolean} */
    is_applicant;
    /** @type {string} */
    solicitation_method;
    /** @type {string} */
    solicitation_exceptions;
    /** @type {boolean} */
    campaign_monitor_optin;
    /** @type {boolean} */
    campaign_monitor_suppressed;
    /** @type {?string} */
    campaign_monitor_last_event_date;
    /** @type {?string} */
    campaign_monitor_last_reframe_purchase_dt;
    /** @type {string} */
    consent_to_receive_bulk_email;
    /** @type {string} */
    last_consent_source;
    /** @type {?string} */
    last_consent_date;
    /** @type {string} */
    campaign_monitor_lists;
    /** @type {string} */
    email;
    /** @type {string} */
    email_secondary;
    /** @type {string} */
    phone_home;
    /** @type {string} */
    phone_bus;
    /** @type {string} */
    phone_cell;
    /** @type {boolean} */
    no_mail;
    /** @type {boolean} */
    no_email;
    /** @type {boolean} */
    no_bulk_email;
    /** @type {boolean} */
    no_phone;
    /** @type {boolean} */
    no_marketing_materials;
    /** @type {boolean} */
    prefers_email;
    /** @type {boolean} */
    prefers_phone;
    /** @type {string} */
    added_by;
    /** @type {?string} */
    added_date;
    /** @type {string} */
    changed_by;
    /** @type {?string} */
    changed_date;
    /** @type {string} */
    current_program;
    /** @type {?number} */
    total_audit_hours;
    /** @type {?number} */
    total_credit_hours;
    /** @type {?string} */
    last_credit_class;
    /** @type {?string} */
    last_audit_class;
    /** @type {?string} */
    last_oncampus_class;
    /** @type {?string} */
    last_distance_education_class;
    /** @type {?string} */
    last_evening_weekend_class;
    /** @type {?string} */
    last_summer_class;
    /** @type {?string} */
    last_marketplace_class;
    /** @type {?string} */
    last_anglican_studies_class;
    /** @type {string} */
    all_student_fee_terms;
    /** @type {string} */
    all_terms_registered;
    /** @type {string} */
    all_terms_registered_onsite;
    /** @type {string} */
    all_terms_registered_online;
    /** @type {boolean} */
    has_regent_degree;
    /** @type {string} */
    owner_full_name;
}
export class CRMContactSearchRequest {
    /** @param {{email?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    email;
}

JavaScript 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_student_fee_terms>String</all_student_fee_terms>
  <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>