OpenRosa Form Listing API

This is the mostly standards-compliant implementation of the OpenRosa Form Discovery (Listing) API. We will not attempt to redocument the standard here.

The following aspects of the standard are not supported by ODK Central:

• The deviceID may be provided with the request, but it will be ignored.

• The Accept-Language header may be provided with the request, but it will be ignored.

• The ?formID= querystring parameter is not supported and will be ignored.

• The ?verbose querystring parameter is not supported and will be ignored.

• The ?listAllVersions querystring is not supported and will be ignored. Central does not yet support multiple active versions of the same Form.

• No <xforms-group/> will ever be provided, as Central does not yet support this feature.

By default, the given <name/> in the Form Listing response is the friendly name associated with the Form (<title> in the XML and name on the API resource). If no such value can be found, then the xmlFormId will be given as the <name> instead.

A <manifestUrl/> property will be given per <xform> if and only if that form is expected to have media or data file attachments associated with it, based on its XForms definition. It will appear even if no attachments have actually been uploaded to the server to fulfill those expectations.

This resource always requires authentication. If a valid Actor is authenticated at all, a form list will always be returned, filtered by what that Actor is allowed to access.

If you haven't already, please take a look at the HTTP Request API notes above on the required OpenRosa headers.