Les commandes de l’API

Les commandes disponibles de l’API.

Accès aux métadonnées

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

getBases

https://opendata.larochelle.fr/webservice/?service=getBases

Exemple :
https://opendata.larochelle.fr/webservice/?service=getbases&key=VOTRE_CLE&format=xml

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
mode Non Valeurs possibles :
– respecttypage : permet de corriger le mauvais respect des typages en format json (pour les entiers)

getTables

https://opendata.larochelle.fr/webservice/?service=getTables

Exemple :
https://opendata.larochelle.fr/webservice/?service=getTables&key=VOTRE_CLE&db=voieadresse

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

formatNonpermet 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.

Paramètre Obligatoire Description
db Oui précise la base de données à scruter.
key Oui clé d’accès à l’API

getBaseMetaData (Prochainement)

https://opendata.larochelle.fr/webservice/?service=getBaseMetaData
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.

getTableMetaData (Prochainement)

https://opendata.larochelle.fr/webservice/?service=getTableMetaData

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

getData

https://opendata.larochelle.fr/webservice/?service=getData

https://opendata.larochelle.fr/webservice/?service=getData&key=CLE&db=voieadresse&table=voirie_filaire_nature&limit=2&offset=1&format=json

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 option de filtrage de la requête. Si rien n’est précisé, toutes les données sont retournées.

getRecordCount

 https://opendata.larochelle.fr/webservice/?service=getRecordCount

https://opendata.larochelle.fr/webservice/?service=getData&key=CLE&db=voieadresse&table=voirie_filaire_nature&limit=2&offset=1&format=json

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 https://opendata.larochelle.fr/webservice/?service=getData&key=CLE&db=ecnaissance&table=acte_naissance_02&limit=10&filter=an_enfant_premier_prenom%20equalto%20Jean
notequalto le champ est différent de la valeur suivante https://opendata.larochelle.fr/webservice/?service=getData&key=CLE&db=ecnaissance&table=acte_naissance_02&limit=10&filter=an_evenement_annee%20notequalto%202012
like le champ est comparé partiellement https://opendata.larochelle.fr/webservice/?service=getData&key=CLE&db=ecnaissance&table=acte_naissance_02&limit=10&filter=an_enfant_premier_prenom%20like%20Jean-%
greaterthan le champ est superieur à valeur suivante (champ de type numérique) https://opendata.larochelle.fr/webservice/?service=getData&key=CLE&db=ecnaissance&table=acte_naissance_02&limit=10&filter=an_evenement_annee%20greaterthan%202011
greaterthanorequalto le champ est supérieur ou égal à la valeur suivante (champ de type numérique) https://opendata.larochelle.fr/webservice/?service=getData&key=CLE&db=ecnaissance&table=acte_naissance_02&limit=100&filter=an_evenement_mois%20greaterthanorequalto%2011
lessthan le champ est inférieur à valeur suivante (champ de type numérique) https://opendata.larochelle.fr/webservice/?service=getData&key=CLE&db=ecnaissance&table=acte_naissance_02&limit=100&filter=an_evenement_mois%20lessthan%2011
lessthanorequalto le champ est inférieur ou égal à la valeur suivante (champ de type numérique) https://opendata.larochelle.fr/webservice/?service=getData&key=CLE&db=ecnaissance&table=acte_naissance_02&limit=100&filter=an_evenement_mois%20lessthanorequalto%2002

Exemple :
https://opendata.larochelle.fr/webservice/?service=getData&key=VOTRE_CLE&db=voieadresse&table=voirie_filaire_nature&filter=nat_libelle equalto Piste cyclable