ODK Aggregate API?

Hey,

Quick question, is there any guide to the submission's API? Is there a submission's API? There is the simple json publisher[1], which seems to have little documentation on how to make requests to the Aggregate instance. From what I can gather is that the url to get the API is [2]. Is there a way to request submissions made to a specific form?

[1].https://code.google.com/p/opendatakit/wiki/AggregateToJSonXmlREDCapPublishers
[2].https://opendatakit.appspot.com/view/binaryData?

The form submission and form listing APIs (i.e., the ones used by ODK
Collect) are described here:

https://bitbucket.org/javarosa/javarosa/wiki/OpenRosaAPI

Note that the format of the list of forms returned to the device changes
based upon whether the client conforms to this specification or not. If the
client's request conforms, it returns the list as defined by the spec. For
ease of debugging, that conformant list is also available as a convenience
via the 'xformsList' page on the server, e.g.,
https://opendatakit.appspot.com/xformsList If the client does not supply
the OpenRosa version header field, a different, older, less informative
list is returned, e.g., https://opendatakit.appspot.com/formList

If you want to retrieve data from ODK Aggregate, the ODK Briefcase tool is
designed to do this. It follows the API defined here:
http://code.google.com/p/opendatakit/wiki/BriefcaseAggregateAPI

If you want to write a server to accept data that ODK Aggregate publishes
(pushes) to you as it becomes available, then the link you had,
http://code.google.com/p/opendatakit/wiki/AggregateToJSonXmlREDCapPublishers
describes the data format we send to the receiving server.

The binaryData URL is specific to retrieving audio/video/image attachments
to either the form definition or the submissions. That URL's blobKey
argument is an XPath expression that selects the particular element in the
submission or file in the form definition. Once you un-escape it, it should
be pretty obvious how it is structured.

··· On Wed, Jul 16, 2014 at 7:24 AM, wrote:

Hey,

Quick question, is there any guide to the submission's API? Is there a
submission's API? There is the simple json publisher[1], which seems to
have little documentation on how to make requests to the Aggregate
instance. From what I can gather is that the url to get the API is [2]. Is
there a way to request submissions made to a specific form?

[1].
https://code.google.com/p/opendatakit/wiki/AggregateToJSonXmlREDCapPublishers
[2].https://opendatakit.appspot.com/view/binaryData?

--
You received this message because you are subscribed to the Google Groups
"ODK Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an
email to opendatakit-developers+unsubscribe@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

--
Mitch Sundt
Software Engineer
University of Washington
mitchellsundt@gmail.com

Is there a formUpload API? Can one make a POST request say using curl with
a form to upload an xform to Aggregate? What is likely to be the result of
the request? Will the form_id, (uuid) be returned?

··· On Wednesday, July 16, 2014 1:16:00 PM UTC-4, Mitch wrote: > > The form submission and form listing APIs (i.e., the ones used by ODK > Collect) are described here: > > https://bitbucket.org/javarosa/javarosa/wiki/OpenRosaAPI > > Note that the format of the list of forms returned to the device changes > based upon whether the client conforms to this specification or not. If the > client's request conforms, it returns the list as defined by the spec. For > ease of debugging, that conformant list is also available as a convenience > via the 'xformsList' page on the server, e.g., > https://opendatakit.appspot.com/xformsList If the client does not > supply the OpenRosa version header field, a different, older, less > informative list is returned, e.g., > https://opendatakit.appspot.com/formList > > If you want to retrieve data from ODK Aggregate, the ODK Briefcase tool is > designed to do this. It follows the API defined here: > http://code.google.com/p/opendatakit/wiki/BriefcaseAggregateAPI > > If you want to write a server to accept data that ODK Aggregate publishes > (pushes) to you as it becomes available, then the link you had, > http://code.google.com/p/opendatakit/wiki/AggregateToJSonXmlREDCapPublishers > describes the data format we send to the receiving server. > > The binaryData URL is specific to retrieving audio/video/image attachments > to either the form definition or the submissions. That URL's blobKey > argument is an XPath expression that selects the particular element in the > submission or file in the form definition. Once you un-escape it, it should > be pretty obvious how it is structured. > > > > > On Wed, Jul 16, 2014 at 7:24 AM, <ju...@afrigeo.co.ke > wrote: > >> Hey, >> >> Quick question, is there any guide to the submission's API? Is there a >> submission's API? There is the simple json publisher[1], which seems to >> have little documentation on how to make requests to the Aggregate >> instance. From what I can gather is that the url to get the API is [2]. Is >> there a way to request submissions made to a specific form? >> >> [1]. >> https://code.google.com/p/opendatakit/wiki/AggregateToJSonXmlREDCapPublishers >> [2].https://opendatakit.appspot.com/view/binaryData? >> >> -- >> You received this message because you are subscribed to the Google Groups >> "ODK Developers" group. >> To unsubscribe from this group and stop receiving emails from it, send an >> email to >> For more options, visit https://groups.google.com/d/optout. >> > > > > -- > Mitch Sundt > Software Engineer > University of Washington > mitche...@gmail.com >

