Go-to-Light Service 3.1.1.1547 - 97 - API License to GTL Cloud

<back to all web services

HidePositionsStartingWith

Requires Authentication
The following routes are available for this service:
All Verbs/HidePositionsStartingWith/{StartOfKey}/{Color}
HidePositionsStartingWith Parameters:
NameParameterData TypeRequiredDescription
StartOfKeypathstringYesStarting element of a key identifying a location
ColorpathstringYesHTML Color code (e.g. FF00FF)
Delayqueryint?NoOptional: delay the execution of the command (in seconds)
StockroomNamequerystringNoOptional: name of the stockroom where to hide the position
OwnerquerystringNoOptional: name of the owner of the color/command to allow color sharing

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 /HidePositionsStartingWith/{StartOfKey}/{Color} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	StartOfKey: String,
	Color: String,
	Delay: 0,
	StockroomName: String,
	Owner: String
}