getodk / docs

The documentation for all the ODK tools. This is one of the most popular artifacts our community produces. It's built in Sphinx. ✨📚✨
https://docs.getodk.org/
Other
53 stars 156 forks source link

SUGGESTION Add working examples for ODK Aggregate API to docs #352

Closed florianm closed 4 years ago

florianm commented 6 years ago

Description

Working with the ODK Aggregate API is really useful as it helps to automate recurring tasks. Some working examples of the most used API tasks would be great to have in the docs.

E.g., I'd love to see working examples in Python and R for the following tasks:

Examples in Python and R would be great. API wrapper packages (Python / R) would be even greater and a possible follow-up to working examples. A shared headache is to parse the XML from the ODK API to Python dicts or R tibbles, respectively.

Further wish list - not sure whether API endpoints exist:

Answering my own question:

Edit May 2020. My legacy code reading ODK Aggregate's OpenRosa API is here.

The new ODK Central offers a well-documented API with working examples. ruODK is an ODK Central API client in R.

lognaturel commented 4 years ago

I want to highlight an update from @florianm!

Edit May 2020. My legacy code reading ODK Aggregate's OpenRosa API is here.

The new ODK Central offers a well-documented API with working examples. ruODK is an ODK Central API client in R.

Aggregate is no longer actively developed so I think we can close this issue. Central is its replacement.

@aivernermine I know you deleted your follow-up so hopefully that means you have been able to make progress. In general, support questions are going to get more attention on the forum.