mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-23 05:05:50 +00:00
89 lines
3.0 KiB
Markdown
89 lines
3.0 KiB
Markdown
# Response Formatting
|
|
|
|
Responses from the `rippled` APIs is formatted slightly differently based on whether the method is called with the WebSocket, JSON-RPC, or Commandline interfaces. The Commandline and JSON-RPC interfaces use the same format because the Commandline interface calls JSON-RPC.
|
|
|
|
The fields of a successful response include:
|
|
|
|
| `Field` | Type | Description |
|
|
|:----------------|:---------|:------------------------------------------------|
|
|
| `id` | (Varies) | (WebSocket only) ID provided in the request that prompted this response |
|
|
| `status` | String | (WebSocket only) The value `success` indicates the request was successfully received and understood by the server. |
|
|
| `result.status` | String | (JSON-RPC and Commandline) The value `success` indicates the request was successfully received and understood by the server. |
|
|
| `type` | String | (WebSocket only) The value `response` indicates a successful response to a command. [Asynchronous notifications](subscribe.html) use a different value such as `ledgerClosed` or `transaction`. |
|
|
| `result` | Object | The result of the query; contents vary depending on the command. |
|
|
|
|
|
|
## Example Successful Response
|
|
|
|
<!-- MULTICODE_BLOCK_START -->
|
|
|
|
*WebSocket*
|
|
|
|
```
|
|
{
|
|
"id": 2,
|
|
"status": "success",
|
|
"type": "response",
|
|
"result": {
|
|
"account_data": {
|
|
"Account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
|
|
"Balance": "27389517749",
|
|
"Flags": 0,
|
|
"LedgerEntryType": "AccountRoot",
|
|
"OwnerCount": 18,
|
|
"PreviousTxnID": "B6B410172C0B65575D89E464AF5B99937CC568822929ABF87DA75CBD11911932",
|
|
"PreviousTxnLgrSeq": 6592159,
|
|
"Sequence": 1400,
|
|
"index": "4F83A2CF7E70F77F79A307E6A472BFC2585B806A70833CCD1C26105BAE0D6E05"
|
|
},
|
|
"ledger_index": 6760970
|
|
}
|
|
}
|
|
```
|
|
|
|
*JSON-RPC*
|
|
|
|
```
|
|
HTTP Status: 200 OK
|
|
{
|
|
"result": {
|
|
"account_data": {
|
|
"Account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
|
|
"Balance": "27389517749",
|
|
"Flags": 0,
|
|
"LedgerEntryType": "AccountRoot",
|
|
"OwnerCount": 18,
|
|
"PreviousTxnID": "B6B410172C0B65575D89E464AF5B99937CC568822929ABF87DA75CBD11911932",
|
|
"PreviousTxnLgrSeq": 6592159,
|
|
"Sequence": 1400,
|
|
"index": "4F83A2CF7E70F77F79A307E6A472BFC2585B806A70833CCD1C26105BAE0D6E05"
|
|
},
|
|
"ledger_index": 6761012,
|
|
"status": "success"
|
|
}
|
|
}
|
|
```
|
|
*Commandline*
|
|
|
|
```
|
|
{
|
|
"result": {
|
|
"account_data": {
|
|
"Account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
|
|
"Balance": "27389517749",
|
|
"Flags": 0,
|
|
"LedgerEntryType": "AccountRoot",
|
|
"OwnerCount": 18,
|
|
"PreviousTxnID": "B6B410172C0B65575D89E464AF5B99937CC568822929ABF87DA75CBD11911932",
|
|
"PreviousTxnLgrSeq": 6592159,
|
|
"Sequence": 1400,
|
|
"index": "4F83A2CF7E70F77F79A307E6A472BFC2585B806A70833CCD1C26105BAE0D6E05"
|
|
},
|
|
"ledger_index": 6761012,
|
|
"status": "success"
|
|
}
|
|
}
|
|
```
|
|
|
|
<!-- MULTICODE_BLOCK_END -->
|