Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revisionBoth sides next revision
documentation:api-http-websockets [2014-01-15 12:56] – [Command: unsubscribe] nkukarddocumentation:api-http-websockets [2014-01-15 13:26] – [HTTP WebSockets Interface] 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 =====