Skip to content
Snippets Groups Projects
Commit 195399cc authored by Jean-Paul Calderone's avatar Jean-Paul Calderone
Browse files

document what this branch actually does

parent 17177b8d
No related branches found
No related tags found
1 merge request!13Add a web interface to the storage plugin for initiating PRN redemption
...@@ -32,16 +32,10 @@ If the payment reference number is not known then the response is **NOT FOUND**. ...@@ -32,16 +32,10 @@ If the payment reference number is not known then the response is **NOT FOUND**.
For any payment reference number which has previously been submitted, For any payment reference number which has previously been submitted,
the response is **OK** with an ``application/json`` content-type response body like:: the response is **OK** with an ``application/json`` content-type response body like::
{"stage": <integer>, {"value": <string>}
"of": <integer>,
"stage-name": <string>, The ``value`` property merely indicates the payment reference number which was requested.
"stage-entered-time": <iso8601 timestamp> Further properties will be added to this response in the near future.
}
The ``stage`` property indicates how far into redemption the plugin has proceeded.
The ``of`` property indicates how many steps the process involves in total.
The ``stage-name`` property gives a human-meaningful description of the current stage.
The ``stage-entered-time`` property gives the timestamp for the start of the current staged.
``GET /storage-plugins/privatestorageio-satauthz-v1/payment-reference-number`` ``GET /storage-plugins/privatestorageio-satauthz-v1/payment-reference-number``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment