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

<back to all web services

ShowArea

Requires Authentication
The following routes are available for this service:
All Verbs/ShowArea/{AreaID}/{ColorStart}/{ColorStop}/{Duration}
import 'package:servicestack/servicestack.dart';

class ShowArea implements IConvertible
{
    /**
    * Area ID
    */
    // @ApiMember(Description="Area ID", IsRequired=true)
    int? AreaID;

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

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

    /**
    * Duration in seconds
    */
    // @ApiMember(Description="Duration in seconds", IsRequired=true)
    int? Duration;

    /**
    * 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;

    ShowArea({this.AreaID,this.ColorStart,this.ColorStop,this.Duration,this.Owner});
    ShowArea.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        AreaID = json['AreaID'];
        ColorStart = json['ColorStart'];
        ColorStop = json['ColorStop'];
        Duration = json['Duration'];
        Owner = json['Owner'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'AreaID': AreaID,
        'ColorStart': ColorStart,
        'ColorStop': ColorStop,
        'Duration': Duration,
        'Owner': Owner
    };

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

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

Dart ShowArea 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 /ShowArea/{AreaID}/{ColorStart}/{ColorStop}/{Duration} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	AreaID: 0,
	ColorStart: String,
	ColorStop: String,
	Duration: 0,
	Owner: String
}