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

[DOC] REST - reflect where client resource ID and transaction ID are interchangeable

Browse Source
This commit is contained in:
mDuo13
2014-11-06 16:19:40 -08:00
parent 69ff7d2b77
commit 7aab439c38
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
content/ripplerest_api.md
View File

@@ -20,7 +20,7 @@ Installation instructions and source code can be found in the [Ripple-REST repos
* [Prepare Payment - `GET /v1/accounts/{:address}/payments/paths`](#prepare-payment) * [Prepare Payment - `GET /v1/accounts/{:address}/payments/paths`](#prepare-payment)
* [Submit Payment - `POST /v1/accounts/{:address}/payments`](#submit-payment) * [Submit Payment - `POST /v1/accounts/{:address}/payments`](#submit-payment)
* [Confirm Payment - `GET /v1/accounts/{:address}/payments/{:payment}`](#confirm-payment) * [Confirm Payment - `GET /v1/accounts/{:address}/payments/{:id}`](#confirm-payment)
* [Get Payment History - `GET /v1/accounts/{:address}/payments`](#get-payment-history) * [Get Payment History - `GET /v1/accounts/{:address}/payments`](#get-payment-history)
#### Trustlines #### #### Trustlines ####
@@ -30,7 +30,7 @@ Installation instructions and source code can be found in the [Ripple-REST repos
#### Notifications #### #### Notifications ####
* [Check Notifications - `GET /v1/accounts/{:address}/notifications/{:transaction_hash}`](#check-notifications) * [Check Notifications - `GET /v1/accounts/{:address}/notifications/{:id}`](#check-notifications)
#### Status #### #### Status ####
@@ -39,7 +39,7 @@ Installation instructions and source code can be found in the [Ripple-REST repos
#### Utilities #### #### Utilities ####
* [Retrieve Ripple Transaction - `GET /v1/transactions/{:transaction-hash}`](#retrieve-ripple-transaction) * [Retrieve Ripple Transaction - `GET /v1/transactions/{:id}`](#retrieve-ripple-transaction)
* [Generate UUID - `GET /v1/uuid`](#create-client-resource-id) * [Generate UUID - `GET /v1/uuid`](#create-client-resource-id)
@@ -1414,7 +1414,7 @@ Get a notification for the specific transaction hash, along with links to previo
*REST* *REST*
``` ```
GET /v1/accounts/{:address}/notifications/{:transaction_hash} GET /v1/accounts/{:address}/notifications/{:id}
``` ```
</div> </div>
@@ -1425,7 +1425,7 @@ The following URL parameters are required by this API endpoint:
| Field | Value | Description | | Field | Value | Description |
|-------|-------|-------------| |-------|-------|-------------|
| address | String | The Ripple account address of an account involved in the transaction. | | address | String | The Ripple account address of an account involved in the transaction. |
| hash | String | A unique hash identifying the Ripple transaction that this notification describes | | id | String | A unique identifier for the transaction this notification describes -- either a client resource ID or a Ripple transaction hash |
You can find a transaction `hash` in a few places: You can find a transaction `hash` in a few places:
@@ -1593,7 +1593,7 @@ Returns a Ripple transaction, in its complete, original format.
*REST* *REST*
``` ```
GET /v1/transactions/{:transaction_hash} GET /v1/transactions/{:id}
``` ```
</div> </div>
@@ -1603,7 +1603,7 @@ The following URL parameters are required by this API endpoint:
| Field | Value | Description | | Field | Value | Description |
|-------|-------|-------------| |-------|-------|-------------|
| hash | String | A unique hash identifying the Ripple transaction to retrieve | | hash | String | A unique identifier for the Ripple transaction to retrieve -- either a client resource ID or a Ripple transaction hash. |
#### Response #### #### Response ####