Trendsic Platform Service

<back to all web services

DisclosureRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/Disclosure/{DisclosureId}
GET,OPTIONS/v1/Disclosure
<?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 Disclosure implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $DisclosureId=0,
        /** @var DateTime */
        public DateTime $BeginDate=new DateTime(),
        /** @var DateTime */
        public DateTime $ExpireDate=new DateTime(),
        /** @var string|null */
        public ?string $DisclosureText=null,
        /** @var int */
        public int $DisplayOrder=0,
        /** @var string|null */
        public ?string $DisclosureTitle=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['DisclosureId'])) $this->DisclosureId = $o['DisclosureId'];
        if (isset($o['BeginDate'])) $this->BeginDate = JsonConverters::from('DateTime', $o['BeginDate']);
        if (isset($o['ExpireDate'])) $this->ExpireDate = JsonConverters::from('DateTime', $o['ExpireDate']);
        if (isset($o['DisclosureText'])) $this->DisclosureText = $o['DisclosureText'];
        if (isset($o['DisplayOrder'])) $this->DisplayOrder = $o['DisplayOrder'];
        if (isset($o['DisclosureTitle'])) $this->DisclosureTitle = $o['DisclosureTitle'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->DisclosureId)) $o['DisclosureId'] = $this->DisclosureId;
        if (isset($this->BeginDate)) $o['BeginDate'] = JsonConverters::to('DateTime', $this->BeginDate);
        if (isset($this->ExpireDate)) $o['ExpireDate'] = JsonConverters::to('DateTime', $this->ExpireDate);
        if (isset($this->DisclosureText)) $o['DisclosureText'] = $this->DisclosureText;
        if (isset($this->DisplayOrder)) $o['DisplayOrder'] = $this->DisplayOrder;
        if (isset($this->DisclosureTitle)) $o['DisclosureTitle'] = $this->DisclosureTitle;
        return empty($o) ? new class(){} : $o;
    }
}

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

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

class DisclosureRequest implements JsonSerializable
{
    public function __construct(
        /** @var array<Disclosure>|null */
        public ?array $Disclosure=null
    ) {
    }

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

PHP DisclosureRequest DTOs

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

HTTP + CSV

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

GET /v1/Disclosure/{DisclosureId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Disclosure":[{"DisclosureId":0,"BeginDate":"0001-01-01T00:00:00.0000000","ExpireDate":"0001-01-01T00:00:00.0000000","DisclosureText":"String","DisplayOrder":0,"DisclosureTitle":"String"}]}