regis

<back to all web services

CRMConnectionCreateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/DynamicsCRM/Connection/Create
<?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 CRMConnectionCreateRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $first_regent_id=0,
        /** @var int */
        public int $second_regent_id=0,
        /** @var bool|null */
        public ?bool $is_contact_to_account=null,
        /** @var bool|null */
        public ?bool $is_contact_to_contact=null,
        /** @var bool|null */
        public ?bool $is_account_to_account=null,
        /** @var bool|null */
        public ?bool $is_account_to_contact=null,
        /** @var string|null */
        public ?string $first_role=null,
        /** @var string|null */
        public ?string $second_role=null,
        /** @var string|null */
        public ?string $connection_category=null,
        /** @var string|null */
        public ?string $description=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['first_regent_id'])) $this->first_regent_id = $o['first_regent_id'];
        if (isset($o['second_regent_id'])) $this->second_regent_id = $o['second_regent_id'];
        if (isset($o['is_contact_to_account'])) $this->is_contact_to_account = $o['is_contact_to_account'];
        if (isset($o['is_contact_to_contact'])) $this->is_contact_to_contact = $o['is_contact_to_contact'];
        if (isset($o['is_account_to_account'])) $this->is_account_to_account = $o['is_account_to_account'];
        if (isset($o['is_account_to_contact'])) $this->is_account_to_contact = $o['is_account_to_contact'];
        if (isset($o['first_role'])) $this->first_role = $o['first_role'];
        if (isset($o['second_role'])) $this->second_role = $o['second_role'];
        if (isset($o['connection_category'])) $this->connection_category = $o['connection_category'];
        if (isset($o['description'])) $this->description = $o['description'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->first_regent_id)) $o['first_regent_id'] = $this->first_regent_id;
        if (isset($this->second_regent_id)) $o['second_regent_id'] = $this->second_regent_id;
        if (isset($this->is_contact_to_account)) $o['is_contact_to_account'] = $this->is_contact_to_account;
        if (isset($this->is_contact_to_contact)) $o['is_contact_to_contact'] = $this->is_contact_to_contact;
        if (isset($this->is_account_to_account)) $o['is_account_to_account'] = $this->is_account_to_account;
        if (isset($this->is_account_to_contact)) $o['is_account_to_contact'] = $this->is_account_to_contact;
        if (isset($this->first_role)) $o['first_role'] = $this->first_role;
        if (isset($this->second_role)) $o['second_role'] = $this->second_role;
        if (isset($this->connection_category)) $o['connection_category'] = $this->connection_category;
        if (isset($this->description)) $o['description'] = $this->description;
        return empty($o) ? new class(){} : $o;
    }
}

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

{
	first_regent_id: 0,
	second_regent_id: 0,
	is_contact_to_account: False,
	is_contact_to_contact: False,
	is_account_to_account: False,
	is_account_to_contact: False,
	first_role: String,
	second_role: String,
	connection_category: String,
	description: 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
	}
}