digitaluapi

<back to all web services

ConfigurationChannelsEdit

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

        // @DataMember(Order=2)
        /** @var int */
        public int $ConfigurationsId=0,

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

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

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

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Id'])) $this->Id = $o['Id'];
        if (isset($o['ConfigurationsId'])) $this->ConfigurationsId = $o['ConfigurationsId'];
        if (isset($o['ChannelsId'])) $this->ChannelsId = $o['ChannelsId'];
        if (isset($o['TemplatesId'])) $this->TemplatesId = $o['TemplatesId'];
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Id)) $o['Id'] = $this->Id;
        if (isset($this->ConfigurationsId)) $o['ConfigurationsId'] = $this->ConfigurationsId;
        if (isset($this->ChannelsId)) $o['ChannelsId'] = $this->ChannelsId;
        if (isset($this->TemplatesId)) $o['TemplatesId'] = $this->TemplatesId;
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

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

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

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

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

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Id'])) $this->Id = $o['Id'];
        if (isset($o['ConfigurationsId'])) $this->ConfigurationsId = $o['ConfigurationsId'];
        if (isset($o['ChannelsId'])) $this->ChannelsId = $o['ChannelsId'];
        if (isset($o['TemplatesId'])) $this->TemplatesId = $o['TemplatesId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Id)) $o['Id'] = $this->Id;
        if (isset($this->ConfigurationsId)) $o['ConfigurationsId'] = $this->ConfigurationsId;
        if (isset($this->ChannelsId)) $o['ChannelsId'] = $this->ChannelsId;
        if (isset($this->TemplatesId)) $o['TemplatesId'] = $this->TemplatesId;
        return empty($o) ? new class(){} : $o;
    }
}

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

PUT /configuration_channels/{Id} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Id":0,"ConfigurationsId":0,"ChannelsId":0,"TemplatesId":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Id":0,"ConfigurationsId":0,"ChannelsId":0,"TemplatesId":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}