regis

<back to all web services

CRMAccountUpdateNonBioAddressRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/DynamicsCRM/Account/{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 CRMAccountUpdateNonBioAddressRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $guid=null,
        /** @var int */
        public int $regent_id=0,
        /** @var string|null */
        public ?string $solicitation_method=null,
        /** @var string|null */
        public ?string $institution_names=null,
        /** @var string|null */
        public ?string $accreditation_status=null,
        /** @var string|null */
        public ?string $accreditation_status_notes=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 $campaign_monitor_lists=null,
        /** @var string|null */
        public ?string $business_type=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['solicitation_method'])) $this->solicitation_method = $o['solicitation_method'];
        if (isset($o['institution_names'])) $this->institution_names = $o['institution_names'];
        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['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['campaign_monitor_lists'])) $this->campaign_monitor_lists = $o['campaign_monitor_lists'];
        if (isset($o['business_type'])) $this->business_type = $o['business_type'];
    }
    
    /** @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->solicitation_method)) $o['solicitation_method'] = $this->solicitation_method;
        if (isset($this->institution_names)) $o['institution_names'] = $this->institution_names;
        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->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->campaign_monitor_lists)) $o['campaign_monitor_lists'] = $this->campaign_monitor_lists;
        if (isset($this->business_type)) $o['business_type'] = $this->business_type;
        return empty($o) ? new class(){} : $o;
    }
}

PHP CRMAccountUpdateNonBioAddressRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /DynamicsCRM/Account/{guid}/UpdateNonBioAddress HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	guid: String,
	regent_id: 0,
	solicitation_method: String,
	institution_names: String,
	accreditation_status: String,
	accreditation_status_notes: String,
	campaign_monitor_optin: False,
	campaign_monitor_suppressed: False,
	consent_to_receive_bulk_email: String,
	campaign_monitor_lists: String,
	business_type: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	errorCode: String,
	message: String,
	stackTrace: String,
	errors: 
	[
		{
			errorCode: String,
			fieldName: String,
			message: String,
			meta: 
			{
				String: String
			}
		}
	],
	meta: 
	{
		String: String
	}
}