Skip to main content Skip to complementary content

Response object syntax

Overview

The response object follows the JSON-RPC 2.0 specifications and has the following members:

Member Description / Value Mandatory
jsonrpc

Version of JSON-RPC.

Equals 2.0

Yes
id Identifier. This identifier must be identical to the identifier in the request object. Yes

result or

error

The member result is required on success.

In case of failure, the member error is displayed.

Yes
change

Handles of the objects that have been updated.

No
closed Handles that have been released (following a remove for example). No
Information noteSee http://www.jsonrpc.org/specification for more information on the syntax.

Example of response object

A response object could be as follows:

{ "jsonrpc": "2.0", "id": 3, "result": { "qReturn": { "qType": "GenericObject", "qHandle": 5 } }, "change": [ 5 ] }

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!