Go-to-Light Service 4.0.0.2397 - 121 - API License to Cloud Demo

<back to all web services

CCShowAlias

Requires Authentication
The following routes are available for this service:
All Verbs/CCShowAlias/{Alias}/{Color}/{Effect}
<?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 CCShowAlias implements JsonSerializable
{
    public function __construct(
        /** @description Business alias */
        // @ApiMember(Description="Business alias", IsRequired=true)
        /** @var string */
        public string $Alias='',

        /** @description Animated effect selection: 0 = Always ON (no effect), 1 = BLINK_NORMAL, 2 = BLINK_FAST, 3 = BLINK_SLOW, 4 = FADE_IN_OUT_NORMAL, 5 = FADE_IN_OUT_FAST, 6 = FADE_IN_OUT_SLOW, 7 = FADE_OUT_NORMAL, 8 = FADE_OUT_FAST, 9 = FADE_OUT_SLOW */
        // @ApiMember(Description="Animated effect selection: 0 = Always ON (no effect), 1 = BLINK_NORMAL, 2 = BLINK_FAST, 3 = BLINK_SLOW, 4 = FADE_IN_OUT_NORMAL, 5 = FADE_IN_OUT_FAST, 6 = FADE_IN_OUT_SLOW, 7 = FADE_OUT_NORMAL, 8 = FADE_OUT_FAST, 9 = FADE_OUT_SLOW", IsRequired=true)
        /** @var int */
        public int $Effect=0,

        /** @description HTML Color code (e.g. FF00FF) */
        // @ApiMember(Description="HTML Color code (e.g. FF00FF)", IsRequired=true)
        /** @var string */
        public string $Color=''
    ) {
    }

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

PHP CCShowAlias DTOs

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

HTTP + OTHER

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

POST /CCShowAlias/{Alias}/{Color}/{Effect} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"Alias":"String","Effect":0,"Color":"String"}