| Required role: | REGISUserRole |
| POST | /DynamicsCRM/Contact/Search |
|---|
<?php namespace dtos;
use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};
class CRMContactResponse implements JsonSerializable
{
public function __construct(
/** @var ResponseStatus|null */
public ?ResponseStatus $responseStatus=null,
/** @var string|null */
public ?string $guid=null,
/** @var int */
public int $regent_id=0,
/** @var string|null */
public ?string $full_name=null,
/** @var string|null */
public ?string $first_name=null,
/** @var string|null */
public ?string $last_name=null,
/** @var string|null */
public ?string $middle_name=null,
/** @var string|null */
public ?string $preferred_name=null,
/** @var string|null */
public ?string $former_name=null,
/** @var string|null */
public ?string $prefix=null,
/** @var string|null */
public ?string $addressee=null,
/** @var string|null */
public ?string $primary_salutation=null,
/** @var string|null */
public ?string $spouse_name=null,
/** @var bool|null */
public ?bool $spouse_is_main_contact=null,
/** @var string|null */
public ?string $addr1=null,
/** @var string|null */
public ?string $addr2=null,
/** @var string|null */
public ?string $city=null,
/** @var string|null */
public ?string $state=null,
/** @var string|null */
public ?string $country=null,
/** @var string|null */
public ?string $code=null,
/** @var string|null */
public ?string $citizenship=null,
/** @var string|null */
public ?string $citizenship_other=null,
/** @var string|null */
public ?string $permanent_resident=null,
/** @var DateTime|null */
public ?DateTime $dob=null,
/** @var string|null */
public ?string $birth_month=null,
/** @var DateTime|null */
public ?DateTime $deceased_date=null,
/** @var int|null */
public ?int $age=null,
/** @var string|null */
public ?string $denomination=null,
/** @var string|null */
public ?string $connection_to_regent=null,
/** @var string|null */
public ?string $student_status=null,
/** @var string|null */
public ?string $student_segment=null,
/** @var int|null */
public ?int $engagement_score=null,
/** @var string|null */
public ?string $reason_added=null,
/** @var string|null */
public ?string $gender=null,
/** @var string|null */
public ?string $marital_status=null,
/** @var bool|null */
public ?bool $financial_aid_received=null,
/** @var bool|null */
public ?bool $is_applicant=null,
/** @var string|null */
public ?string $solicitation_method=null,
/** @var string|null */
public ?string $solicitation_exceptions=null,
/** @var bool|null */
public ?bool $campaign_monitor_optin=null,
/** @var bool|null */
public ?bool $campaign_monitor_suppressed=null,
/** @var DateTime|null */
public ?DateTime $campaign_monitor_last_event_date=null,
/** @var DateTime|null */
public ?DateTime $campaign_monitor_last_reframe_purchase_dt=null,
/** @var string|null */
public ?string $consent_to_receive_bulk_email=null,
/** @var string|null */
public ?string $last_consent_source=null,
/** @var DateTime|null */
public ?DateTime $last_consent_date=null,
/** @var string|null */
public ?string $campaign_monitor_lists=null,
/** @var string|null */
public ?string $email=null,
/** @var string|null */
public ?string $email_secondary=null,
/** @var string|null */
public ?string $phone_home=null,
/** @var string|null */
public ?string $phone_bus=null,
/** @var string|null */
public ?string $phone_cell=null,
/** @var bool|null */
public ?bool $no_mail=null,
/** @var bool|null */
public ?bool $no_email=null,
/** @var bool|null */
public ?bool $no_bulk_email=null,
/** @var bool|null */
public ?bool $no_phone=null,
/** @var bool|null */
public ?bool $no_marketing_materials=null,
/** @var bool|null */
public ?bool $prefers_email=null,
/** @var bool|null */
public ?bool $prefers_phone=null,
/** @var string|null */
public ?string $added_by=null,
/** @var DateTime|null */
public ?DateTime $added_date=null,
/** @var string|null */
public ?string $changed_by=null,
/** @var DateTime|null */
public ?DateTime $changed_date=null,
/** @var string|null */
public ?string $current_program=null,
/** @var float|null */
public ?float $total_audit_hours=null,
/** @var float|null */
public ?float $total_credit_hours=null,
/** @var DateTime|null */
public ?DateTime $last_credit_class=null,
/** @var DateTime|null */
public ?DateTime $last_audit_class=null,
/** @var DateTime|null */
public ?DateTime $last_oncampus_class=null,
/** @var DateTime|null */
public ?DateTime $last_distance_education_class=null,
/** @var DateTime|null */
public ?DateTime $last_evening_weekend_class=null,
/** @var DateTime|null */
public ?DateTime $last_summer_class=null,
/** @var DateTime|null */
public ?DateTime $last_marketplace_class=null,
/** @var DateTime|null */
public ?DateTime $last_anglican_studies_class=null,
/** @var string|null */
public ?string $all_terms_registered=null,
/** @var string|null */
public ?string $all_terms_registered_onsite=null,
/** @var string|null */
public ?string $all_terms_registered_online=null,
/** @var bool|null */
public ?bool $has_regent_degree=null,
/** @var string|null */
public ?string $owner_full_name=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
if (isset($o['guid'])) $this->guid = $o['guid'];
if (isset($o['regent_id'])) $this->regent_id = $o['regent_id'];
if (isset($o['full_name'])) $this->full_name = $o['full_name'];
if (isset($o['first_name'])) $this->first_name = $o['first_name'];
if (isset($o['last_name'])) $this->last_name = $o['last_name'];
if (isset($o['middle_name'])) $this->middle_name = $o['middle_name'];
if (isset($o['preferred_name'])) $this->preferred_name = $o['preferred_name'];
if (isset($o['former_name'])) $this->former_name = $o['former_name'];
if (isset($o['prefix'])) $this->prefix = $o['prefix'];
if (isset($o['addressee'])) $this->addressee = $o['addressee'];
if (isset($o['primary_salutation'])) $this->primary_salutation = $o['primary_salutation'];
if (isset($o['spouse_name'])) $this->spouse_name = $o['spouse_name'];
if (isset($o['spouse_is_main_contact'])) $this->spouse_is_main_contact = $o['spouse_is_main_contact'];
if (isset($o['addr1'])) $this->addr1 = $o['addr1'];
if (isset($o['addr2'])) $this->addr2 = $o['addr2'];
if (isset($o['city'])) $this->city = $o['city'];
if (isset($o['state'])) $this->state = $o['state'];
if (isset($o['country'])) $this->country = $o['country'];
if (isset($o['code'])) $this->code = $o['code'];
if (isset($o['citizenship'])) $this->citizenship = $o['citizenship'];
if (isset($o['citizenship_other'])) $this->citizenship_other = $o['citizenship_other'];
if (isset($o['permanent_resident'])) $this->permanent_resident = $o['permanent_resident'];
if (isset($o['dob'])) $this->dob = JsonConverters::from('DateTime', $o['dob']);
if (isset($o['birth_month'])) $this->birth_month = $o['birth_month'];
if (isset($o['deceased_date'])) $this->deceased_date = JsonConverters::from('DateTime', $o['deceased_date']);
if (isset($o['age'])) $this->age = $o['age'];
if (isset($o['denomination'])) $this->denomination = $o['denomination'];
if (isset($o['connection_to_regent'])) $this->connection_to_regent = $o['connection_to_regent'];
if (isset($o['student_status'])) $this->student_status = $o['student_status'];
if (isset($o['student_segment'])) $this->student_segment = $o['student_segment'];
if (isset($o['engagement_score'])) $this->engagement_score = $o['engagement_score'];
if (isset($o['reason_added'])) $this->reason_added = $o['reason_added'];
if (isset($o['gender'])) $this->gender = $o['gender'];
if (isset($o['marital_status'])) $this->marital_status = $o['marital_status'];
if (isset($o['financial_aid_received'])) $this->financial_aid_received = $o['financial_aid_received'];
if (isset($o['is_applicant'])) $this->is_applicant = $o['is_applicant'];
if (isset($o['solicitation_method'])) $this->solicitation_method = $o['solicitation_method'];
if (isset($o['solicitation_exceptions'])) $this->solicitation_exceptions = $o['solicitation_exceptions'];
if (isset($o['campaign_monitor_optin'])) $this->campaign_monitor_optin = $o['campaign_monitor_optin'];
if (isset($o['campaign_monitor_suppressed'])) $this->campaign_monitor_suppressed = $o['campaign_monitor_suppressed'];
if (isset($o['campaign_monitor_last_event_date'])) $this->campaign_monitor_last_event_date = JsonConverters::from('DateTime', $o['campaign_monitor_last_event_date']);
if (isset($o['campaign_monitor_last_reframe_purchase_dt'])) $this->campaign_monitor_last_reframe_purchase_dt = JsonConverters::from('DateTime', $o['campaign_monitor_last_reframe_purchase_dt']);
if (isset($o['consent_to_receive_bulk_email'])) $this->consent_to_receive_bulk_email = $o['consent_to_receive_bulk_email'];
if (isset($o['last_consent_source'])) $this->last_consent_source = $o['last_consent_source'];
if (isset($o['last_consent_date'])) $this->last_consent_date = JsonConverters::from('DateTime', $o['last_consent_date']);
if (isset($o['campaign_monitor_lists'])) $this->campaign_monitor_lists = $o['campaign_monitor_lists'];
if (isset($o['email'])) $this->email = $o['email'];
if (isset($o['email_secondary'])) $this->email_secondary = $o['email_secondary'];
if (isset($o['phone_home'])) $this->phone_home = $o['phone_home'];
if (isset($o['phone_bus'])) $this->phone_bus = $o['phone_bus'];
if (isset($o['phone_cell'])) $this->phone_cell = $o['phone_cell'];
if (isset($o['no_mail'])) $this->no_mail = $o['no_mail'];
if (isset($o['no_email'])) $this->no_email = $o['no_email'];
if (isset($o['no_bulk_email'])) $this->no_bulk_email = $o['no_bulk_email'];
if (isset($o['no_phone'])) $this->no_phone = $o['no_phone'];
if (isset($o['no_marketing_materials'])) $this->no_marketing_materials = $o['no_marketing_materials'];
if (isset($o['prefers_email'])) $this->prefers_email = $o['prefers_email'];
if (isset($o['prefers_phone'])) $this->prefers_phone = $o['prefers_phone'];
if (isset($o['added_by'])) $this->added_by = $o['added_by'];
if (isset($o['added_date'])) $this->added_date = JsonConverters::from('DateTime', $o['added_date']);
if (isset($o['changed_by'])) $this->changed_by = $o['changed_by'];
if (isset($o['changed_date'])) $this->changed_date = JsonConverters::from('DateTime', $o['changed_date']);
if (isset($o['current_program'])) $this->current_program = $o['current_program'];
if (isset($o['total_audit_hours'])) $this->total_audit_hours = $o['total_audit_hours'];
if (isset($o['total_credit_hours'])) $this->total_credit_hours = $o['total_credit_hours'];
if (isset($o['last_credit_class'])) $this->last_credit_class = JsonConverters::from('DateTime', $o['last_credit_class']);
if (isset($o['last_audit_class'])) $this->last_audit_class = JsonConverters::from('DateTime', $o['last_audit_class']);
if (isset($o['last_oncampus_class'])) $this->last_oncampus_class = JsonConverters::from('DateTime', $o['last_oncampus_class']);
if (isset($o['last_distance_education_class'])) $this->last_distance_education_class = JsonConverters::from('DateTime', $o['last_distance_education_class']);
if (isset($o['last_evening_weekend_class'])) $this->last_evening_weekend_class = JsonConverters::from('DateTime', $o['last_evening_weekend_class']);
if (isset($o['last_summer_class'])) $this->last_summer_class = JsonConverters::from('DateTime', $o['last_summer_class']);
if (isset($o['last_marketplace_class'])) $this->last_marketplace_class = JsonConverters::from('DateTime', $o['last_marketplace_class']);
if (isset($o['last_anglican_studies_class'])) $this->last_anglican_studies_class = JsonConverters::from('DateTime', $o['last_anglican_studies_class']);
if (isset($o['all_terms_registered'])) $this->all_terms_registered = $o['all_terms_registered'];
if (isset($o['all_terms_registered_onsite'])) $this->all_terms_registered_onsite = $o['all_terms_registered_onsite'];
if (isset($o['all_terms_registered_online'])) $this->all_terms_registered_online = $o['all_terms_registered_online'];
if (isset($o['has_regent_degree'])) $this->has_regent_degree = $o['has_regent_degree'];
if (isset($o['owner_full_name'])) $this->owner_full_name = $o['owner_full_name'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
if (isset($this->guid)) $o['guid'] = $this->guid;
if (isset($this->regent_id)) $o['regent_id'] = $this->regent_id;
if (isset($this->full_name)) $o['full_name'] = $this->full_name;
if (isset($this->first_name)) $o['first_name'] = $this->first_name;
if (isset($this->last_name)) $o['last_name'] = $this->last_name;
if (isset($this->middle_name)) $o['middle_name'] = $this->middle_name;
if (isset($this->preferred_name)) $o['preferred_name'] = $this->preferred_name;
if (isset($this->former_name)) $o['former_name'] = $this->former_name;
if (isset($this->prefix)) $o['prefix'] = $this->prefix;
if (isset($this->addressee)) $o['addressee'] = $this->addressee;
if (isset($this->primary_salutation)) $o['primary_salutation'] = $this->primary_salutation;
if (isset($this->spouse_name)) $o['spouse_name'] = $this->spouse_name;
if (isset($this->spouse_is_main_contact)) $o['spouse_is_main_contact'] = $this->spouse_is_main_contact;
if (isset($this->addr1)) $o['addr1'] = $this->addr1;
if (isset($this->addr2)) $o['addr2'] = $this->addr2;
if (isset($this->city)) $o['city'] = $this->city;
if (isset($this->state)) $o['state'] = $this->state;
if (isset($this->country)) $o['country'] = $this->country;
if (isset($this->code)) $o['code'] = $this->code;
if (isset($this->citizenship)) $o['citizenship'] = $this->citizenship;
if (isset($this->citizenship_other)) $o['citizenship_other'] = $this->citizenship_other;
if (isset($this->permanent_resident)) $o['permanent_resident'] = $this->permanent_resident;
if (isset($this->dob)) $o['dob'] = JsonConverters::to('DateTime', $this->dob);
if (isset($this->birth_month)) $o['birth_month'] = $this->birth_month;
if (isset($this->deceased_date)) $o['deceased_date'] = JsonConverters::to('DateTime', $this->deceased_date);
if (isset($this->age)) $o['age'] = $this->age;
if (isset($this->denomination)) $o['denomination'] = $this->denomination;
if (isset($this->connection_to_regent)) $o['connection_to_regent'] = $this->connection_to_regent;
if (isset($this->student_status)) $o['student_status'] = $this->student_status;
if (isset($this->student_segment)) $o['student_segment'] = $this->student_segment;
if (isset($this->engagement_score)) $o['engagement_score'] = $this->engagement_score;
if (isset($this->reason_added)) $o['reason_added'] = $this->reason_added;
if (isset($this->gender)) $o['gender'] = $this->gender;
if (isset($this->marital_status)) $o['marital_status'] = $this->marital_status;
if (isset($this->financial_aid_received)) $o['financial_aid_received'] = $this->financial_aid_received;
if (isset($this->is_applicant)) $o['is_applicant'] = $this->is_applicant;
if (isset($this->solicitation_method)) $o['solicitation_method'] = $this->solicitation_method;
if (isset($this->solicitation_exceptions)) $o['solicitation_exceptions'] = $this->solicitation_exceptions;
if (isset($this->campaign_monitor_optin)) $o['campaign_monitor_optin'] = $this->campaign_monitor_optin;
if (isset($this->campaign_monitor_suppressed)) $o['campaign_monitor_suppressed'] = $this->campaign_monitor_suppressed;
if (isset($this->campaign_monitor_last_event_date)) $o['campaign_monitor_last_event_date'] = JsonConverters::to('DateTime', $this->campaign_monitor_last_event_date);
if (isset($this->campaign_monitor_last_reframe_purchase_dt)) $o['campaign_monitor_last_reframe_purchase_dt'] = JsonConverters::to('DateTime', $this->campaign_monitor_last_reframe_purchase_dt);
if (isset($this->consent_to_receive_bulk_email)) $o['consent_to_receive_bulk_email'] = $this->consent_to_receive_bulk_email;
if (isset($this->last_consent_source)) $o['last_consent_source'] = $this->last_consent_source;
if (isset($this->last_consent_date)) $o['last_consent_date'] = JsonConverters::to('DateTime', $this->last_consent_date);
if (isset($this->campaign_monitor_lists)) $o['campaign_monitor_lists'] = $this->campaign_monitor_lists;
if (isset($this->email)) $o['email'] = $this->email;
if (isset($this->email_secondary)) $o['email_secondary'] = $this->email_secondary;
if (isset($this->phone_home)) $o['phone_home'] = $this->phone_home;
if (isset($this->phone_bus)) $o['phone_bus'] = $this->phone_bus;
if (isset($this->phone_cell)) $o['phone_cell'] = $this->phone_cell;
if (isset($this->no_mail)) $o['no_mail'] = $this->no_mail;
if (isset($this->no_email)) $o['no_email'] = $this->no_email;
if (isset($this->no_bulk_email)) $o['no_bulk_email'] = $this->no_bulk_email;
if (isset($this->no_phone)) $o['no_phone'] = $this->no_phone;
if (isset($this->no_marketing_materials)) $o['no_marketing_materials'] = $this->no_marketing_materials;
if (isset($this->prefers_email)) $o['prefers_email'] = $this->prefers_email;
if (isset($this->prefers_phone)) $o['prefers_phone'] = $this->prefers_phone;
if (isset($this->added_by)) $o['added_by'] = $this->added_by;
if (isset($this->added_date)) $o['added_date'] = JsonConverters::to('DateTime', $this->added_date);
if (isset($this->changed_by)) $o['changed_by'] = $this->changed_by;
if (isset($this->changed_date)) $o['changed_date'] = JsonConverters::to('DateTime', $this->changed_date);
if (isset($this->current_program)) $o['current_program'] = $this->current_program;
if (isset($this->total_audit_hours)) $o['total_audit_hours'] = $this->total_audit_hours;
if (isset($this->total_credit_hours)) $o['total_credit_hours'] = $this->total_credit_hours;
if (isset($this->last_credit_class)) $o['last_credit_class'] = JsonConverters::to('DateTime', $this->last_credit_class);
if (isset($this->last_audit_class)) $o['last_audit_class'] = JsonConverters::to('DateTime', $this->last_audit_class);
if (isset($this->last_oncampus_class)) $o['last_oncampus_class'] = JsonConverters::to('DateTime', $this->last_oncampus_class);
if (isset($this->last_distance_education_class)) $o['last_distance_education_class'] = JsonConverters::to('DateTime', $this->last_distance_education_class);
if (isset($this->last_evening_weekend_class)) $o['last_evening_weekend_class'] = JsonConverters::to('DateTime', $this->last_evening_weekend_class);
if (isset($this->last_summer_class)) $o['last_summer_class'] = JsonConverters::to('DateTime', $this->last_summer_class);
if (isset($this->last_marketplace_class)) $o['last_marketplace_class'] = JsonConverters::to('DateTime', $this->last_marketplace_class);
if (isset($this->last_anglican_studies_class)) $o['last_anglican_studies_class'] = JsonConverters::to('DateTime', $this->last_anglican_studies_class);
if (isset($this->all_terms_registered)) $o['all_terms_registered'] = $this->all_terms_registered;
if (isset($this->all_terms_registered_onsite)) $o['all_terms_registered_onsite'] = $this->all_terms_registered_onsite;
if (isset($this->all_terms_registered_online)) $o['all_terms_registered_online'] = $this->all_terms_registered_online;
if (isset($this->has_regent_degree)) $o['has_regent_degree'] = $this->has_regent_degree;
if (isset($this->owner_full_name)) $o['owner_full_name'] = $this->owner_full_name;
return empty($o) ? new class(){} : $o;
}
}
class CRMContactSearchRequest implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $email=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['email'])) $this->email = $o['email'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->email)) $o['email'] = $this->email;
return empty($o) ? new class(){} : $o;
}
}
PHP CRMContactSearchRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
Content-Type: text/jsv
Content-Length: length
{
email: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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-01,
birth_month: String,
deceased_date: 0001-01-01,
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-01,
campaign_monitor_last_reframe_purchase_dt: 0001-01-01,
consent_to_receive_bulk_email: String,
last_consent_source: String,
last_consent_date: 0001-01-01,
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-01,
changed_by: String,
changed_date: 0001-01-01,
current_program: String,
total_audit_hours: 0,
total_credit_hours: 0,
last_credit_class: 0001-01-01,
last_audit_class: 0001-01-01,
last_oncampus_class: 0001-01-01,
last_distance_education_class: 0001-01-01,
last_evening_weekend_class: 0001-01-01,
last_summer_class: 0001-01-01,
last_marketplace_class: 0001-01-01,
last_anglican_studies_class: 0001-01-01,
all_terms_registered: String,
all_terms_registered_onsite: String,
all_terms_registered_online: String,
has_regent_degree: False,
owner_full_name: String
}