This commit is contained in:
EntireTwix 2021-07-15 13:32:47 -07:00
parent 88b5253e02
commit 93cc7fcadf

View file

@ -15,7 +15,7 @@
## all error responses have JSON string along with them to describe
### Usage endpoints
| name | purpose | json input | path | HTTP Method | correct status | return type | return value | | JSON | A | U |
| name | purpose | json input | path | HTTP Method | correct status | return type | return value | JSON | A | U |
| :------------- | ------------------------------------------------------------------------------ | -------------------------------- | ------------------------------- | :---------: | :------------: | :--------------: | :--------------------------------------------: | :----------------------: | :----------------------: | :----------------------: |
| GetBal | retrieving the balance of a given user, `{name}` | `N/A` | api/v1/user/balance?name={name} | `GET` | 200 | uint32 | the user's balance | :heavy_multiplication_x: | :heavy_multiplication_x: | :heavy_multiplication_x: |
| GetLog | retrieves the logs of a given user, length varies by server configuration | `N/A` | api/v1/user/log | `GET` | 200 | array of objects | [{"to":string, "amount":uint32, "time":int64}] | :heavy_multiplication_x: | :heavy_multiplication_x: | :heavy_check_mark: |