Skip to main content

API Protocol and Messages

Format Description of JSON​

All JSON Request body comprises of two portions – the protocol overhead, and the params.

Protocol Overhead​

The protocol overhead includes ID, and method.

Params​

The params carries the information shared between applications, for the purpose of processing.

Request Structure​

{ 
    "jsonrpc":"2.0", 
    "method":"ledger.admin.request", 
    "params":{ "x":"y" }, 
    "id":"X" 
}
KeysDescription
MethodThe method indicates the actions requested.
ParamsRefers to the Request Parameters sent by the User.

Response Structure​

{ 
    "jsonrpc":"2.0", 
    "result":"XX", 
    "id":"X" 
}

KeysDescription
ResultRefers to the Response Parameters sent in response to User's Request.