accéder au contenu principal de la page

Documentation de l'API

Documentation de l'API
Retrouvez en détails la documentation précisant le fonctionnement de l'API version 2 de data.nantes.fr

Commande "getDisponibiliteParkingsPublics"
Cette commande permet de récupérer les informations concernant la disponibilité des parkings publics de l'agglomération nantaise.

Commande "getFluiditeAxesRoutiers"
Cette commande retourne les indicateurs de fluidité du trafic sur les tronçons routiers.

Commande "getInfoTraficTANPrevisionnel"
Cette commande permet de récupérer l'info trafic prévisionnel des bus et tramway de la SEMITAN.

Commande "getInfoTraficTANTempsReel"
Cette commande permet de récupérer l'info trafic en temps réel des bus et tramway de la SEMITAN

Commande "getTempsParcours"
Indication des temps de parcours en minutes sur chaque itinéraire.

Commandes "datastore"
Cet ensemble de commandes regroupe les fonctionnalités d'interrogation du catalogue de données.
   • datastore_searchdatasets
   • datastore_getdatasets
   • datastore_getagencies
   • datastore_getfileformats
   • datastore_getlicences

getDisponibiliteParkingsPublics

Présentation

Indique en temps réel le nombre de place restante dans tous les parkings publics de Nantes.

MAJ du 06/12/2011 : ajout de l'identifiant IdObj permettant de faire la jointure avec le fichier des équipements publics.

MAJ du 07/05/2013 : modification de la documentation de l'API afin de prendre en compte les nouveaux parkings publics.

MAJ du 02/12/2013 : ajout des parkings les Fonderies et Feydeau dans la documentation.

URL d'appel

Voici l'url d'appel de la commande :

http://data.nantes.fr/api/getDisponibiliteParkingsPublics/1.0/XXXXXXXXXXXXXXX

Paramètres d'entrée

Aucun paramètre d'entrée n'est nécessaire pour cette commande.

Exemples d'appel

Ces exemples sont basés sur une clé de démonstration qu'il convient d'utiliser uniquement dans le but de prendre connaissance du fonctionnement de l'API ou pour effectuer des tests.

Pour une utilisation réelle des API à disposition sur le site d'ouverture des données de Nantes Métropole, merci d'ouvrir un compte utilisateur et d'enregistrer votre application. Une clé d'API personnelle vous sera alors attribuée.

Exemple d'appel pour un retour XML :

data.nantes.fr/api/getDisponibiliteParkingsPublics/1.0/39W9VSNCSASEOGV

Exemple d'appel pour un retour JSON :

data.nantes.fr/api/getDisponibiliteParkingsPublics/1.0/39W9VSNCSASEOGV/

Résultat en sortie

Exemple de flux XML en sortie :

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<opendata>
 
<request>data.nantes.fr/api/getDisponibiliteParkingsPublics/1.0/39W9VSNCSASEOGV</request>
 
<answer>
   
<status code="0" message="OK"/>
   
<data>
     
<Groupes_Parking>
       
<Groupe_Parking>
         
<Grp_identifiant>3</Grp_identifiant>
         
<Grp_nom>TOUR DE BRETAGNE</Grp_nom>
         
<Grp_statut>5</Grp_statut>
         
<Grp_pri_aut>0</Grp_pri_aut>
         
<Grp_disponible>172</Grp_disponible>
         
<Grp_complet>24</Grp_complet>
         
<Grp_exploitation>660</Grp_exploitation>
         
<Grp_horodatage>30/09/2011 11:20:40</Grp_horodatage>
         
<IdObj>299</IdObj>
       
</Groupe_Parking>
        ...
     
</Groupes_Parking>
   
</data>
 
</answer>
</opendata>

Voici la description des éléments de ce flux XML :

Elément

Description

Exemple

Grp_identifiant

Identifiant du groupe

3

Grp_nom

Nom du groupe

TOUR DE BRETAGNE

Grp_statut

Statut (cf tableau A)

5

Grp_pri_aut

Niveau de priorité du mode automatique

0

Grp_disponible

Nombre de places disponibles

172

Grp_complet

Nombre de places minimum devant déclencher l'affichage 'COMPLET'

24

Grp_exploitation

Nombre de places ouvertes au clients horaires

660

Grp_horodatage

Timestamp de l'information (format <> de xs:date)
au delà de 15 min, l'information ne doit plus être considérée comme valide

30/09/2011 11:20:40

IdObj

Identifiant correspondant du parking dans le fichier des équipements publics (thème mobilité)

299

Tableau A : liste des valeurs possibles du champ "statut"

Code

Description

Affichage PJD

0

Invalide (comptage hors service

Neutre (affichage au noir)

1

Groupe parking fermé pour tous clients

FERME

2

Groupe parking fermé au client horaires et ouvert pour les abonnés
(exemple : un parking fermé aux clients horaires la nuit ou le dimanche)

ABONNES

5

Groupe parking ouvert à tous les clients.
Le nombre de places correspond au nombre de places destinées aux clients horaires

#Nombre de places# ou COMPLET

Tableau B : correspondance avec le fichier des équipements publics (thème mobilité)

Grp_identifiant

Grp_nom

_IdObj (equi_pub)

Remarques

1

Feydeau

4320

2

decré-bouffay

284

 

3

tour de bretagne

299

 

4

graslin

288

 

5

aristide briand

1043

 

6

mediathèque

134

 

7

commerce

677

 

8

talensac

1046

 

9

cité des congrès

1044

 

10

cathédrale

3652

 

11

leon bureau

3951

ie "les machines"

14

Gloriette 1

3549

 

15

hôtel dieu

3550

 

16

limite 1 heure

3590

 

17

c.h.u

3651

 

21

gare nord

280

 

25

gare sud 1

1045

 

26

gare sud 2

3589

 

27

gare sud 3

3555

 

29

bellamy

3650

 

30

château

3554

 

31

p.s.b

3990

ie "viviani"

34

gare sud 4

3989

 

35

baco 1

4142

 

36

baco 2

3551

 

37

gloriette 2

4073

 

39

chantiers navals

4072

 

40

les Fonderies

4319