Common Parameter Description¶
The following table describes the common parameters used in the request and response messages.
Parameter |
Type |
Mandatory/Optional |
Description |
|---|---|---|---|
id |
String |
Optional |
The message ID. This is a reserved parameter that is reserved for future use. |
version |
String |
Mandatory |
The version of the protocol. |
params |
JSON |
Mandatory in request |
The request parameters, in JSON format, which can either be array or dict. |
method |
String |
Mandatory in request |
The name of the method. |
code |
Integer |
Mandatory in response |
The return code. |
data |
JSON |
Optional |
The information that is returned. Depending on the return value, it can be in array or dict format. |