digitaluapi

<back to all web services

ChannelSmsMessagesLookup

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
GET/channel_sms_messages
<?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};


// @DataContract
class ChannelSmsMessagesLookup implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=2)
        /** @var int */
        public int $StatusCodesId=0,

        // @DataMember(Order=3)
        /** @var string|null */
        public ?string $Reference=null,

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

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

        // @DataMember(Order=6)
        /** @var string|null */
        public ?string $Recipients=null,

        // @DataMember(Order=7)
        /** @var int */
        public int $TemplatesId=0,

        // @DataMember(Order=8)
        /** @var string|null */
        public ?string $TemplateText=null,

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

        // @DataMember(Order=10)
        /** @var DateTime|null */
        public ?DateTime $DateSent=null,

        // @DataMember(Order=11)
        /** @var int */
        public int $RetryCount=0,

        // @DataMember(Order=12)
        /** @var string */
        public string $MessageGuid=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['StatusCodesId'])) $this->StatusCodesId = $o['StatusCodesId'];
        if (isset($o['Reference'])) $this->Reference = $o['Reference'];
        if (isset($o['TenantsId'])) $this->TenantsId = $o['TenantsId'];
        if (isset($o['ChannelMessagesId'])) $this->ChannelMessagesId = $o['ChannelMessagesId'];
        if (isset($o['Recipients'])) $this->Recipients = $o['Recipients'];
        if (isset($o['TemplatesId'])) $this->TemplatesId = $o['TemplatesId'];
        if (isset($o['TemplateText'])) $this->TemplateText = $o['TemplateText'];
        if (isset($o['DateCreated'])) $this->DateCreated = JsonConverters::from('DateTime', $o['DateCreated']);
        if (isset($o['DateSent'])) $this->DateSent = JsonConverters::from('DateTimeOffset', $o['DateSent']);
        if (isset($o['RetryCount'])) $this->RetryCount = $o['RetryCount'];
        if (isset($o['MessageGuid'])) $this->MessageGuid = $o['MessageGuid'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->StatusCodesId)) $o['StatusCodesId'] = $this->StatusCodesId;
        if (isset($this->Reference)) $o['Reference'] = $this->Reference;
        if (isset($this->TenantsId)) $o['TenantsId'] = $this->TenantsId;
        if (isset($this->ChannelMessagesId)) $o['ChannelMessagesId'] = $this->ChannelMessagesId;
        if (isset($this->Recipients)) $o['Recipients'] = $this->Recipients;
        if (isset($this->TemplatesId)) $o['TemplatesId'] = $this->TemplatesId;
        if (isset($this->TemplateText)) $o['TemplateText'] = $this->TemplateText;
        if (isset($this->DateCreated)) $o['DateCreated'] = JsonConverters::to('DateTime', $this->DateCreated);
        if (isset($this->DateSent)) $o['DateSent'] = JsonConverters::to('DateTimeOffset', $this->DateSent);
        if (isset($this->RetryCount)) $o['RetryCount'] = $this->RetryCount;
        if (isset($this->MessageGuid)) $o['MessageGuid'] = $this->MessageGuid;
        return empty($o) ? new class(){} : $o;
    }
}

PHP ChannelSmsMessagesLookup DTOs

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

HTTP + XML

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

GET /channel_sms_messages HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfChannelSmsMessagesLookupResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <ChannelSmsMessagesLookupResponse>
    <ChannelMessagesId>0</ChannelMessagesId>
    <DateCreated xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>0001-01-01T00:00:00Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </DateCreated>
    <DateSent xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>0001-01-01T00:00:00Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </DateSent>
    <MessageGuid>00000000-0000-0000-0000-000000000000</MessageGuid>
    <Recipients>String</Recipients>
    <Reference>String</Reference>
    <ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types">
      <d3p1:ErrorCode>String</d3p1:ErrorCode>
      <d3p1:Message>String</d3p1:Message>
      <d3p1:StackTrace>String</d3p1:StackTrace>
      <d3p1:Errors>
        <d3p1:ResponseError>
          <d3p1:ErrorCode>String</d3p1:ErrorCode>
          <d3p1:FieldName>String</d3p1:FieldName>
          <d3p1:Message>String</d3p1:Message>
          <d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d3p1:Meta>
        </d3p1:ResponseError>
      </d3p1:Errors>
      <d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d3p1:Meta>
    </ResponseStatus>
    <RetryCount>0</RetryCount>
    <StatusCodesId>0</StatusCodesId>
    <TemplateText>String</TemplateText>
    <TemplatesId>0</TemplatesId>
    <TenantsId>0</TenantsId>
  </ChannelSmsMessagesLookupResponse>
</ArrayOfChannelSmsMessagesLookupResponse>