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

<back to all web services

ShowOnLedController

Requires Authentication
The following routes are available for this service:
All Verbs/ShowOnLedController/{LCAddress}/{Color}/{Pixel}/{Width}/{Blink}/{Persistant}
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 ShowOnLedController
    {
        ///<summary>
        ///Led Controller Address
        ///</summary>
        [ApiMember(Description="Led Controller Address", IsRequired=true)]
        public virtual string LCAddress { get; set; }

        ///<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>
        ///Pixel number
        ///</summary>
        [ApiMember(Description="Pixel number", IsRequired=true)]
        public virtual int Pixel { get; set; }

        ///<summary>
        ///Pixel width
        ///</summary>
        [ApiMember(Description="Pixel width", IsRequired=true)]
        public virtual int Width { get; set; }

        ///<summary>
        ///Blinking or not
        ///</summary>
        [ApiMember(Description="Blinking or not", IsRequired=true)]
        public virtual bool Blink { 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 the area is located
        ///</summary>
        [ApiMember(Description="Optional: name of the stockroom where the area is located")]
        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; }
    }

}

C# ShowOnLedController 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 /ShowOnLedController/{LCAddress}/{Color}/{Pixel}/{Width}/{Blink}/{Persistant} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	LCAddress: String,
	Color: String,
	Pixel: 0,
	Width: 0,
	Blink: False,
	Persistant: False,
	Delay: 0,
	Duration: 0,
	StockroomName: String,
	Owner: String,
	Unreliable: False
}