| Required role: | REGISUserRole |
| 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_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_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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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"}