-
Notifications
You must be signed in to change notification settings - Fork 132
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add documentation for formList endpoints
- Loading branch information
1 parent
1dcabba
commit bd59b5a
Showing
2 changed files
with
61 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
FormList endpoints | ||
************************* | ||
|
||
Implements OpenRosa API |FormListAPI| | ||
|
||
.. |FormListAPI| raw:: html | ||
|
||
<a href="https://bitbucket.org/javarosa/javarosa/wiki/FormListAPI" | ||
target="_blank">here</a> | ||
|
||
Discovery Request | ||
----------------- | ||
|
||
.. raw:: html | ||
<pre class="prettyprint"> | ||
<b>POST</b> /formList</pre> | ||
|
||
Example | ||
^^^^^^^ | ||
:: | ||
|
||
curl https://api.ona.io/formList | ||
|
||
Here is an example response from the formlist endpoint | ||
:: | ||
|
||
<xforms> | ||
<xform> | ||
<formID>form_id</formID> | ||
<name>name</name> | ||
<version>202006121145</version> | ||
<hash>md5:965fad0dbad4bb708d18abe77fcfe358</hash> | ||
<descriptionText/> | ||
<downloadUrl>https://api.ona.io/username/forms/pk/form.xml</downloadUrl> | ||
</xform> | ||
<xform> | ||
<formID>testerform</formID> | ||
<name>testerform</name> | ||
<version>201904231241</version> | ||
<hash>md5:a023b3535b7b593de1e9ad075e9e21e6</hash> | ||
<descriptionText/> | ||
<downloadUrl>https://api.ona.io/username/forms/pk/form.xml</downloadUrl> | ||
<manifestUrl>https://api.ona.io/username/xformsManifest/1620</manifestUrl> | ||
</xform> | ||
</xforms> | ||
|
||
|
||
|
||
Get a single form using form's pk | ||
--------------------------------- | ||
|
||
You can get a single form by specifying the form's `pk` in the following ways: | ||
Example | ||
^^^^^^^ | ||
:: | ||
|
||
curl https://stage-api.ona.io/enketo/<form_pk>/formList | ||
curl https://stage-api.ona.io/enketo-preview/<form_pk>/formList | ||
curl https://stage-api.ona.io/<user_name>/<form_pk>/formList | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters