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}

export class AreaContent
{
    public ID: number;
    public LCAddress: string;
    public PixelStart: number;
    public PixelStop: number;
    public AreaID: number;
    public Pos: number;
    public Reverse: boolean;

    public constructor(init?: Partial<AreaContent>) { (Object as any).assign(this, init); }
}

export class Area
{
    public AreaID: number;
    public Label: string;
    public StockroomID?: number;
    public Content: AreaContent[] = [];
    public NumberOfPixels: number;

    public constructor(init?: Partial<Area>) { (Object as any).assign(this, init); }
}

export class DefineAreas
{
    /** @description Areas */
    // @ApiMember(Description="Areas", IsRequired=true)
    public Areas: Area[] = [];

    public constructor(init?: Partial<DefineAreas>) { (Object as any).assign(this, init); }
}

TypeScript 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
		}
	]
}