digitaluapi

CampaignsLookup

**Requires Authentication**
Requires any of the roles:	Client, Admin, Partner

The following routes are available for this service:
GET	/campaigns

<?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 CampaignsLookup implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=2)
        /** @var int */
        public int $TenantsId=0,

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

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

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

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

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

        // @DataMember(Order=8)
        /** @var int */
        public int $StatusCodesId=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['TenantsId'])) $this->TenantsId = $o['TenantsId'];
        if (isset($o['Name'])) $this->Name = $o['Name'];
        if (isset($o['Description'])) $this->Description = $o['Description'];
        if (isset($o['AvatarsId'])) $this->AvatarsId = $o['AvatarsId'];
        if (isset($o['SchedulesId'])) $this->SchedulesId = $o['SchedulesId'];
        if (isset($o['MessageTonesId'])) $this->MessageTonesId = $o['MessageTonesId'];
        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->Name)) $o['Name'] = $this->Name;
        if (isset($this->Description)) $o['Description'] = $this->Description;
        if (isset($this->AvatarsId)) $o['AvatarsId'] = $this->AvatarsId;
        if (isset($this->SchedulesId)) $o['SchedulesId'] = $this->SchedulesId;
        if (isset($this->MessageTonesId)) $o['MessageTonesId'] = $this->MessageTonesId;
        if (isset($this->StatusCodesId)) $o['StatusCodesId'] = $this->StatusCodesId;
        return empty($o) ? new class(){} : $o;
    }
}

PHP CampaignsLookup DTOs

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

HTTP + JSV

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

GET /campaigns HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		TenantsId: 0,
		Name: String,
		Description: String,
		AvatarsId: 0,
		SchedulesId: 0,
		MessageTonesId: 0,
		StatusCodesId: 0,
		ResponseStatus: 
		{
			ErrorCode: String,
			Message: String,
			StackTrace: String,
			Errors: 
			[
				{
					ErrorCode: String,
					FieldName: String,
					Message: String,
					Meta: 
					{
						String: String
					}
				}
			],
			Meta: 
			{
				String: String
			}
		}
	}
]