OpenRosa Protocol

OpenRosa is a set of communication standards for moving blank forms and completed form instances between server applications (like ODK Central) and clients (like ODK Collect).

They were originally worked on by the OpenRosa WorkGroup, and they were an outgrowth of the JavaRosa project. The working group is no longer active. However, many apps within the ODK ecosystem (including Collect and Central) continue to implement the API.

This set of docs is intended to provide information about the OpenRosa standards, for use by developers working on applications that communicate with other applications within the ODK ecosystem.

OpenRosa 1.0 APIs

OpenRosa 1.0 APIs were formally approved by the OpenRosa Working Group in December of 2011. To be considered "OpenRosa 1.0 Compliant," a system must implement all 5 of the OpenRosa 1.0 APIs.

• Metadata Scheme
  • Blank Form Metadata
  • Completed Form Metadata
  • Defining expected submission metadata in the blank form
  • Examples
• HTTP Requests and Responses
  • HTTP Requests
  • HTTP Responses
• Authentication API
  • Overview
  • Data Security Considerations
  • Typical Interaction
  • Implementation
  • Authentication
• Form Submission API
  • Form Submission
  • Server Response Format
• Form List API
  • Discovery Request
  • Successful Response Document
  • The Manifest Document

Did this page help you?

Selecting an option will open a 1-question survey

👍 Yes 👎 No