Les paramètres

Méthode GET

Pour la publication ou la recherche de ressources, les paramètres doivent être fourni dans l’url (URI).

Types

Type

Description

string

chaîne de caractères

datetime

chaîne de caractères au format yyy-mm-ddThh:mm:ss

string[]

liste de chaînes de caractères séparé par des virgules

int[]

liste d’entier séparé par des virgules

Pour les paramètres de types tableau, on peut aussi répéter le paramètre: p[]=v1&p[]=v2 mais cette syntaxe est plus longue que p=v1,v2.

Méthodes PUT, POST et DELETE

Pour ces 3 méthodes, généralement un seul paramètre est attendu: la ressource à insérer, modifier ou supprimer.

L’objet doit être transmis en tant que contenu (payload) de la requête HTTP et au format json hydrométrie. On peut aussi transmettre l’objet au format xml hydrométrie en spécifiant dans l’url format=xml.

Chaque contenu fait l’objet d’une validation par un schéma json spécifique à chaque web-service.

Des paramètres supplémentaires peuvent ou doivent être fournis dans l’url pour certains web-services.

Format de sortie

On peut spécifier un format de sortie avec le paramètre format:

  • du json hydrométrie qui reprend les balises officiels du scénario d’échanges hydrométrie ;

  • du xml Sandre Hydrométrie V2 ;

Par défaut, la réponse sera en json.