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}
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ShowOnLedController:
    # @ApiMember(Description="Led Controller Address", IsRequired=true)
    lc_address: Optional[str] = None
    """
    Led Controller Address
    """


    # @ApiMember(Description="HTML Color code (e.g. FF00FF)", IsRequired=true)
    color: Optional[str] = None
    """
    HTML Color code (e.g. FF00FF)
    """


    # @ApiMember(Description="Pixel number", IsRequired=true)
    pixel: int = 0
    """
    Pixel number
    """


    # @ApiMember(Description="Pixel width", IsRequired=true)
    width: int = 0
    """
    Pixel width
    """


    # @ApiMember(Description="Blinking or not", IsRequired=true)
    blink: bool = False
    """
    Blinking or not
    """


    # @ApiMember(Description="When set to false, it turns off the same color in a previous position", IsRequired=true)
    persistant: bool = False
    """
    When set to false, it turns off the same color in a previous position
    """


    # @ApiMember(Description="Optional: delay the execution of the command (in seconds)")
    delay: Optional[int] = None
    """
    Optional: delay the execution of the command (in seconds)
    """


    # @ApiMember(Description="Optional: duration of the show in seconds")
    duration: Optional[int] = None
    """
    Optional: duration of the show in seconds
    """


    # @ApiMember(Description="Optional: name of the stockroom where the area is located")
    stockroom_name: Optional[str] = None
    """
    Optional: name of the stockroom where the area is located
    """


    # @ApiMember(Description="Optional: name of the owner of the color/command to allow color sharing")
    owner: Optional[str] = None
    """
    Optional: name of the owner of the color/command to allow color sharing
    """


    # @ApiMember(Description="Optional: indicates if message shall be delivered in an unreliable way (faster)")
    unreliable: Optional[bool] = None
    """
    Optional: indicates if message shall be delivered in an unreliable way (faster)
    """

Python 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>