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

<back to all web services

CCDeclareAndShowAlias

Requires Authentication
The following routes are available for this service:
All Verbs/CCDeclareAndShowAlias/{Key}/{Alias}/{Color}/{Effect}
import 'package:servicestack/servicestack.dart';

class CCDeclareAndShowAlias implements IConvertible
{
    /**
    * Key identifying a location
    */
    // @ApiMember(Description="Key identifying a location", IsRequired=true)
    String? Key;

    /**
    * Business alias for this key
    */
    // @ApiMember(Description="Business alias for this key", IsRequired=true)
    String? Alias;

    /**
    * 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)
    int? Effect;

    /**
    * HTML Color code (e.g. FF00FF)
    */
    // @ApiMember(Description="HTML Color code (e.g. FF00FF)", IsRequired=true)
    String? Color;

    CCDeclareAndShowAlias({this.Key,this.Alias,this.Effect,this.Color});
    CCDeclareAndShowAlias.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Key = json['Key'];
        Alias = json['Alias'];
        Effect = json['Effect'];
        Color = json['Color'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Key': Key,
        'Alias': Alias,
        'Effect': Effect,
        'Color': Color
    };

    getTypeName() => "CCDeclareAndShowAlias";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'clouddemo.pickeos.com', types: <String, TypeInfo> {
    'CCDeclareAndShowAlias': TypeInfo(TypeOf.Class, create:() => CCDeclareAndShowAlias()),
});

Dart CCDeclareAndShowAlias 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.

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

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