mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-22 20:55:50 +00:00
70 lines
972 B
Markdown
70 lines
972 B
Markdown
## method_name ##
|
|
[[Source]<br>](https://github.com/ripple/source_code/for_your_method/if_available "Source")
|
|
|
|
blurb
|
|
|
|
#### Request Format ####
|
|
|
|
<div class='multicode'>
|
|
|
|
*REST*
|
|
|
|
```
|
|
|
|
```
|
|
|
|
</div>
|
|
|
|
[Try it! >](your-api-tool.html#method_name)
|
|
|
|
|
|
##### URL Parameters #####
|
|
|
|
| Field | Value | Description |
|
|
|-------|-------|-------------|
|
|
|
|
|
|
##### Optional Query Parameters #####
|
|
|
|
| Field | Value | Description |
|
|
|-------|-------|-------------|
|
|
|
|
|
|
##### Body Parameters #####
|
|
|
|
| Field | Value | Description |
|
|
|-------|-------|-------------|
|
|
|
|
|
|
Further description
|
|
|
|
#### Response Format ####
|
|
|
|
A successful result uses the HTTP response code **200 OK** and contains a JSON body with the following fields:
|
|
|
|
| Field | Type | Description |
|
|
|-------|------|-------------|
|
|
|
|
|
|
#### Example ####
|
|
|
|
Request:
|
|
|
|
```
|
|
GET /example/request?params=included
|
|
```
|
|
|
|
Response:
|
|
|
|
```js
|
|
200 OK
|
|
{
|
|
//some JSON here
|
|
}
|
|
```
|
|
|
|
#### Errors ####
|
|
|
|
* **error_code** - The problem exists between keyboard and chair
|
|
|