DOCK — Docking station related messages

Docking stations are subtypes of objects and thus exist in the same namespace as all other objects in the server. The messages listed in this section are specific to docking stations and do not apply to other object types.

DOCK-INF - Basic status information of one or more docking stations

A client sends this request to the server to obtain basic status information about one or more docking stations currently known to the server.

Request fields

Name Required? Type Description

ids

yes

list of strings

The list of dock IDs that the client is interested in

Response fields

Name Required? Type Description

status

no

object of DockStatusInfo

Object mapping docking station IDs to the corresponding status information.

error

no

object

Object mapping docking station IDs to reasons why the corresponding status information could not have been retrieved.

All the docking station IDs that were specified in the request MUST appear either in the status list or in the error map.

Example request

{
    "type": "DOCK-INF",
    "ids": ["base", "spam"]
}

Example response

{
    "type": "DOCK-INF",
    "status": {
        "base": {
            "id": "base",
            "position": [519976597, -7406863, 93765],
            "timestamp": "2015-12-08T08:17:41.000Z"
        }
    },
    "error": {
        "spam": "No such dock."
    }
}