regis

CRMContactUpdateNonBioAddressRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/DynamicsCRM/Contact/{guid}/UpdateNonBioAddress

<?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 CRMContactUpdateNonBioAddressRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $guid=null,
        /** @var int */
        public int $regent_id=0,
        /** @var string|null */
        public ?string $birth_month=null,
        /** @var int|null */
        public ?int $age=null,
        /** @var string|null */
        public ?string $student_segment=null,
        /** @var int|null */
        public ?int $engagement_score=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 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 $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
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['guid'])) $this->guid = $o['guid'];
        if (isset($o['regent_id'])) $this->regent_id = $o['regent_id'];
        if (isset($o['birth_month'])) $this->birth_month = $o['birth_month'];
        if (isset($o['age'])) $this->age = $o['age'];
        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['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['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['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'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->guid)) $o['guid'] = $this->guid;
        if (isset($this->regent_id)) $o['regent_id'] = $this->regent_id;
        if (isset($this->birth_month)) $o['birth_month'] = $this->birth_month;
        if (isset($this->age)) $o['age'] = $this->age;
        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->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->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->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;
        return empty($o) ? new class(){} : $o;
    }
}

PHP CRMContactUpdateNonBioAddressRequest 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/{guid}/UpdateNonBioAddress HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CRMContactUpdateNonBioAddressRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.DynamicsCRM.Requests">
  <age>0</age>
  <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>
  <consent_to_receive_bulk_email>String</consent_to_receive_bulk_email>
  <current_program>String</current_program>
  <engagement_score>0</engagement_score>
  <financial_aid_received>false</financial_aid_received>
  <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_oncampus_class>0001-01-01T00:00:00</last_oncampus_class>
  <last_summer_class>0001-01-01T00:00:00</last_summer_class>
  <regent_id>0</regent_id>
  <solicitation_method>String</solicitation_method>
  <student_segment>String</student_segment>
  <total_audit_hours>0</total_audit_hours>
  <total_credit_hours>0</total_credit_hours>
</CRMContactUpdateNonBioAddressRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ResponseStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <ErrorCode>String</ErrorCode>
  <Message>String</Message>
  <StackTrace>String</StackTrace>
  <Errors>
    <ResponseError>
      <ErrorCode>String</ErrorCode>
      <FieldName>String</FieldName>
      <Message>String</Message>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Meta>
    </ResponseError>
  </Errors>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</ResponseStatus>