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

<back to all web services

ShowPredictive

Requires Authentication
The following routes are available for this service:
All Verbs/ShowPredictive/{BlinkKey}/{SteadyKey}/{Color}/{ShowHeader}/{Owner}
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports GoToLightAPI

Namespace Global

    Namespace GoToLightAPI

        Public Enum HeaderMode
            on
            off
            once
        End Enum

        Public Partial Class ShowPredictive
            '''<Summary>
            '''Key identifying a location that will be shown blinking
            '''</Summary>
            <ApiMember(Description:="Key identifying a location that will be shown blinking", IsRequired:=true)>
            Public Overridable Property BlinkKey As String

            '''<Summary>
            '''Key identifying a location that will be shown not blinking
            '''</Summary>
            <ApiMember(Description:="Key identifying a location that will be shown not blinking", IsRequired:=true)>
            Public Overridable Property SteadyKey As String

            '''<Summary>
            '''HTML Color code (e.g. FF00FF)
            '''</Summary>
            <ApiMember(Description:="HTML Color code (e.g. FF00FF)", IsRequired:=true)>
            Public Overridable Property Color As String

            '''<Summary>
            '''Indicates the way the area header will be displayed (possible values are on, off, once)
            '''</Summary>
            <ApiMember(Description:="Indicates the way the area header will be displayed (possible values are on, off, once)", IsRequired:=true)>
            Public Overridable Property ShowHeader As HeaderMode

            '''<Summary>
            '''Name of the owner of the color/command to allow color sharing
            '''</Summary>
            <ApiMember(Description:="Name of the owner of the color/command to allow color sharing", IsRequired:=true)>
            Public Overridable Property Owner As String

            '''<Summary>
            '''Optional: name of the stockroom where to show the position
            '''</Summary>
            <ApiMember(Description:="Optional: name of the stockroom where to show the position")>
            Public Overridable Property StockroomName As String
        End Class
    End Namespace
End Namespace

VB.NET ShowPredictive 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 /ShowPredictive/{BlinkKey}/{SteadyKey}/{Color}/{ShowHeader}/{Owner} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ShowPredictive xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
  <BlinkKey>String</BlinkKey>
  <Color>String</Color>
  <Owner>String</Owner>
  <ShowHeader>on</ShowHeader>
  <SteadyKey>String</SteadyKey>
  <StockroomName>String</StockroomName>
</ShowPredictive>