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

<back to all web services

PBL_SwitchOffPositions

Requires Authentication
The following routes are available for this service:
All Verbs/PBL_SwitchOffPositions
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 PBL_SwitchOffPositions:
    # @ApiMember(Description="Positions identifying LED locations", IsRequired=true)
    positions: List[str] = field(default_factory=list)
    """
    Positions identifying LED locations
    """


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


    # @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: set paramter to TRUE if you need to turn off any color previously turned ON at specified positions")
    switch_off_any_color: Optional[bool] = None
    """
    Optional: set paramter to TRUE if you need to turn off any color previously turned ON at specified positions
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PBL_StandardResponse:
    success: bool = False
    error: Optional[str] = None
    result: Optional[Object] = None
    color: Optional[str] = None

Python PBL_SwitchOffPositions 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 /PBL_SwitchOffPositions HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Positions: 
	[
		String
	],
	Color: String,
	Owner: String,
	SwitchOffAnyColor: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Success: False,
	Error: String,
	Result: {},
	Color: String
}