API query syntax documentation

mysociety / alaveteli

Provide a Freedom of Information request system for your jurisdiction

https://alaveteli.org

Other

389 stars 195 forks source link

API query syntax documentation #5916

Closed monty241 closed 4 years ago

monty241 commented 4 years ago

We are in the process of adding an Invantive SQL connector on Alaveteli. In that process, we translate SQL into associated API calls.

The developer API URL helped us discover that APIs are probably widely available, but we are struggling to find documentation on the query syntax such as:

https://www.wob-knop.nl/feed/search/%20(variety:sent%20OR%20variety:followup_sent%20OR%20variety:response%20OR%20variety:comment).json

Where can the API query syntax documentation be found?

garethrees commented 4 years ago

Hi @monty241,

Sounds interesting! The search terms are available on https://www.wob-knop.nl/advancedsearch.

Best place for questions like these is the alaveteli-dev mailing list. Please do follow up there if you have any questions, or even just to let us know about progress you make!

Good luck!

monty241 commented 4 years ago

Hi @garethrees ,

thanks, found the documentation from your link on https://xapian.org/docs/queryparser.html. That should be sufficient.

Rgds