API documentation - questions

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 - questions #912

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 survey questions.

The field "dependentQuestionAnswer" does not have a type.
The field "localNameFlag" does not have a type.
The field "requireDoubleEntry" does not have a type.
Many (15) fields show up in the API response without being mentioned here.

muloem commented 9 years ago

@mato74 @jonase The last point in this issue needs looking into. My first test shows that indeed there are extra (undocumented) fields showing up. Regarding the documentation issues for this and the other issues created by @JordenVerwer, we will update it.

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.

https://github.com/akvo/akvo-product-design/issues/182