Commands

DisplayNet commands use a command-line format that extends the SDVoE API. The SDVoE API remains fully available, though a single DisplayNet command often supersedes several SDVoE commands.

A command takes a subcommand and parameters:

<command> [<subcommand>] [<parameters...>]

Every command returns a reply object, and may also trigger events or notifications.

Command Type

Every command page carries a Command Type badge:

Badge	Meaning
DisplayNet	DisplayNet's own command. It has no SDVoE equivalent, or it does substantially more than one.
SDVoE	The command originates in the SDVoE API. DisplayNet accepts it as-is, sometimes adding bookkeeping around it.

The badge says where a command comes from, not how it is called over REST: claim, release, auth and unauth are badged SDVoE yet have DisplayNet REST operations, because DisplayNet wraps them to keep its own records straight.

Each page's REST API section is the authority on how to call that command over HTTP. The command map lists every command and its REST form in one table.

Ask the server what it supports

The help command describes the commands a server accepts, including their subcommands, arguments, and usage. It is generated by the server itself, so it always matches the version you are connected to. help on its own lists every command family; help <command> details one.

A few commands are absent from help; this manual covers them all.

Reply objects

Every reply is a JSON object with the same four keys:

Key	Details
status	SUCCESS, ERROR, PROCESSING, NOTIFICATION, DN_NOTIFICATION, API_INITIALIZED or DN_AUTHENTICATION
request_id	Always null for DisplayNet commands. SDVoE API commands may return a request_id
result	The command's payload, or null
error	An object when status is ERROR, otherwise null

Example

{
   "status":"SUCCESS",
   "request_id":null,
   "result":null,
   "error":null
}