JSP de test

Il existe une JSP permettant de faire des tests sur le module-directory-rest. Elle est accessible par l'URL suivante :

jsp/admin/plugins/directory/modules/rest/TestDirectoryRest.jsp

Note : Pour accéder à cette JSP, il faut être authentifié dans le Back-Office. Il faut également commenter dans le fichier directory-rest.xml les filtres de façon à ce qu'il n'utilise pas la sécurité, sinon une réponse HTTP 401 sera renvoyée.

Syntaxe des URLs

Récupérer les informations d'une ou plusieurs fiches de directory au format XML ou JSON

Syntaxe XML :

• Pour obtenir toutes les fiches d'un annuaire :

http://myhost/mywebapp/rest/directory/{id_directory}/records
ou
http://myhost/mywebapp/rest/directory/{id_directory}/records.xml

• Pour obtenir une fiche :

http://myhost/mywebapp/rest/directory/{id_directory}/record/{id_directory_record}
ou
http://myhost/mywebapp/rest/directory/{id_directory}/record/{id_directory_record}.xml

Syntaxe JSON :

• Pour obtenir toutes les fiches d'un annuaire :

http://myhost/mywebapp/rest/directory/{id_directory}/records.json

• Pour obtenir une fiche :

http://myhost/mywebapp/rest/directory/{id_directory}/record/{id_directory_record}.json

Création/Complétude d'une fiche

Pour créer/compléter une fiche, il faut faire un formulaire de type POST, ayant un enctype multipart/form-data et avoir les paramètres suivants :

http://myhost/mywebapps/rest/directory/record

Mise à jour d'une fiche

Pour mettre à jour une fiche, il faut faire les mêmes opérations que pour la création/complétude d'une fiche à l'exceptio du fait qu'il faut que le header de la requête HTTP doit avoir la méthode PUT.

Suppression d'une fiche

Pour supprimer une fiche, il faut avoir dans le header de la requête HTTP la méthode DELETE et avoir le paramètre suivant :

http://myhost/mywebapps/rest/directory/record