regis

<back to all web services

CRMCRUXUpsertRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/DynamicsCRM/CRUX/Upsert
<?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 CRMCRUXSubscriptionUpsertRequest implements JsonSerializable
{
    public function __construct(
        /** @var float */
        public float $payment_amount=0.0,
        /** @var int|null */
        public ?int $import_id=null,
        /** @var DateTime|null */
        public ?DateTime $payment_date=null,
        /** @var DateTime|null */
        public ?DateTime $start_date=null,
        /** @var DateTime|null */
        public ?DateTime $end_date=null,
        /** @var DateTime|null */
        public ?DateTime $added_date=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['payment_amount'])) $this->payment_amount = $o['payment_amount'];
        if (isset($o['import_id'])) $this->import_id = $o['import_id'];
        if (isset($o['payment_date'])) $this->payment_date = JsonConverters::from('DateTime', $o['payment_date']);
        if (isset($o['start_date'])) $this->start_date = JsonConverters::from('DateTime', $o['start_date']);
        if (isset($o['end_date'])) $this->end_date = JsonConverters::from('DateTime', $o['end_date']);
        if (isset($o['added_date'])) $this->added_date = JsonConverters::from('DateTime', $o['added_date']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->payment_amount)) $o['payment_amount'] = $this->payment_amount;
        if (isset($this->import_id)) $o['import_id'] = $this->import_id;
        if (isset($this->payment_date)) $o['payment_date'] = JsonConverters::to('DateTime', $this->payment_date);
        if (isset($this->start_date)) $o['start_date'] = JsonConverters::to('DateTime', $this->start_date);
        if (isset($this->end_date)) $o['end_date'] = JsonConverters::to('DateTime', $this->end_date);
        if (isset($this->added_date)) $o['added_date'] = JsonConverters::to('DateTime', $this->added_date);
        return empty($o) ? new class(){} : $o;
    }
}

class CRMCRUXUpsertRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $regent_id=0,
        /** @var string|null */
        public ?string $status=null,
        /** @var string|null */
        public ?string $notes=null,
        /** @var bool|null */
        public ?bool $is_contact=null,
        /** @var bool|null */
        public ?bool $is_account=null,
        /** @var array<CRMCRUXSubscriptionUpsertRequest>|null */
        public ?array $subscriptions=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['regent_id'])) $this->regent_id = $o['regent_id'];
        if (isset($o['status'])) $this->status = $o['status'];
        if (isset($o['notes'])) $this->notes = $o['notes'];
        if (isset($o['is_contact'])) $this->is_contact = $o['is_contact'];
        if (isset($o['is_account'])) $this->is_account = $o['is_account'];
        if (isset($o['subscriptions'])) $this->subscriptions = JsonConverters::fromArray('CRMCRUXSubscriptionUpsertRequest', $o['subscriptions']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->regent_id)) $o['regent_id'] = $this->regent_id;
        if (isset($this->status)) $o['status'] = $this->status;
        if (isset($this->notes)) $o['notes'] = $this->notes;
        if (isset($this->is_contact)) $o['is_contact'] = $this->is_contact;
        if (isset($this->is_account)) $o['is_account'] = $this->is_account;
        if (isset($this->subscriptions)) $o['subscriptions'] = JsonConverters::toArray('CRMCRUXSubscriptionUpsertRequest', $this->subscriptions);
        return empty($o) ? new class(){} : $o;
    }
}

PHP CRMCRUXUpsertRequest 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/CRUX/Upsert HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	regent_id: 0,
	status: String,
	notes: String,
	is_contact: False,
	is_account: False,
	subscriptions: 
	[
		{
			payment_amount: 0,
			import_id: 0,
			payment_date: 0001-01-01,
			start_date: 0001-01-01,
			end_date: 0001-01-01,
			added_date: 0001-01-01
		}
	]
}
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
	}
}