Retour des web-services¶
La réponse des web-services est composée d’un statut HTTP, d’en-têtes HTTP et du contenu de la réponse.
Statut de la réponse¶
L’API REST renvoie deux statuts:
200 en l’absence d’erreur ;
400 si un erreur ou plusieurs erreurs ont été soulevées par la PHyC.
En cas d’erreur, la PHyC fournit en réponse un rapport d’erreur au format json ou xml.
D’autres statuts peuvent être renvoyés aux utilisateurs de l’API, par exemple:
si la requête HTTP est mal formée ;
l’API n’est pas accessible ;
le temps de réponse est trop long (réponse générée par un proxy ou un reverse_proxy).
Réponse des web-services¶
Mode synchrone¶
En présence d’erreurs, la PHyC renverra un rapport au format JSON ou XML associé au statut HTTP 400.
En l’absence d’erreur, la PHYC renverra:
un contenu vide en l’absence des ressources demandées;
une ressource soit au format JSON hydrométrie par défaut.
Le web-service peut retourner les ressources ou au format XML hydrométrie Sandre V2 en rajoutant la paramètre format=xml aux paramètres de l’url.
Mode asynchrone¶
En mode asynchrone, la PHyc renverra une réponse JSON contenant deux variables:
idpublication: identifiant de publication;
url: le lien de récupération.