regis

CRMAccountRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/DynamicsCRM/Account/{regent_id}

<?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 CRMAccountResponse 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 $name=null,
        /** @var string|null */
        public ?string $other_name=null,
        /** @var string|null */
        public ?string $institution_names=null,
        /** @var string|null */
        public ?string $business_type=null,
        /** @var string|null */
        public ?string $regent_friendly_church=null,
        /** @var string|null */
        public ?string $denomination=null,
        /** @var string|null */
        public ?string $reason_added=null,
        /** @var string|null */
        public ?string $connection_to_regent=null,
        /** @var string|null */
        public ?string $educational_affiliation=null,
        /** @var string|null */
        public ?string $accreditation_status=null,
        /** @var string|null */
        public ?string $accreditation_status_notes=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 $email=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 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 $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 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 $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['name'])) $this->name = $o['name'];
        if (isset($o['other_name'])) $this->other_name = $o['other_name'];
        if (isset($o['institution_names'])) $this->institution_names = $o['institution_names'];
        if (isset($o['business_type'])) $this->business_type = $o['business_type'];
        if (isset($o['regent_friendly_church'])) $this->regent_friendly_church = $o['regent_friendly_church'];
        if (isset($o['denomination'])) $this->denomination = $o['denomination'];
        if (isset($o['reason_added'])) $this->reason_added = $o['reason_added'];
        if (isset($o['connection_to_regent'])) $this->connection_to_regent = $o['connection_to_regent'];
        if (isset($o['educational_affiliation'])) $this->educational_affiliation = $o['educational_affiliation'];
        if (isset($o['accreditation_status'])) $this->accreditation_status = $o['accreditation_status'];
        if (isset($o['accreditation_status_notes'])) $this->accreditation_status_notes = $o['accreditation_status_notes'];
        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['email'])) $this->email = $o['email'];
        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['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['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['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['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->name)) $o['name'] = $this->name;
        if (isset($this->other_name)) $o['other_name'] = $this->other_name;
        if (isset($this->institution_names)) $o['institution_names'] = $this->institution_names;
        if (isset($this->business_type)) $o['business_type'] = $this->business_type;
        if (isset($this->regent_friendly_church)) $o['regent_friendly_church'] = $this->regent_friendly_church;
        if (isset($this->denomination)) $o['denomination'] = $this->denomination;
        if (isset($this->reason_added)) $o['reason_added'] = $this->reason_added;
        if (isset($this->connection_to_regent)) $o['connection_to_regent'] = $this->connection_to_regent;
        if (isset($this->educational_affiliation)) $o['educational_affiliation'] = $this->educational_affiliation;
        if (isset($this->accreditation_status)) $o['accreditation_status'] = $this->accreditation_status;
        if (isset($this->accreditation_status_notes)) $o['accreditation_status_notes'] = $this->accreditation_status_notes;
        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->email)) $o['email'] = $this->email;
        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->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->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->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->owner_full_name)) $o['owner_full_name'] = $this->owner_full_name;
        return empty($o) ? new class(){} : $o;
    }
}

class CRMAccountRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $regent_id=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['regent_id'])) $this->regent_id = $o['regent_id'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->regent_id)) $o['regent_id'] = $this->regent_id;
        return empty($o) ? new class(){} : $o;
    }
}

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

<CRMAccountRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.DynamicsCRM.Requests">
  <regent_id>0</regent_id>
</CRMAccountRequest>

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

<CRMAccountResponse 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>
  <accreditation_status>String</accreditation_status>
  <accreditation_status_notes>String</accreditation_status_notes>
  <added_by>String</added_by>
  <added_date>0001-01-01T00:00:00</added_date>
  <addr1>String</addr1>
  <addr2>String</addr2>
  <business_type>String</business_type>
  <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>
  <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>
  <denomination>String</denomination>
  <educational_affiliation>String</educational_affiliation>
  <email>String</email>
  <guid>String</guid>
  <institution_names>String</institution_names>
  <last_consent_date>0001-01-01T00:00:00</last_consent_date>
  <last_consent_source>String</last_consent_source>
  <name>String</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>
  <other_name>String</other_name>
  <owner_full_name>String</owner_full_name>
  <phone_bus>String</phone_bus>
  <phone_cell>String</phone_cell>
  <phone_home>String</phone_home>
  <prefers_email>false</prefers_email>
  <reason_added>String</reason_added>
  <regent_friendly_church>String</regent_friendly_church>
  <regent_id>0</regent_id>
  <solicitation_exceptions>String</solicitation_exceptions>
  <solicitation_method>String</solicitation_method>
  <state>String</state>
</CRMAccountResponse>