Trendsic Platform Service

<back to all web services

FormFillFileRequest

The following routes are available for this service:
POST/v1/formfill/draft/{Token}/file/{FieldKey}
<?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 FormFillFileResponse implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Id=null,
        /** @var string|null */
        public ?string $Name=null,
        /** @var string|null */
        public ?string $Size=null,
        /** @var string|null */
        public ?string $Kind=null,
        /** @var int */
        public int $Rev=0,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

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

class FormFillFileRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Token=null,
        /** @var string|null */
        public ?string $FieldKey=null,
        /** @var int|null */
        public ?int $Rev=null,
        /** @var ByteArray|null */
        public ?ByteArray $RequestStream=null
    ) {
    }

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

PHP FormFillFileRequest 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}/file/{FieldKey} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Token: String,
	FieldKey: String,
	Rev: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Id: String,
	Name: String,
	Size: String,
	Kind: String,
	Rev: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}