Trendsic Platform Service

<back to all web services

EventFieldRequest

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET/v1/EventFields/{EventRegistrationId}
GET,POST,PUT,OPTIONS/v1/EventFields
<?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 EventField implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $EventFieldId=0,
        /** @var string */
        public string $EventRegistrationId='',
        /** @var string|null */
        public ?string $FieldName=null,
        /** @var string|null */
        public ?string $FieldNote=null,
        /** @var int */
        public int $FieldSort=0
    ) {
    }

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

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

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

class EventFieldRequest implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $EventRegistrationId='',
        /** @var array<EventField>|null */
        public ?array $EventField=null
    ) {
    }

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

PHP EventFieldRequest DTOs

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

HTTP + OTHER

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

POST /v1/EventFields HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"EventRegistrationId":"00000000000000000000000000000000","EventField":[{"EventFieldId":0,"EventRegistrationId":"00000000000000000000000000000000","FieldName":"String","FieldNote":"String","FieldSort":0}]}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"EventField":[{"EventFieldId":0,"EventRegistrationId":"00000000000000000000000000000000","FieldName":"String","FieldNote":"String","FieldSort":0}]}