Trendsic Platform Service

<back to all web services

EngineSuggestionActionRequest

Requires Authentication
The following routes are available for this service:
POST/v1/engine/suggestions/{SuggestionId}/{Action}
<?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 EngineActionResponse implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $Affected=0,
        /** @var int */
        public int $CreatedWorkflowId=0,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

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

class EngineSuggestionActionRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $SuggestionId=0,
        /** @var string|null */
        public ?string $Action=null
    ) {
    }

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

PHP EngineSuggestionActionRequest 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/engine/suggestions/{SuggestionId}/{Action} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"SuggestionId":0,"Action":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Affected":0,"CreatedWorkflowId":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}