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

<back to all web services

DefineAreas

Requires Authentication
The following routes are available for this service:
All Verbs/DefineAreas/{Areas}
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 Area
    {
        public virtual int AreaID { get; set; }
        public virtual string Label { get; set; }
        public virtual long? StockroomID { get; set; }
        public virtual List<AreaContent> Content { get; set; } = [];
        public virtual int NumberOfPixels { get; set; }
    }

    public partial class AreaContent
    {
        public virtual int ID { get; set; }
        public virtual string LCAddress { get; set; }
        public virtual int PixelStart { get; set; }
        public virtual int PixelStop { get; set; }
        public virtual int AreaID { get; set; }
        public virtual int Pos { get; set; }
        public virtual bool Reverse { get; set; }
    }

    public partial class DefineAreas
    {
        ///<summary>
        ///Areas
        ///</summary>
        [ApiMember(Description="Areas", IsRequired=true)]
        public virtual Area[] Areas { get; set; } = [];
    }

}

C# DefineAreas 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 /DefineAreas/{Areas} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Areas: 
	[
		{
			AreaID: 0,
			Label: String,
			StockroomID: 0,
			Content: 
			[
				{
					ID: 0,
					LCAddress: String,
					PixelStart: 0,
					PixelStop: 0,
					AreaID: 0,
					Pos: 0,
					Reverse: False
				}
			],
			NumberOfPixels: 1
		}
	]
}