digitaluapi

<back to all web services

MessageLinksAdd

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
POST/message_links
<?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 MessageLinksAddResponse implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=2)
        /** @var int */
        public int $TenantsId=0,

        // @DataMember(Order=3)
        /** @var int */
        public int $CustomersId=0,

        // @DataMember(Order=4)
        /** @var int */
        public int $CampaignsId=0,

        // @DataMember(Order=5)
        /** @var int */
        public int $ChannelsId=0,

        // @DataMember(Order=6)
        /** @var int */
        public int $ActionInboxesId=0,

        // @DataMember(Order=7)
        /** @var string */
        public string $MessageGuid='',

        // @DataMember(Order=8)
        /** @var DateTime */
        public DateTime $SentDateTime=new DateTime(),

        // @DataMember(Order=9)
        /** @var DateTime */
        public DateTime $SelectedDateTime=new DateTime(),

        // @DataMember(Order=10)
        /** @var int */
        public int $StatusCodesId=0,

        // @DataMember(Order=12)
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['TenantsId'])) $this->TenantsId = $o['TenantsId'];
        if (isset($o['CustomersId'])) $this->CustomersId = $o['CustomersId'];
        if (isset($o['CampaignsId'])) $this->CampaignsId = $o['CampaignsId'];
        if (isset($o['ChannelsId'])) $this->ChannelsId = $o['ChannelsId'];
        if (isset($o['ActionInboxesId'])) $this->ActionInboxesId = $o['ActionInboxesId'];
        if (isset($o['MessageGuid'])) $this->MessageGuid = $o['MessageGuid'];
        if (isset($o['SentDateTime'])) $this->SentDateTime = JsonConverters::from('DateTime', $o['SentDateTime']);
        if (isset($o['SelectedDateTime'])) $this->SelectedDateTime = JsonConverters::from('DateTime', $o['SelectedDateTime']);
        if (isset($o['StatusCodesId'])) $this->StatusCodesId = $o['StatusCodesId'];
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->TenantsId)) $o['TenantsId'] = $this->TenantsId;
        if (isset($this->CustomersId)) $o['CustomersId'] = $this->CustomersId;
        if (isset($this->CampaignsId)) $o['CampaignsId'] = $this->CampaignsId;
        if (isset($this->ChannelsId)) $o['ChannelsId'] = $this->ChannelsId;
        if (isset($this->ActionInboxesId)) $o['ActionInboxesId'] = $this->ActionInboxesId;
        if (isset($this->MessageGuid)) $o['MessageGuid'] = $this->MessageGuid;
        if (isset($this->SentDateTime)) $o['SentDateTime'] = JsonConverters::to('DateTime', $this->SentDateTime);
        if (isset($this->SelectedDateTime)) $o['SelectedDateTime'] = JsonConverters::to('DateTime', $this->SelectedDateTime);
        if (isset($this->StatusCodesId)) $o['StatusCodesId'] = $this->StatusCodesId;
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class MessageLinksAdd implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=2)
        // @Validate(Validator="NotNull")
        /** @var int */
        public int $TenantsId=0,

        // @DataMember(Order=3)
        // @Validate(Validator="NotNull")
        /** @var int */
        public int $CustomersId=0,

        // @DataMember(Order=4)
        // @Validate(Validator="NotNull")
        /** @var int */
        public int $CampaignsId=0,

        // @DataMember(Order=5)
        // @Validate(Validator="NotNull")
        /** @var int */
        public int $ChannelsId=0,

        // @DataMember(Order=6)
        // @Validate(Validator="NotNull")
        /** @var int */
        public int $ActionInboxesId=0,

        // @DataMember(Order=7)
        // @Validate(Validator="NotNull")
        /** @var string */
        public string $MessageGuid='',

        // @DataMember(Order=8)
        // @Validate(Validator="NotNull")
        /** @var DateTime */
        public DateTime $SentDateTime=new DateTime(),

        // @DataMember(Order=9)
        // @Validate(Validator="NotNull")
        /** @var DateTime */
        public DateTime $SelectedDateTime=new DateTime(),

        // @DataMember(Order=10)
        // @Validate(Validator="NotNull")
        /** @var int */
        public int $StatusCodesId=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['TenantsId'])) $this->TenantsId = $o['TenantsId'];
        if (isset($o['CustomersId'])) $this->CustomersId = $o['CustomersId'];
        if (isset($o['CampaignsId'])) $this->CampaignsId = $o['CampaignsId'];
        if (isset($o['ChannelsId'])) $this->ChannelsId = $o['ChannelsId'];
        if (isset($o['ActionInboxesId'])) $this->ActionInboxesId = $o['ActionInboxesId'];
        if (isset($o['MessageGuid'])) $this->MessageGuid = $o['MessageGuid'];
        if (isset($o['SentDateTime'])) $this->SentDateTime = JsonConverters::from('DateTime', $o['SentDateTime']);
        if (isset($o['SelectedDateTime'])) $this->SelectedDateTime = JsonConverters::from('DateTime', $o['SelectedDateTime']);
        if (isset($o['StatusCodesId'])) $this->StatusCodesId = $o['StatusCodesId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->TenantsId)) $o['TenantsId'] = $this->TenantsId;
        if (isset($this->CustomersId)) $o['CustomersId'] = $this->CustomersId;
        if (isset($this->CampaignsId)) $o['CampaignsId'] = $this->CampaignsId;
        if (isset($this->ChannelsId)) $o['ChannelsId'] = $this->ChannelsId;
        if (isset($this->ActionInboxesId)) $o['ActionInboxesId'] = $this->ActionInboxesId;
        if (isset($this->MessageGuid)) $o['MessageGuid'] = $this->MessageGuid;
        if (isset($this->SentDateTime)) $o['SentDateTime'] = JsonConverters::to('DateTime', $this->SentDateTime);
        if (isset($this->SelectedDateTime)) $o['SelectedDateTime'] = JsonConverters::to('DateTime', $this->SelectedDateTime);
        if (isset($this->StatusCodesId)) $o['StatusCodesId'] = $this->StatusCodesId;
        return empty($o) ? new class(){} : $o;
    }
}

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

POST /message_links HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"TenantsId":0,"CustomersId":0,"CampaignsId":0,"ChannelsId":0,"ActionInboxesId":0,"MessageGuid":"00000000000000000000000000000000","SentDateTime":"0001-01-01T00:00:00.0000000+00:00","SelectedDateTime":"0001-01-01T00:00:00.0000000+00:00","StatusCodesId":0}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"TenantsId":0,"CustomersId":0,"CampaignsId":0,"ChannelsId":0,"ActionInboxesId":0,"MessageGuid":"00000000000000000000000000000000","SentDateTime":"0001-01-01T00:00:00.0000000+00:00","SelectedDateTime":"0001-01-01T00:00:00.0000000+00:00","StatusCodesId":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}