# Does it exist an Aggregate REST interface?

**URL:** <https://forum.getodk.org/t/does-it-exist-an-aggregate-rest-interface/6004>\
**Category:** Development\
**Created:** [October 13, 2016, 4:23pm UTC](https://forum.getodk.org/t/does-it-exist-an-aggregate-rest-interface/6004 "2016-10-13T16:23:47Z")\
**Posts on this page:** 3\
**Page:** 1

<div class="post-metadata">

**Author:** ![Francisco\_J\_Lacueva](https://getodk.b-cdn.net/letter_avatar_proxy/v4/letter/f/3d9bf3/32.png) [@Francisco\_J\_Lacueva](https://forum.getodk.org/u/Francisco_J_Lacueva)\
**Post date:** [October 13, 2016, 4:23pm UTC](https://forum.getodk.org/t/does-it-exist-an-aggregate-rest-interface/6004/1 "2016-10-13T16:23:47Z")

</div>

Hi all,

I'm interesting in creating an REST interface for the providing access to  
some Aggregate server functionalities such as listing available forms,  
downloading forms and uploading data.

Does it exist an already defined API for this?

I read some posts here about the existence of REST API but I think this for  
the ODK 2.0 and it works on the "client" side. If I'm wrong, please, can  
you tell me which are the packages/classes defining the API?

Thanks and best regards.

---

<div class="post-metadata">

**Author:** ![Mitch\_S](https://getodk.b-cdn.net/letter_avatar_proxy/v4/letter/m/3ec8ea/32.png) [@Mitch\_S](https://forum.getodk.org/u/Mitch_S)\
**Post date:** [October 13, 2016, 4:35pm UTC](https://forum.getodk.org/t/does-it-exist-an-aggregate-rest-interface/6004/2 "2016-10-13T16:35:57Z")

</div>

There are APIs for these, as this is required for ODK Briefcase to work.

The APIs used by ODK Collect to list forms, download them, and submit  
filled-in forms are defined by the OpenRosa specification.  
[https://bitbucket.org/javarosa/javarosa/wiki/OpenRosaAPI](https://bitbucket.org/javarosa/javarosa/wiki/OpenRosaAPI) Please note that  
you must set the OpenRosa version header on your requests for these to be  
processed as defined by this spec.  
[https://bitbucket.org/javarosa/javarosa/wiki/OpenRosaRequest](https://bitbucket.org/javarosa/javarosa/wiki/OpenRosaRequest)

The APIs used by ODK Briefcase include the above APIs plus APIs to list the  
filled-in submissions and download them. ODK Briefcase uses the OpenRosa  
APIs for pushing data to the server and for pulling form definitions.  
These APIs are ODK-specific and are described here:

> **[Briefcase Aggregate API](https://github.com/getodk/getodk/wiki/Briefcase-Aggregate-API)**
>
> Wiki and Issues (copied from https://code.google.com/p/opendatakit/) - getodk/getodk

Both of these APIs are in the spirit of a REST interface, but don't have  
the full document structure and hierarchy that one would expect from a REST  
interface. Also, they only support XML request and response bodies. There  
is no JSON equivalent, unlike in many REST interfaces.

> **···**
>
> On Thu, Oct 13, 2016 at 9:23 AM, francisco.jose.lacueva \< francisco.jose.lacueva@gmail.com\> wrote:
> 
> > Hi all,
> > 
> > I'm interesting in creating an REST interface for the providing access to  
> > some Aggregate server functionalities such as listing available forms,  
> > downloading forms and uploading data.
> > 
> > Does it exist an already defined API for this?
> > 
> > I read some posts here about the existence of REST API but I think this  
> > for the ODK 2.0 and it works on the "client" side. If I'm wrong, please,  
> > can you tell me which are the packages/classes defining the API?
> > 
> > Thanks and best regards.
> > 
> > --  
> > 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](mailto:opendatakit-developers+unsubscribe@googlegroups.com).  
> > For more options, visit [https://groups.google.com/d/optout](https://groups.google.com/d/optout).
> 
> --  
> Mitch Sundt  
> Software Engineer  
> University of Washington  
> [mitchellsundt@gmail.com](mailto:mitchellsundt@gmail.com)

---

<div class="post-metadata">

**Author:** ![Francisco\_J\_Lacueva](https://getodk.b-cdn.net/letter_avatar_proxy/v4/letter/f/3d9bf3/32.png) [@Francisco\_J\_Lacueva](https://forum.getodk.org/u/Francisco_J_Lacueva)\
**Post date:** [October 13, 2016, 7:41pm UTC](https://forum.getodk.org/t/does-it-exist-an-aggregate-rest-interface/6004/3 "2016-10-13T19:41:52Z")

</div>

Hanks Mitch,

I'll review the docs you suggest.

BR
