Creates a new websocket to connect to. A unique ID is generated for this websocket and returned as a WebsocketId document in the call's response body.
Supported HTTP methods: POST, HEAD, OPTIONS
POST /api/v1/makewebsocket
Creates a new websocket to connect to. A unique ID is generated for this websocket and returned as a WebsocketId document in the call's response body.
The WebsocketId is required to open the socket itself and for all subscribe / unsubscribe operations on this websocket. See section Websocket Communication for details about how to open a websocket.
Parameters: none
Return Codes:
| Code | Description |
|---|---|
| 201 | Success, delivers the ID of the created websocket in the response body (data model WebsocketId). |
| 401 | not logged in. In this case a ApiError document is returned, describing details of the error. |