RTFM

··· On Thu, Jul 17, 2014 at 9:02 AM, wrote:

Is there a formUpload API? Can one make a POST request say using curl with
a form to upload an xform to Aggregate? What is likely to be the result of
the request? Will the form_id, (uuid) be returned?

On Wednesday, July 16, 2014 1:16:00 PM UTC-4, Mitch wrote:

The form submission and form listing APIs (i.e., the ones used by ODK
Collect) are described here:

https://bitbucket.org/javarosa/javarosa/wiki/OpenRosaAPI

Note that the format of the list of forms returned to the device changes
based upon whether the client conforms to this specification or not. If the
client's request conforms, it returns the list as defined by the spec. For
ease of debugging, that conformant list is also available as a convenience
via the 'xformsList' page on the server, e.g.,
https://opendatakit.appspot.com/xformsList If the client does not
supply the OpenRosa version header field, a different, older, less
informative list is returned, e.g., https://opendatakit.appspot.
com/formList

If you want to retrieve data from ODK Aggregate, the ODK Briefcase tool
is designed to do this. It follows the API defined here:
http://code.google.com/p/opendatakit/wiki/BriefcaseAggregateAPI

If you want to write a server to accept data that ODK Aggregate publishes
(pushes) to you as it becomes available, then the link you had,
http://code.google.com/p/opendatakit/wiki/AggregateToJSonXmlREDCapPublis
hers describes the data format we send to the receiving server.

The binaryData URL is specific to retrieving audio/video/image
attachments to either the form definition or the submissions. That URL's
blobKey argument is an XPath expression that selects the particular element
in the submission or file in the form definition. Once you un-escape it, it
should be pretty obvious how it is structured.

On Wed, Jul 16, 2014 at 7:24 AM, ju...@afrigeo.co.ke wrote:

Hey,

Quick question, is there any guide to the submission's API? Is there a
submission's API? There is the simple json publisher[1], which seems to
have little documentation on how to make requests to the Aggregate
instance. From what I can gather is that the url to get the API is [2]. Is
there a way to request submissions made to a specific form?

[1].https://code.google.com/p/opendatakit/wiki/
AggregateToJSonXmlREDCapPublishers
[2].https://opendatakit.appspot.com/view/binaryData?

--
You received this message because you are subscribed to the Google
Groups "ODK Developers" group.
To unsubscribe from this group and stop receiving emails from it, send
an email to
For more options, visit https://groups.google.com/d/optout.

--
Mitch Sundt
Software Engineer
University of Washington
mitche...@gmail.com

--
You received this message because you are subscribed to the Google Groups
"ODK Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an
email to opendatakit-developers+unsubscribe@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

--
Mitch Sundt
Software Engineer
University of Washington
mitchellsundt@gmail.com