FANDOM


The RPC structures comply with the standards defined in the JSON-RPC 2.0 specification.

Requests Edit

{
    "jsonrpc": <String>
    "method":  <String>
    "params":  [Optional] <Object>
    "id":      <Object>
}
Member Description
jsonrpc A string specifying the version of the JSON-RPC protocol. Must be exactly "2.0".
method A string containing the name of the method to be invoked.
params A structured value that holds the parameter values to be used during the invocation of the method.
id An identifier established by the client that must contain a string, number, or null value if included. If it is not included it is assumed to be a notification. The value should normally not be null, and numbers should not contain fractional parts.

Responses Edit

{
    "jsonrpc": <String>
    "result":  [Optional] <Object>
    "error":   [Optional] <TypeError>
    "id":      <Object>
}
Member Description
jsonrpc A string specifying the version of the JSON-RPC protocol. Must be exactly "2.0".
result This member is required to exist on success, and mustn't exist if there was an error invoking the method.

The value of this member is determined by the method invoked on the server.

error This member is required to exist on error, and mustn't exist if there was no error triggered during invocation.
id An identifier which has the value of the id member in the corresponding request object.

TypeError:

{
    "code":    <Int32>
    "message": <String>
    "data":    [Optional] <Object>
}
Member Description
code A number that indicates the error type that occurred.
message A string providing a short description of the error.
data A primitive or structured value that contains additional information about the error.

Default error codes Edit

Error codes 0-9 are preserved for generalization purposes.

Code Message
0 Success
1 Unknown error
2 The RPC is busy.

Ad blocker interference detected!


Wikia is a free-to-use site that makes money from advertising. We have a modified experience for viewers using ad blockers

Wikia is not accessible if you’ve made further modifications. Remove the custom ad blocker rule(s) and the page will load as expected.