digitaluapi

TestSms

**Requires Authentication**
Required role:	Admin

The following routes are available for this service:
All Verbs	/test/sms

<?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 TestSms implements JsonSerializable
{
    public function __construct(
        /** @var bool|null */
        public ?bool $Sandbox=null,
        /** @var string|null */
        public ?string $MobileNumber=null,
        /** @var string|null */
        public ?string $TestMessage=null,
        /** @var string|null */
        public ?string $Channel=null,
        /** @var int */
        public int $NoOfMessages=0
    ) {
    }

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

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

POST /test/sms HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<TestSms xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Channel>String</Channel>
  <MobileNumber>String</MobileNumber>
  <NoOfMessages>0</NoOfMessages>
  <Sandbox>false</Sandbox>
  <TestMessage>String</TestMessage>
</TestSms>

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

<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />