'; ';
  • Accueil
  •  > 
  • Les commandes de l’API
<

Les commandes de l’API

Accès aux métadonnées

Vous pouvez consulter l’ensemble des métadonnées simplement par les services web suivants :


Exemple :

Retourne toutes les bases de données accessibles.

Paramètre Obligatoire Description
key Oui clé d’accès à l’API.
format Non permet de préciser le format de retour (xml ou json). Si ce paramètre n’est pas précisé, le résultat sera exposé en xml.

Exemple :

Retourne toutes les tables d’une base de données précise.

Paramètre Obligatoire Description
db Oui précise la base de données à scruter.
key Oui clé d’accès à l’API.
format Non permet de préciser le format de retour (xml ou json). Si ce paramètre n’est pas précisé, le résultat sera exposé en xml.

Exemple :

Retourne toutes les métadonnées d’une base de données précise.

Paramètre Obligatoire Description
db Oui précise la base de données à scruter.
key Oui clé d’accès à l’API.
format Non permet de préciser le format de retour (xml ou json). Si ce paramètre n’est pas précisé, le résultat sera exposé en xml.

Retourne toutes les métadonnées d’une table précise.

Paramètre Obligatoire Description
db Oui précise la base de données à scruter.
table Oui indique la table source des métadonnées.
key Oui clé d’accès à l’API.
format Non permet de préciser le format de retour (xml ou json). Si ce paramètre n’est pas précisé, le résultat sera exposé en xml.

Accès générique aux données


Retourne les enregistrements d’une table.

Paramètre Obligatoire Description
db Oui précise la base de données à scruter.
table Oui table de provenance des données.
limit Non limite le nombre d’enregistrement en sortie. La valeur par défaut est fixée à 5000.
offset Non fonctionne de paire avec le paramètre "limit" et indique le numéro de départ d’extraction des données. La valeur par défaut est de 100.
filter Non option de filtrage de la requête. Si rien n’est précisé, toutes les données sont retournées.
orderby Non clause de tri (nom du champ de tri).
key Oui clé d’accès à l’API.
format Non permet de préciser le format de retour (xml ou json). Si ce paramètre n’est pas précisé, le résultat sera exposé en xml.

Retourne le nombre d’enregistrements d’une requête.

Paramètre Obligatoire Description
db Oui précise la base de données à scruter.
table Oui table de provenance des données.
filter Non option de filtrage de la requête. Si rien n’est précisé, toutes les données sont retournées.
key Oui clé d’accès à l’API.
format Non permet de préciser le format de retour (xml ou json). Si ce paramètre n’est pas précisé, le résultat sera exposé en xml.

Opérateurs de filtrage des données

Pour affiner une requête, il est possible de recourir au paramètre filter sur la commande getdata et getrecordcount.

Il est possible d’ajouter plusieurs opérations de filtrage, séparées par and ou or.

Voici un descriptif des opérateurs.

Opérateur Description Exemple d’utilisation
equalto le champ est égal à la valeur suivante http://www.opendata.larochelle.fr/w...
notequalto le champ est différent de la valeur suivante http://www.opendata.larochelle.fr/w...
like le champ est comparé partiellement http://www.opendata.larochelle.fr/w...
greaterthan le champ est superieur à valeur suivante (champ de type numérique) http://www.opendata.larochelle.fr/w...
greaterthanorequalto le champ est supérieur ou égal à la valeur suivante (champ de type numérique) http://www.opendata.larochelle.fr/w...
lessthan le champ est inférieur à valeur suivante (champ de type numérique) http://www.opendata.larochelle.fr/w...
lessthanorequalto le champ est inférieur ou égal à la valeur suivante (champ de type numérique) http://www.opendata.larochelle.fr/w...

Exemple :