Required role: | admin |
All Verbs | /DefineAreas/{Areas} |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Areas | path | Area[] | Yes | Areas |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AreaID | form | int | No | |
Label | form | string | No | |
StockroomID | form | long? | No | |
Content | form | List<AreaContent> | No | |
NumberOfPixels | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ID | form | int | No | |
LCAddress | form | string | No | |
PixelStart | form | int | No | |
PixelStop | form | int | No | |
AreaID | form | int | No | |
Pos | form | int | No | |
Reverse | form | bool | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
]
}