Trendsic Platform Service

AdditionalServiceSendRequest

The following routes are available for this service:
POST,OPTIONS	/v1/additionalservice/{Id}/send

<?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 AdditionalServiceSendResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var bool|null */
        public ?bool $Success=null,
        /** @var string|null */
        public ?string $PortalUrl=null,
        /** @var array<string>|null */
        public ?array $DeliveryErrors=null
    ) {
    }

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

class AdditionalServiceSendRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $Id=0,
        /** @var string|null */
        public ?string $Title=null,
        /** @var float|null */
        public ?float $Amount=null,
        /** @var bool|null */
        public ?bool $PriceTbd=null,
        /** @var int|null */
        public ?int $RecipientContactId=null,
        /** @var string|null */
        public ?string $RecipientEmail=null,
        /** @var string|null */
        public ?string $RecipientPhone=null,
        /** @var bool|null */
        public ?bool $DeliverEmail=null,
        /** @var bool|null */
        public ?bool $DeliverSms=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Id'])) $this->Id = $o['Id'];
        if (isset($o['Title'])) $this->Title = $o['Title'];
        if (isset($o['Amount'])) $this->Amount = $o['Amount'];
        if (isset($o['PriceTbd'])) $this->PriceTbd = $o['PriceTbd'];
        if (isset($o['RecipientContactId'])) $this->RecipientContactId = $o['RecipientContactId'];
        if (isset($o['RecipientEmail'])) $this->RecipientEmail = $o['RecipientEmail'];
        if (isset($o['RecipientPhone'])) $this->RecipientPhone = $o['RecipientPhone'];
        if (isset($o['DeliverEmail'])) $this->DeliverEmail = $o['DeliverEmail'];
        if (isset($o['DeliverSms'])) $this->DeliverSms = $o['DeliverSms'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Id)) $o['Id'] = $this->Id;
        if (isset($this->Title)) $o['Title'] = $this->Title;
        if (isset($this->Amount)) $o['Amount'] = $this->Amount;
        if (isset($this->PriceTbd)) $o['PriceTbd'] = $this->PriceTbd;
        if (isset($this->RecipientContactId)) $o['RecipientContactId'] = $this->RecipientContactId;
        if (isset($this->RecipientEmail)) $o['RecipientEmail'] = $this->RecipientEmail;
        if (isset($this->RecipientPhone)) $o['RecipientPhone'] = $this->RecipientPhone;
        if (isset($this->DeliverEmail)) $o['DeliverEmail'] = $this->DeliverEmail;
        if (isset($this->DeliverSms)) $o['DeliverSms'] = $this->DeliverSms;
        return empty($o) ? new class(){} : $o;
    }
}

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

POST /v1/additionalservice/{Id}/send HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Id":0,"Title":"String","Amount":0,"PriceTbd":false,"RecipientContactId":0,"RecipientEmail":"String","RecipientPhone":"String","DeliverEmail":false,"DeliverSms":false}

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"}},"Success":false,"PortalUrl":"String","DeliveryErrors":["String"]}