doc: document new features of the forms API (#7113, #7114, #7115)

This commit is contained in:
Frédéric Péters 2015-04-30 19:26:22 +02:00
parent c173fd8854
commit 594c6db59d
1 changed files with 26 additions and 0 deletions

View File

@ -158,6 +158,32 @@ demandes non terminées (pending) :
<output style="prompt">$ </output><input>curl -H "Accept: application/json" \
https://www.example.net/api/forms/inscriptions/list?filter=pending</input>
</screen>
<p>
Il est également possible de filtrer sur le contenu des formulaires, à partir
des champs associés à un nom de variable et de type « Liste ». Par exemple sur
un champ « Type » (nom de variable <code>type</code>) dont une des valeurs
possibles est « gratuit » :
</p>
<screen>
<output style="prompt">$ </output><input>curl -H "Accept: application/json" \
https://www.example.net/api/forms/inscriptions/list?filter-type=gratuit</input>
</screen>
<p>
Afin de faciliter certains traitements <em>batch</em>, il est possible de
demander que l'ensemble des données associées aux formulaires soient
retourné, plutôt qu'un jeu réduit adapté aux systèmes de synchronisation.
Pour ce faire, il suffit de passer un paramètre <code>full=on</code> dans
l'adresse.
</p>
<screen>
<output style="prompt">$ </output><input>curl -H "Accept: application/json" \
https://www.example.net/api/forms/inscriptions/list?full=on</input>
</screen>
</section>