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

<back to all web services

ShowEffect

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using GoToLightAPI;

namespace GoToLightAPI
{
    public partial class ShowCommon
    {
        ///<summary>
        ///HTML Color code (e.g. FF00FF)
        ///</summary>
        [ApiMember(Description="HTML Color code (e.g. FF00FF)", IsRequired=true)]
        public virtual string Color { get; set; }

        ///<summary>
        ///When set to false, it turns off the same color in a previous position
        ///</summary>
        [ApiMember(Description="When set to false, it turns off the same color in a previous position", IsRequired=true)]
        public virtual bool Persistant { get; set; }

        ///<summary>
        ///Optional: delay the execution of the command (in seconds)
        ///</summary>
        [ApiMember(Description="Optional: delay the execution of the command (in seconds)")]
        public virtual int? Delay { get; set; }

        ///<summary>
        ///Optional: duration of the show in seconds
        ///</summary>
        [ApiMember(Description="Optional: duration of the show in seconds")]
        public virtual int? Duration { get; set; }

        ///<summary>
        ///Optional: name of the stockroom where to show the position
        ///</summary>
        [ApiMember(Description="Optional: name of the stockroom where to show the position")]
        public virtual string StockroomName { get; set; }

        ///<summary>
        ///Optional: name of the owner of the color/command to allow color sharing
        ///</summary>
        [ApiMember(Description="Optional: name of the owner of the color/command to allow color sharing")]
        public virtual string Owner { get; set; }

        ///<summary>
        ///Optional: indicates if message shall be delivered in an unreliable way (faster)
        ///</summary>
        [ApiMember(Description="Optional: indicates if message shall be delivered in an unreliable way (faster)")]
        public virtual bool? Unreliable { get; set; }

        ///<summary>
        ///Optional: indicates if the header shall be displayed
        ///</summary>
        [ApiMember(Description="Optional: indicates if the header shall be displayed")]
        public virtual bool? DisplayHeader { get; set; }
    }

    public partial class ShowEffect
        : ShowCommon
    {
        ///<summary>
        ///Key identifying a location
        ///</summary>
        [ApiMember(Description="Key identifying a location", IsRequired=true)]
        public virtual string Key { get; set; }

        ///<summary>
        ///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
        ///</summary>
        [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)]
        public virtual int Effect { get; set; }
    }

}

C# ShowEffect DTOs

POST /ShowEffect/{Key}/{Color}/{Effect}/{Persistant} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ShowEffect xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
  <Color>String</Color>
  <Delay>0</Delay>
  <DisplayHeader>false</DisplayHeader>
  <Duration>0</Duration>
  <Owner>String</Owner>
  <Persistant>false</Persistant>
  <StockroomName>String</StockroomName>
  <Unreliable>false</Unreliable>
  <Effect>0</Effect>
  <Key>String</Key>
</ShowEffect>