Trendsic Platform Service

PDFDocumentRequest

The following routes are available for this service:
GET,OPTIONS	/v1/PDFDocument/{DocumentId}
GET,OPTIONS	/v1/PDFDocument/ByCard/{CardId}

<?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 PDFDocument implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $DocumentId='',
        /** @var ByteArray|null */
        public ?ByteArray $PDFDocument=null,
        /** @var DateTime */
        public DateTime $DateCreated=new DateTime(),
        /** @var int */
        public int $CardId=0
    ) {
    }

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

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

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

class PDFDocumentRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $CardId=0,
        /** @var string */
        public string $DocumentId='',
        /** @var array<PDFDocument>|null */
        public ?array $PDFDocument=null
    ) {
    }

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

PHP PDFDocumentRequest 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.

GET /v1/PDFDocument/{DocumentId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json

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"}},"PDFDocument":[{"DocumentId":"00000000000000000000000000000000","PDFDocument":"AA==","DateCreated":"0001-01-01T00:00:00.0000000","CardId":0}]}