Afin de vous aider dans vos premiers pas avec le service web, voici un petit mémo des techniques utilisés dans ce tutoriel.
|
|
|
|
|
Paramètre(s) de la méthode |
|
|
|
|---|---|---|---|---|---|---|---|---|
|
REST |
|
Méthode |
|
url |
resource |
id |
xml |
C |
POST |
|
add |
|
X |
X |
|
X |
R |
GET |
|
get |
|
X |
X |
X |
|
U |
UPDATE |
|
edit |
|
X |
X |
X |
X |
D |
DELETE |
|
delete |
|
X |
X |
X |
|
Si le paramètre url "est" spécifié, aucun autre paramètre ne peut être utilisé et vice versa.
Les options ne fonctionne que pour la récupération d'une liste d'élément,
Exemple :
/api/products/?filter...
/api/products/1?filter...
Clé |
Suffixe de clé |
|
préfixe |
Valeur |
Suffixe |
Description |
|---|---|---|---|---|---|---|
display |
|
|
|
[champ1,champ2 …] |
|
N'afficher que les champs entre crochet, fonctionne également pour les association |
display |
|
|
|
full |
|
Afficher tous les champs |
Clé |
Suffixe de clé |
|
préfixe |
Valeur |
Suffixe |
Description |
|---|---|---|---|---|---|---|
filter |
[champ] |
|
! |
[valeur] |
|
Exclu les valeurs entre crochet |
filter |
[champ] |
|
< |
[valeur] |
|
Filtrer par valeurs inférieures à la valeur entre crochet |
filter |
[champ] |
|
> |
[valeur] |
|
Filtrer par valeurs supérieures à la valeur entre crochet |
filter |
[champ] |
|
|
[valeur] |
|
Filtrer champ par la valeur "valeur" |
filter |
[champ] |
|
|
[valeur1,valeur2…] |
|
Filtrer champ pour les valeurs spécifiées entre crochet |
filter |
[champ] |
|
% |
[valeur] |
% |
Filtrer "colonne" pour les valeurs contenant "valeur" |
Clé |
Suffixe de clé |
|
préfixe |
Valeur |
Suffixe |
Description |
|---|---|---|---|---|---|---|
sort |
|
|
|
[champ1_ASC,champ2_DESC,champ3_ASC] |
|
Trier par champ avec le suffixe _ASC ou _DESC selon l'ordre souhaité |
sort |
|
|
|
full |
|
Afficher tous les champs |
Clé |
Suffixe de clé |
|
préfixe |
Valeur |
Suffixe |
Description |
|---|---|---|---|---|---|---|
limit |
|
|
|
Nombre |
|
Limiter le résultat à "Nombre" |
limit |
|
|
|
Index de départ, Nombre |
|
Limiter le résultat à "Nombre" à partir de "Index" |
L'utilisation des images se fait via un paramètre nommé "image".