Trendsic Platform Service

<back to all web services

ConversationNBCTypeSubscriptionRequest

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/ConversationNBCTypeSubscription/{ConversationNBCTypeSubscriptionId}
GET,POST,PUT,DELETE,OPTIONS/v1/ConversationNBCTypeSubscription
<?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 ConversationNBCTypeSubscription implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $ConversationNBCTypeSubscriptionId=0,
        /** @var int */
        public int $ConversationNBCTypeId=0,
        /** @var int */
        public int $AgentId=0
    ) {
    }

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

class ConversationNBCTypeSubscriptionExtended extends ConversationNBCTypeSubscription implements JsonSerializable
{
    /**
     * @param int $ConversationNBCTypeSubscriptionId
     * @param int $ConversationNBCTypeId
     * @param int $AgentId
     */
    public function __construct(
        int $ConversationNBCTypeSubscriptionId=0,
        int $ConversationNBCTypeId=0,
        int $AgentId=0,
        /** @var string|null */
        public ?string $AgentName=null
    ) {
        parent::__construct($ConversationNBCTypeSubscriptionId,$ConversationNBCTypeId,$AgentId);
    }

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

class ConversationNBCTypeSubscriptionResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var array<ConversationNBCTypeSubscriptionExtended>|null */
        public ?array $ConversationNBCTypeSubscription=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
        if (isset($o['ConversationNBCTypeSubscription'])) $this->ConversationNBCTypeSubscription = JsonConverters::fromArray('ConversationNBCTypeSubscriptionExtended', $o['ConversationNBCTypeSubscription']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        if (isset($this->ConversationNBCTypeSubscription)) $o['ConversationNBCTypeSubscription'] = JsonConverters::toArray('ConversationNBCTypeSubscriptionExtended', $this->ConversationNBCTypeSubscription);
        return empty($o) ? new class(){} : $o;
    }
}

class ConversationNBCTypeSubscriptionRequest implements JsonSerializable
{
    public function __construct(
        /** @var array<ConversationNBCTypeSubscriptionExtended>|null */
        public ?array $ConversationNBCTypeSubscription=null,
        /** @var int */
        public int $ConversationNBCTypeSubscriptionId=0
    ) {
    }

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

PHP ConversationNBCTypeSubscriptionRequest 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 /v1/ConversationNBCTypeSubscription/{ConversationNBCTypeSubscriptionId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ConversationNBCTypeSubscription: 
	[
		{
			AgentName: String,
			ConversationNBCTypeSubscriptionId: 0,
			ConversationNBCTypeId: 0,
			AgentId: 0
		}
	],
	ConversationNBCTypeSubscriptionId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	ConversationNBCTypeSubscription: 
	[
		{
			AgentName: String,
			ConversationNBCTypeSubscriptionId: 0,
			ConversationNBCTypeId: 0,
			AgentId: 0
		}
	]
}