ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-11-20 11:45:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

[MERGE] REST docs & tool following pull request #94, including more fixes

Browse Source
This commit is contained in:
mDuo13
2014-11-19 12:32:43 -08:00
parent d6dd6bb0b8 7c2d7b4b70
commit 7d91e17edc
3 changed files with 83 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
content/ripplerest_api.md
View File

@@ -40,6 +40,7 @@ Installation instructions and source code can be found in the [Ripple-REST repos
#### Utilities ####
* [Retrieve Ripple Transaction - `GET /v1/transactions/{:id}`](#retrieve-ripple-transaction)
* [Retrieve Transaction Fee - `GET /v1/transaction-fee`](#retrieve-transaction-fee)
* [Generate UUID - `GET /v1/uuid`](#create-client-resource-id)
@@ -188,7 +189,7 @@ When errors occur, the server returns an HTTP status code in the 400-599 range,
In general, the HTTP status code is indicative of where the problem occurred:
* Codes in the 200-299 range indicate success. (*Note:* This behavior is new in [Ripple-REST v1.3.0](https://github.com/ripple/ripple-rest/releases/tag/v1.3.0-rc4). Previous versions sometimes return 200 OK for some types of errors.)
* Codes in the 200-299 range indicate success. (*Note:* This behavior is new in [Ripple-REST v1.3.0](https://github.com/ripple/ripple-rest/releases/tag/1.3.0). Previous versions sometimes return 200 OK for some types of errors.)
* Unless otherwise specified, methods are expected to return `200 OK` on success.
* Codes in the 400-499 range indicate that the request was invalid or incorrect somehow. For example:
* `400 Bad Request` occurs if the JSON body is malformed. This includes syntax errors as well as when invalid or mutually-exclusive options are selected.
@@ -344,7 +345,7 @@ Submitted transactions can have additional fields reflecting the current status
### Memo Objects ###
(New in [Ripple-REST v1.3.0](https://github.com/ripple/ripple-rest/releases/tag/v1.3.0-rc4))
(New in [Ripple-REST v1.3.0](https://github.com/ripple/ripple-rest/releases/tag/1.3.0))
Memo objects represent arbitrary data that can be included in a transaction. The overall size of the `memos` field cannot exceed 1KB after serialization.
@@ -404,7 +405,7 @@ Accounts are the core unit of authentication in the Ripple Network. Each account
## Generate Wallet ##
(New in [Ripple-REST v1.3.0](https://github.com/ripple/ripple-rest/releases/tag/v1.3.0-rc4))
(New in [Ripple-REST v1.3.0](https://github.com/ripple/ripple-rest/releases/tag/1.3.0))
Randomly generate keys for a potential new Ripple account.
@@ -1842,6 +1843,32 @@ The result is a JSON object, whose `transaction` field has the requested transac
```
## Retrieve Transaction Fee ##
(New in [Ripple-REST v1.3.1](https://github.com/ripple/ripple-rest/releases/tag/1.3.1-rc1))
Retrieve the current transaction fee for the rippled server `ripple-rest` is connected to. If `ripple-rest` is connected to multiple rippled servers, the median fee between the connected servers is calculated.
<div class='multicode'>
*REST*
```
GET /v1/transaction-fee
```
</div>
[Try it! >](rest-api-tool.html#retrieve-transaction-fee)
#### Response ####
```js
{
"success": true,
"fee": "12000"
}
```
## Create Client Resource ID ##