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

<back to all web services

ShowOnAreaByName

Requires Authentication
The following routes are available for this service:
All Verbs/ShowOnAreaByName/{AreaName}/{Color}/{Pixel}/{Width}/{Blink}/{Persistant}
import 'package:servicestack/servicestack.dart';

class ShowOnAreaByName implements IConvertible
{
    /**
    * Area Name
    */
    // @ApiMember(Description="Area Name", IsRequired=true)
    String? AreaName;

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

    /**
    * Pixel number on the area
    */
    // @ApiMember(Description="Pixel number on the area", IsRequired=true)
    int? Pixel;

    /**
    * Pixel width
    */
    // @ApiMember(Description="Pixel width", IsRequired=true)
    int? Width;

    /**
    * Blinking or not
    */
    // @ApiMember(Description="Blinking or not", IsRequired=true)
    bool? Blink;

    /**
    * When set to false, it turns off the same color in a previous position
    */
    // @ApiMember(Description="When set to false, it turns off the same color in a previous position", IsRequired=true)
    bool? Persistant;

    /**
    * Optional: delay the execution of the command (in seconds)
    */
    // @ApiMember(Description="Optional: delay the execution of the command (in seconds)")
    int? Delay;

    /**
    * Optional: duration of the show in seconds
    */
    // @ApiMember(Description="Optional: duration of the show in seconds")
    int? Duration;

    /**
    * Optional: name of the stockroom where the area is located
    */
    // @ApiMember(Description="Optional: name of the stockroom where the area is located")
    String? StockroomName;

    /**
    * Optional: name of the owner of the color/command to allow color sharing
    */
    // @ApiMember(Description="Optional: name of the owner of the color/command to allow color sharing")
    String? Owner;

    /**
    * Optional: indicates if message shall be delivered in an unreliable way (faster)
    */
    // @ApiMember(Description="Optional: indicates if message shall be delivered in an unreliable way (faster)")
    bool? Unreliable;

    ShowOnAreaByName({this.AreaName,this.Color,this.Pixel,this.Width,this.Blink,this.Persistant,this.Delay,this.Duration,this.StockroomName,this.Owner,this.Unreliable});
    ShowOnAreaByName.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        AreaName = json['AreaName'];
        Color = json['Color'];
        Pixel = json['Pixel'];
        Width = json['Width'];
        Blink = json['Blink'];
        Persistant = json['Persistant'];
        Delay = json['Delay'];
        Duration = json['Duration'];
        StockroomName = json['StockroomName'];
        Owner = json['Owner'];
        Unreliable = json['Unreliable'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'AreaName': AreaName,
        'Color': Color,
        'Pixel': Pixel,
        'Width': Width,
        'Blink': Blink,
        'Persistant': Persistant,
        'Delay': Delay,
        'Duration': Duration,
        'StockroomName': StockroomName,
        'Owner': Owner,
        'Unreliable': Unreliable
    };

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

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

Dart ShowOnAreaByName 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 /ShowOnAreaByName/{AreaName}/{Color}/{Pixel}/{Width}/{Blink}/{Persistant} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"AreaName":"String","Color":"String","Pixel":0,"Width":0,"Blink":false,"Persistant":false,"Delay":0,"Duration":0,"StockroomName":"String","Owner":"String","Unreliable":false}