API documentation - surveys

akvo / akvo-flow

A data collection and monitoring tool that works anywhere.

http://akvo.org/products/akvoflow/

GNU Affero General Public License v3.0

65 stars 31 forks source link

API documentation - surveys #910

Closed JordenVerwer closed 8 years ago

JordenVerwer commented 9 years ago

I'm trying to get the Akvo Flow API to work based on the documentation on this wiki. However, the wiki seems to be out of sync with the version I'm using right now. I've grouped the discrepancies by API endpoint. This one covers surveys.

The fields "status" and "questionGroupList" aren't mentioned here, but they do show up in API responses.
The field "sector" does not have a type.
The field "sourceId" does not have a type.
The field "instanceCount" does not have a type.

janagombitova commented 8 years ago

With refactoring Flow code we will be improving the API available to users and we need to make sure documentation will be properly updated as well. For now closing this issue.

akvo/akvo-product-design#182