Files
xrpl-dev-portal/content/references/rippled-api/api-conventions/response-formatting.ja.md
2019-11-05 23:09:32 -08:00

3.4 KiB
Raw Blame History

応答フォーマット

rippled APIからの応答のフォーマットは、メソッドが呼び出されたインターフェイスWebSocket、JSON-RPC、コマンドラインに応じて多少異なります。コマンドラインインターフェイスがJSON-RPCを呼び出すため、コマンドラインインターフェイスとJSON-RPCインターフェイスは同じフォーマットを使用します。

成功した場合の応答に含まれるフィールドは、以下の通りです。

Field 説明
id (場合により異なる) WebSocketのみこの応答の要求元となった要求で指定されているID。
status 文字列 WebSocketのみ値がsuccessである場合、要求がサーバーによって正常に受信され、理解されたことを示します。
result.status 文字列 JSON-RPCおよびコマンドライン値がsuccessである場合、要求がサーバーによって正常に受信され、理解されたことを示します。
type 文字列 WebSocketのみ値がresponseの場合、コマンドに対する正常な応答であることを示します。非同期の通知では、ledgerClosedtransactionなど異なる値が使用されます。
result オブジェクト クエリーの結果。内容はコマンドによって異なります。

成功した場合の応答の例

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"
   }
}

コマンドライン

{
   "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"
   }
}