Skip to content

Commit

Permalink
Update Ping to New Style
Browse files Browse the repository at this point in the history
  • Loading branch information
super3 committed Oct 23, 2015
1 parent ceb144b commit 136ccfb
Showing 1 changed file with 11 additions and 15 deletions.
26 changes: 11 additions & 15 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -109,28 +109,24 @@ has gone offline, and that we should not issue more challenges.

GET /api/ping/<bitcoin address>

Success Example:
Example:

::

GET /api/ping/191GVvAaTRxLmz3rW3nU5jAV1rF186VxQc
RESPONSE:
Status Code: 200
Text: Ping accepted.

Fail Examples:

::

GET /api/ping/notvalidaddress
RESPONSE:
Status Code: 400
Text: Ping failed: Invalid Bitcoin address.

GET /api/ping/1EawBV7n7f2wDbgxJfNzo1eHyQ9Gj77oJd
RESPONSE:
Status Code: 404
Text: Ping Failed: Farmer not found.
+-------------+----------------------------+-------------------------------------------------+
| Error Codes | What probably happened | Example |
+=============+============================+=================================================+
| 400 | Invalid Bitcoin address | /api/ping/notvalidaddress |
+-------------+----------------------------+-------------------------------------------------+
| 401 | Bad authentication headers | /api/ping/12guBkWfVjiqBnu5yRdTseBB7wBM5WSWnm |
+-------------+----------------------------+-------------------------------------------------+
| 404 | Farmer not found | /api/ping/1EawBV7n7f2wDbgxJfNzo1eHyQ9Gj77oJd |
+-------------+----------------------------+-------------------------------------------------+


Online Status - JSON
Expand Down

0 comments on commit 136ccfb

Please sign in to comment.