Trendsic Platform Service

<back to all web services

EngineSuggestionsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/engine/suggestions
<?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 WorkflowSuggestionView implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $SuggestionId=0,
        /** @var string|null */
        public ?string $SuggestionKey=null,
        /** @var string|null */
        public ?string $Title=null,
        /** @var string|null */
        public ?string $Evidence=null,
        /** @var string|null */
        public ?string $Impact=null,
        /** @var string|null */
        public ?string $Vertical=null
    ) {
    }

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

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

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

class EngineSuggestionsRequest implements JsonSerializable
{
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        return empty($o) ? new class(){} : $o;
    }
}

PHP EngineSuggestionsRequest DTOs

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

HTTP + CSV

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

GET /v1/engine/suggestions HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Suggestions":[{"SuggestionId":0,"SuggestionKey":"String","Title":"String","Evidence":"String","Impact":"String","Vertical":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}