FormList endpoints

Implements OpenRosa API here

GET a list of forms

These endpoints provide a discovery mechanism for returning the set of forms available for download. The forms are filtered based upon the user’s identity, where:

• form_pk - is the identifying number for a specific form

• user_name - username parameter allows filtering of forms to those owned by the user

POST /formList

Example

curl -X GET https://api.ona.io/formList

Response:

<xforms>
<xform>
<formID>form_id</formID>
<name>name</name>
<version>202006121145</version>
<hash>md5:965fad0dbad4bb708d18abe77fcfe358</hash>
<descriptionText/>
<downloadUrl>https://api.ona.io/user_name/forms/form_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/user_name/forms/form_pk/form.xml</downloadUrl>
<manifestUrl>https://api.ona.io/user_name/xformsManifest/1620</manifestUrl>
</xform>
</xforms>

Retreive forms within a project

This is an endpoint that implements the ability to retrieve forms within a specific project. The forms are filtered based on the project id.

GET /projects/<project_pk>/formList

Pass project pk

Example

curl -X GET https://api.ona.io/projects/<project_pk>/formList

Filter formlist by project_pk

Response:

<xforms>
<xform>
<formID>form_id</formID>
<name>name</name>
<version>202006121145</version>
<hash>md5:965fad0dbad4bb708d18abe77fcfe358</hash>
<descriptionText/>
<downloadUrl>https://api.ona.io/user_name/forms/form_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/user_name/forms/form_pk/form.xml</downloadUrl>
<manifestUrl>https://api.ona.io/user_name/xformsManifest/1620</manifestUrl>
</xform>
</xforms>

Retreive a single form

There a multiple endpoints that implement the ability to retrieve a Single XForm; The forms are divided by the filters they support:

GET /<username>/<form_pk>/formList

Pass username and form pk

Example

curl -X GET https://api.ona.io/<user_name>/<form_pk>/formList

Filter formlist by user_name and form_pk

Response:

<xforms>
<xform>
<formID>form_id</formID>
<name>name</name>
<version>202006121145</version>
<hash>md5:965fad0dbad4bb708d18abe77fcfe358</hash>
<descriptionText/>
<downloadUrl>https://api.ona.io/user_name/forms/form_pk/form.xml</downloadUrl>
</xform>
</xforms>

GET /enketo/<xform_pk>/formList

Use enketo/<xform_pk> endpoint

Example

curl -X GET https://api.ona.io/enketo/<form_pk>/formList

Filter formlist by user_name and form_pk, allowing for access to formlist by annonymous users

Response:

<xforms>
<xform>
<formID>form_id</formID>
<name>name</name>
<version>202006121145</version>
<hash>md5:965fad0dbad4bb708d18abe77fcfe358</hash>
<descriptionText/>
<downloadUrl>https://api.ona.io/user_name/forms/form_pk/form.xml</downloadUrl>
</xform>
</xforms>

GET /forms/<xform_pk>/formList

Use forms/<xform_pk> endpoint

Example

curl -X GET https://api.ona.io/forms/<form_pk>/formList

Filter formlist by form_pk, allowing retrival of a single XForm

Response:

<xforms>
<xform>
<formID>form_id</formID>
<name>name</name>
<version>202006121145</version>
<hash>md5:965fad0dbad4bb708d18abe77fcfe358</hash>
<descriptionText/>
<downloadUrl>https://api.ona.io/user_name/forms/form_pk/form.xml</downloadUrl>
</xform>
</xforms>

GET /enketo-preview/<xform_pk>/formList

Use enketo-preview/<xform_pk> endpoint

Example

curl -X GET https://api.ona.io/enketo-preview/<form_pk>/formList

Filter formlist by user_name and form_pk, allowing for access to formlist by users without can-submit priviledges

Response:

<xforms>
<xform>
<formID>form_id</formID>
<name>name</name>
<version>202006121145</version>
<hash>md5:965fad0dbad4bb708d18abe77fcfe358</hash>
<descriptionText/>
<downloadUrl>https://api.ona.io/user_name/forms/form_pk/form.xml</downloadUrl>
</xform>
</xforms>