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

<back to all web services

PBL_SwitchOnPositions

Requires Authentication
The following routes are available for this service:
All Verbs/PBL_SwitchOnPositions
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using GoToLightAPI;

namespace GoToLightAPI
{
    public partial class PBL_StandardResponse
    {
        public virtual bool Success { get; set; }
        public virtual string Error { get; set; }
        public virtual Object Result { get; set; }
        public virtual string Color { get; set; }
    }

    public partial class PBL_SwitchOnPositions
    {
        ///<summary>
        ///List of position identifying LED locations
        ///</summary>
        [ApiMember(Description="List of position identifying LED locations", IsRequired=true)]
        public virtual List<string> Positions { get; set; } = [];

        ///<summary>
        ///Optional: Animated effect selection: 0 = Always ON (no effect, default), 1 = BLINK_NORMAL, 2 = BLINK_FAST, 3 = BLINK_SLOW, 4 = FADE_IN_OUT_NORMAL, 5 = FADE_IN_OUT_FAST, 6 = FADE_IN_OUT_SLOW, 7 = FADE_OUT_NORMAL, 8 = FADE_OUT_FAST, 9 = FADE_OUT_SLOW
        ///</summary>
        [ApiMember(Description="Optional: Animated effect selection: 0 = Always ON (no effect, default), 1 = BLINK_NORMAL, 2 = BLINK_FAST, 3 = BLINK_SLOW, 4 = FADE_IN_OUT_NORMAL, 5 = FADE_IN_OUT_FAST, 6 = FADE_IN_OUT_SLOW, 7 = FADE_OUT_NORMAL, 8 = FADE_OUT_FAST, 9 = FADE_OUT_SLOW")]
        public virtual int? Effect { get; set; }

        ///<summary>
        ///Optional: HTML Color code (e.g. FF00FF)
        ///</summary>
        [ApiMember(Description="Optional: HTML Color code (e.g. FF00FF)")]
        public virtual string Color { get; set; }

        ///<summary>
        ///Optional: When set to true, it turns off the same color in a previous position
        ///</summary>
        [ApiMember(Description="Optional: When set to true, it turns off the same color in a previous position")]
        public virtual bool? HidePreviousPosition { 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")]
        public virtual string Owner { get; set; }
    }

}

C# PBL_SwitchOnPositions 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 /PBL_SwitchOnPositions HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PBL_SwitchOnPositions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
  <Color>String</Color>
  <Effect>0</Effect>
  <HidePreviousPosition>false</HidePreviousPosition>
  <Owner>String</Owner>
  <Positions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Positions>
</PBL_SwitchOnPositions>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PBL_StandardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
  <Color>String</Color>
  <Error>String</Error>
  <Result />
  <Success>false</Success>
</PBL_StandardResponse>