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}
namespace GoToLightAPI

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type Hide() = 
        ///<summary>
        ///Key identifying a location
        ///</summary>
        [<ApiMember(Description="Key identifying a location", IsRequired=true)>]
        member val Key:String = null with get,set

        ///<summary>
        ///HTML Color code (e.g. FF00FF)
        ///</summary>
        [<ApiMember(Description="HTML Color code (e.g. FF00FF)", IsRequired=true)>]
        member val Color:String = null with get,set

        ///<summary>
        ///Optional: delay the execution of the command (in seconds)
        ///</summary>
        [<ApiMember(Description="Optional: delay the execution of the command (in seconds)")>]
        member val Delay:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///Optional: name of the stockroom where to hide the position
        ///</summary>
        [<ApiMember(Description="Optional: name of the stockroom where to hide the position")>]
        member val StockroomName:String = null with get,set

        ///<summary>
        ///Optional: name of the owner of the color/command to allow color sharing
        ///</summary>
        [<ApiMember(Description="Optional: name of the owner of the color/command to allow color sharing")>]
        member val Owner:String = null with get,set

F# 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>