[Filter] klay_unsubscribe

Cancels the subscription with a specific subscription id by using either RPC Pub/Sub over WebSockets or filters over HTTP. Only the connection that created a subscription can unsubscribe from it.

JSONRPC: klay_unsubscribe

Request

application/json

Body

method stringrequired

Default value: klay_unsubscribe

Method name

id int64required

Default value: 1

Request ID, Random or Auto incrementation

jsonrpc stringrequired

Default value: 2.0

JSON-RPC Version (2.0)

params hex[]

A subscription id.

Responses

200

Return true if the subscription was successfully canceled, otherwise false.

application/json

Schema

Schema

jsonrpc stringrequired

Default value: 2.0

id int64required

error

object

code int64required

A Number that indicates the error type that occurred. This MUST be an integer.

| code | message | description | |-----|-----|-------| | -32700 | Parse error | invalid JSON was received by the server. An error occurred on the server while parsing the JSON text. | |-32602 | Invalid params | Invalid method parameter(s). |

message string

A String providing a short description of the error. The message SHOULD be limited to a concise single sentence.

data string

A Primitive or Structured value that contains additional information about the error. This may be omitted. The value of this member is defined by the Server (e.g. detailed error information, nested errors etc.).

result boolean

true if the subscription was successfully canceled, otherwise false.

Example (from schema)

{
  "jsonrpc": "2.0",
  "id": 0,
  "error": {
    "code": -32700,
    "message": "Parse error",
    "data": "string"
  },
  "result": true
}

Loading...