Trendsic Platform Service

<back to all web services

StaffDistributionRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/staff/posting/distribution
<?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 StaffBoardDto implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Board=null,
        /** @var string|null */
        public ?string $Label=null,
        /** @var string|null */
        public ?string $ExternalId=null,
        /** @var string|null */
        public ?string $Status=null,
        /** @var string|null */
        public ?string $Message=null
    ) {
    }

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

class StaffDistributionResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var string|null */
        public ?string $PostingStatus=null,
        /** @var string|null */
        public ?string $ApplyUrl=null,
        /** @var string|null */
        public ?string $FeedUrl=null,
        /** @var array<StaffBoardDto>|null */
        public ?array $Boards=null
    ) {
    }

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

class StaffDistributionRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $PlaceholderContactID=0
    ) {
    }

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

PHP StaffDistributionRequest 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/staff/posting/distribution 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"}},"PostingStatus":"String","ApplyUrl":"String","FeedUrl":"String","Boards":[{"Board":"String","Label":"String","ExternalId":"String","Status":"String","Message":"String"}]}