Trendsic Platform Service

<back to all web services

FormAutomationStarterRequest

Requires Authentication
The following routes are available for this service:
POST/v1/forms/{FormUID}/automations/starter/{Key}
<?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 FormAutomationWriteResponse implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $WorkflowId=0,
        /** @var string|null */
        public ?string $Message=null,
        /** @var string|null */
        public ?string $Note=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

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

class FormAutomationStarterRequest implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $FormUID='',
        /** @var string|null */
        public ?string $Key=null
    ) {
    }

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

PHP FormAutomationStarterRequest 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/forms/{FormUID}/automations/starter/{Key} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"FormUID":"00000000000000000000000000000000","Key":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

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