Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
Last revisionBoth sides next revision
documentation:api-http-websockets [2014-01-15 12:55] – [Command: subscribe] nkukarddocumentation:api-http-websockets [2014-01-16 15:36] – nkukard
Line 1: Line 1:
 ====== HTTP WebSockets Interface ====== ====== HTTP WebSockets Interface ======
  
 +===== JSON Encapsulation =====
 +
 +All JSON responses are encapsulated within a status structure.
 +
 +Success:
 +<code>
 +{
 +  status: 'success',
 +  data: $data
 +}
 +</code>
 +
 +Errors:
 +<code>
 +{
 +  status: 'error',
 +  message: 'error string'
 +}
 +</code>
 ===== Command Interface ===== ===== Command Interface =====
  
Line 20: Line 39:
 ==== Command: subscribe ==== ==== Command: subscribe ====
  
-The subscribe command subscribes a WebSocket to receive periodic statistical updates. The $tag value will be used while streaming statistics (see [[api-data-types#typeotsstreamedjsonstats|OTSStreamedJsonStats]]).+The subscribe command subscribes a WebSocket to receive periodic statistical updates. The $tag value will be used while streaming statistics (see [[api-data-types#typeotsjsonstats|OTSJsonStats]]).
  
 Command format: Command format:
 <code> <code>
-$tag SUBSCRIBE <type=$item> [type2=$item2] [typeX=$itemX]+$tag SUBSCRIBE <$type=$item> [$type2=$item2] [$typeX=$itemX]
 </code> </code>
 +
 +The value for tag:
 +  * The value for tag designates the tag of returned data in the above datatype.
  
 Possible values for type: Possible values for type:
Line 41: Line 63:
 ==== Command: unsubscribe ==== ==== Command: unsubscribe ====
  
-Syntax: unsubscribe <tag>+WIP
  
 +Command format:
 +<code>
 +$tag UNSUBSCRIBE
 +</code>