digitaluapi

<back to all web services

ChannelMessagesLookup

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

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

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

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

        // @DataMember(Order=6)
        /** @var int */
        public int $TenantsId=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ChannelId'])) $this->ChannelId = $o['ChannelId'];
        if (isset($o['QueriesId'])) $this->QueriesId = $o['QueriesId'];
        if (isset($o['PrimarykeyFieldName'])) $this->PrimarykeyFieldName = $o['PrimarykeyFieldName'];
        if (isset($o['PrimarykeyIdValue'])) $this->PrimarykeyIdValue = $o['PrimarykeyIdValue'];
        if (isset($o['TenantsId'])) $this->TenantsId = $o['TenantsId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ChannelId)) $o['ChannelId'] = $this->ChannelId;
        if (isset($this->QueriesId)) $o['QueriesId'] = $this->QueriesId;
        if (isset($this->PrimarykeyFieldName)) $o['PrimarykeyFieldName'] = $this->PrimarykeyFieldName;
        if (isset($this->PrimarykeyIdValue)) $o['PrimarykeyIdValue'] = $this->PrimarykeyIdValue;
        if (isset($this->TenantsId)) $o['TenantsId'] = $this->TenantsId;
        return empty($o) ? new class(){} : $o;
    }
}

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

GET /channel_messages HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

[{"ChannelId":0,"QueriesId":0,"PrimarykeyFieldName":"String","PrimarykeyIdValue":"String","TenantsId":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}]