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

<back to all web services

ShowArea

Requires Authentication
The following routes are available for this service:
All Verbs/ShowArea/{AreaID}/{ColorStart}/{ColorStop}/{Duration}
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 ShowArea:
    # @ApiMember(Description="Area ID", IsRequired=true)
    area_i_d: int = 0
    """
    Area ID
    """


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


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


    # @ApiMember(Description="Duration in seconds", IsRequired=true)
    duration: int = 0
    """
    Duration in seconds
    """


    # @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
    """

Python ShowArea 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 /ShowArea/{AreaID}/{ColorStart}/{ColorStop}/{Duration} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ShowArea xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
  <AreaID>0</AreaID>
  <ColorStart>String</ColorStart>
  <ColorStop>String</ColorStop>
  <Duration>0</Duration>
  <Owner>String</Owner>
</ShowArea>