OpenRosa Endpoints

OpenRosa Form Manifest API

Changed on

(introduced: version 0.2)

This is the fully standards-compliant implementation of the OpenRosa Form Manifest API. We will not attempt to redocument the standard here.

A Manifest document is available at this resource path for any form in the system. However:

  • A link to this document will not be given in the Form Listing API unless we expect the form to have media or data file attachments based on the XForms definition of the form.

  • The Manifest will only output information for files the server actually has in its possession. Any missing expected files will be omitted, as we cannot provide a hash or downloadUrl for them.

  • For Attachments that are linked to a Dataset, the value of hash is an MD5 sum derived from the last updated timestamp of the Dataset. It is not the MD5 sum for the content of the Dataset CSV file.

Offline Entities support:

  • If an attachment is linked to a Dataset, then type="entityList" attribute is added to the mediaFile element. If the Dataset requires approval of Submission to create new Entity then type="approvalEntityList" is added instead.

  • integrityUrl is also returned for the attachments that are linked to a Dataset.

get/v1/projects/{projectId}/forms/{xmlFormId}/manifest

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/projects/{projectId}/forms/{xmlFormId}/manifest
  • Auth
    none declared

Path parameters

projectIdnumber required

The numeric ID of the Project

xmlFormIdstring required

The xmlFormId of the Form being referenced.

Headers

X-OpenRosa-Versionstring

e.g. 1.0

Response

OK

Changes