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

<back to all web services

HideOnAreaByName

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

class HideOnAreaByName 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 group
    */
    // @ApiMember(Description="Pixel number on the group", IsRequired=true)
    int? Pixel;

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

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

    HideOnAreaByName({this.AreaName,this.Color,this.Pixel,this.Delay,this.StockroomName,this.Owner});
    HideOnAreaByName.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

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

Dart HideOnAreaByName DTOs

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

HTTP + XML

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

POST /HideOnAreaByName/{AreaName}/{Color}/{Pixel} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<HideOnAreaByName xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
  <AreaName>String</AreaName>
  <Color>String</Color>
  <Delay>0</Delay>
  <Owner>String</Owner>
  <Pixel>0</Pixel>
  <StockroomName>String</StockroomName>
</HideOnAreaByName>