Trendsic Platform Service

<back to all web services

FormFillSubmitRequest

The following routes are available for this service:
POST/v1/formfill/draft/{Token}/submit
<?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 FormFillReceiptLine implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Channel=null,
        /** @var string|null */
        public ?string $To=null,
        /** @var string|null */
        public ?string $Outcome=null
    ) {
    }

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

class FormFillFieldError implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $K=null,
        /** @var string|null */
        public ?string $Msg=null
    ) {
    }

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

class FormFillSubmitResponse implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $State=null,
        /** @var string|null */
        public ?string $Number=null,
        /** @var string|null */
        public ?string $StatusUrl=null,
        /** @var array<FormFillReceiptLine>|null */
        public ?array $Receipt=null,
        /** @var string|null */
        public ?string $First=null,
        /** @var array<FormFillFieldError>|null */
        public ?array $Errors=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

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

class FormFillSubmitRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Token=null,
        /** @var string|null */
        public ?string $AnswersJson=null,
        /** @var string|null */
        public ?string $Lang=null,
        /** @var string|null */
        public ?string $TurnstileToken=null
    ) {
    }

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

PHP FormFillSubmitRequest DTOs

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

HTTP + JSV

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

POST /v1/formfill/draft/{Token}/submit HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Token: String,
	AnswersJson: String,
	Lang: String,
	TurnstileToken: String
}

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

{
	State: String,
	Number: String,
	StatusUrl: String,
	Receipt: 
	[
		{
			Channel: String,
			To: String,
			Outcome: String
		}
	],
	First: String,
	Errors: 
	[
		{
			K: String,
			Msg: String
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}