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

<back to all web services

Hide

Requires Authentication
The following routes are available for this service:
All Verbs/Hide/{Key}/{Color}
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 Hide:
    # @ApiMember(Description="Key identifying a location", IsRequired=true)
    key: Optional[str] = None
    """
    Key identifying a location
    """


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


    # @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: name of the stockroom where to hide the position")
    stockroom_name: Optional[str] = None
    """
    Optional: name of the stockroom where to hide the position
    """


    # @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 Hide 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 /Hide/{Key}/{Color} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<Hide xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
  <Color>String</Color>
  <Delay>0</Delay>
  <Key>String</Key>
  <Owner>String</Owner>
  <StockroomName>String</StockroomName>
</Hide>