Trendsic Platform Service

<back to all web services

MappingRuleSaveRequest

Requires Authentication
The following routes are available for this service:
PATCH,PUT,DELETE,OPTIONS/v1/records/mapping-rules/{RuleId}
POST,OPTIONS/v1/records/mapping-rules
<?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 RecordsOkResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var bool|null */
        public ?bool $Ok=null,
        /** @var int */
        public int $Id=0,
        /** @var string|null */
        public ?string $Key=null,
        /** @var array<string>|null */
        public ?array $Matches=null
    ) {
    }

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

class MappingRuleSaveRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $RuleId=0,
        /** @var int */
        public int $SortOrder=0,
        /** @var string|null */
        public ?string $Keyword=null,
        /** @var int */
        public int $SeriesId=0,
        /** @var bool|null */
        public ?bool $Active=null
    ) {
    }

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

PHP MappingRuleSaveRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /v1/records/mapping-rules HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"RuleId":0,"SortOrder":0,"Keyword":"String","SeriesId":0,"Active":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Ok":false,"Id":0,"Key":"String","Matches":["String"]}