mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-04 11:55:50 +00:00
Merge pull request #1675 from XRPLF/ledger_entry1580
Add nft_page option
This commit is contained in:
@@ -231,6 +231,17 @@ Request('ledger_entry - DirectoryNode', {
|
||||
}
|
||||
})
|
||||
|
||||
Request('ledger_entry - NFT Page', {
|
||||
description: "Returns an NFT Page object in its raw ledger format.",
|
||||
link: "ledger_entry.html#get-nft-page",
|
||||
body: {
|
||||
"id": "example_get_nft_page",
|
||||
"command": "ledger_entry",
|
||||
"nft_page": "255DD86DDF59D778081A06D02701E9B2C9F4F01DFFFFFFFFFFFFFFFFFFFFFFFF",
|
||||
"ledger_index": "validated"
|
||||
}
|
||||
})
|
||||
|
||||
Request('ledger_entry - Offer', {
|
||||
description: "Returns an Offer object in its raw ledger format.",
|
||||
link: "ledger_entry.html#get-offer-object",
|
||||
|
||||
@@ -40,6 +40,7 @@ In addition to the general fields above, you must specify *exactly 1* of the fol
|
||||
- [`payment_channel`](#get-paychannel-object)
|
||||
- [`deposit_preauth`](#get-depositpreauth-object)
|
||||
- [`ticket`](#get-ticket-object)
|
||||
- [`nft_page`](#get-nft-page)
|
||||
|
||||
**Caution:** If you specify more than 1 of these type-specific fields in a request, the server retrieves results for only 1 of them. It is not defined which one the server chooses, so you should avoid doing this.
|
||||
|
||||
@@ -627,6 +628,48 @@ rippled json ledger_entry '{ "ticket": { "account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJ
|
||||
[Try it! >](websocket-api-tool.html#ledger_entry-ticket)
|
||||
|
||||
|
||||
### Get NFT Page
|
||||
|
||||
Return an NFT Page in its raw ledger format.
|
||||
|
||||
| `Field` | Type | Description |
|
||||
|:------------------------|:---------------------------|:----------------------|
|
||||
| `nft_page` | String | The [object ID](ledger-object-ids.html) of an [NFT Page](nftokenpage.html) to retrieve. |
|
||||
|
||||
<!-- MULTICODE_BLOCK_START -->
|
||||
|
||||
*WebSocket*
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "example_get_nft_page",
|
||||
"command": "ledger_entry",
|
||||
"nft_page": "255DD86DDF59D778081A06D02701E9B2C9F4F01DFFFFFFFFFFFFFFFFFFFFFFFF",
|
||||
"ledger_index": "validated"
|
||||
}
|
||||
```
|
||||
|
||||
*JSON-RPC*
|
||||
|
||||
```json
|
||||
{
|
||||
"method": "ledger_entry",
|
||||
"params": [{
|
||||
"nft_page": "255DD86DDF59D778081A06D02701E9B2C9F4F01DFFFFFFFFFFFFFFFFFFFFFFFF",
|
||||
"ledger_index": "validated"
|
||||
}]
|
||||
}
|
||||
```
|
||||
|
||||
*Commandline*
|
||||
|
||||
```sh
|
||||
rippled json ledger_entry '{ "nft_page": "255DD86DDF59D778081A06D02701E9B2C9F4F01DFFFFFFFFFFFFFFFFFFFFFFFF", "ledger_index": "validated" }'
|
||||
```
|
||||
|
||||
<!-- MULTICODE_BLOCK_END -->
|
||||
|
||||
[Try it! >](websocket-api-tool.html#ledger_entry-nft-page)
|
||||
|
||||
## Response Format
|
||||
|
||||
|
||||
Reference in New Issue
Block a user