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}
"use strict";
export class ShowOnLedController {
    /** @param {{LCAddress?:string,Color?:string,Pixel?:number,Width?:number,Blink?:boolean,Persistant?:boolean,Delay?:number,Duration?:number,StockroomName?:string,Owner?:string,Unreliable?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Led Controller Address */
    LCAddress;
    /**
     * @type {string}
     * @description HTML Color code (e.g. FF00FF) */
    Color;
    /**
     * @type {number}
     * @description Pixel number */
    Pixel;
    /**
     * @type {number}
     * @description Pixel width */
    Width;
    /**
     * @type {boolean}
     * @description Blinking or not */
    Blink;
    /**
     * @type {boolean}
     * @description When set to false, it turns off the same color in a previous position */
    Persistant;
    /**
     * @type {?number}
     * @description Optional: delay the execution of the command (in seconds) */
    Delay;
    /**
     * @type {?number}
     * @description Optional: duration of the show in seconds */
    Duration;
    /**
     * @type {string}
     * @description Optional: name of the stockroom where the area is located */
    StockroomName;
    /**
     * @type {string}
     * @description Optional: name of the owner of the color/command to allow color sharing */
    Owner;
    /**
     * @type {?boolean}
     * @description Optional: indicates if message shall be delivered in an unreliable way (faster) */
    Unreliable;
}

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

<ShowOnLedController xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
  <Blink>false</Blink>
  <Color>String</Color>
  <Delay>0</Delay>
  <Duration>0</Duration>
  <LCAddress>String</LCAddress>
  <Owner>String</Owner>
  <Persistant>false</Persistant>
  <Pixel>0</Pixel>
  <StockroomName>String</StockroomName>
  <Unreliable>false</Unreliable>
  <Width>0</Width>
</ShowOnLedController>