API RVA Rennes Métropole

Identification de l’API

 

URL

http://rva.data.rennes-metropole.fr/

Thème

service de localisation à la voie et à l’adresse

Méthode http

GET

Formats de réponse

XML, JSON

Version

1.0

 

Paramètres communs

Afin de passer une requête conforme à l’API, il convient que les requêtes contiennent tous les paramètres obligatoires et communs suivants.

 

URL de base

Voici l’url de base pour interroger l’API : http://rva.data.rennes-metropole.fr/?

Sans paramètres, cette URL renvoie à la page d’accueil.

Pour une requête correcte, il convient de fournir au moins ces 2 paramètres :

·         clé d’API

·         version de l’API

 

Clé d’API

Il convient de donner votre clé d’API pour chaque requête.

Exemple : http://rva.data.rennes-metropole.fr/?key=XXX

 

Si aucune clé valide n’est fournie, vous serez redirigez vers la page d’accueil.

 

Codes de réponse :

-  10 = mauvaise version d'API ou version indéfinie

 

Version de l’API

Il convient de donner la version d’API pour chaque requête.

Exemple : http://rva.data.rennes-metropole.fr/?key=XXX&version=1.0 

 

Codes de réponse :

-  10 = mauvaise version d'API ou version indéfinie

 

Formats de réponse

Les formats de réponse de l’API sont :

-  XML

-  JSON

 

La spécification du format de sortie se fait par le paramètre « format ».

Exemple : http://rva.data.rennes-metropole.fr/?key=XXX&version=1.0&format=xml

 

Codes de réponse :

-  20 = format de réponse inconnu ou indéfini

-  70 = information format manquante

 

Système de référence

L’API renvoie des réponses comportant des coordonnées des objets traités dans les systèmes de référence suivant :

-  RGF93 CC48 / EPSG:3948

-  RGF93 Lambert 93 / EPSG:2154

-  WGS84 / EPSG:4326

 

La spécification du système de référence se fait par le paramètre « epsg ».

Exemple : http://rva.data.rennes-metropole.fr/?key=XXX&version=1.0&format=xml&epsg=4326

 

Codes de réponse :

-  70 = information epsg manquante

-  30 = système de référence inconnu ou indéfini

 

Nom de la commande

Ce paramètre permet de spécifier la commande principale.

Ces commandes sont documentées dans le chapitre suivant.

 

Codes de réponse :

-  40 = commande inconnue ou indéfinie


Commandes

getcities

Renvoie la liste des communes couvertes par le RVA.

Exemple : http://rva.data.rennes-metropole.fr/?key=XXX&version=1.0&format=xml&epsg=4326&cmd=getcities&insee=35238

Paramètres

Nom

obligatoire

Format

Description

Exemple

insee

oui

string

code INSEE de la commune

35238

 

Si «insee=all » alors cette commande renvoie la liste de toutes les communes.

Codes de réponse 

-  1 = ok

-  50 = argument(s) pour la commande getcities erroné(s) ou manquant(s)

Réponse

Nom

Format

Description

Exemple

insee

string

code INSEE de la commune

35238

name

string

Nom de la commune

Rennes

name2

string

Nom en majuscules sans accents

CESSON-SEVIGNE

nameindex

string

nom de la commune sous la forme d’index

Chapelle-des-Fougeretz (La)

lowerCorner

string

coordonnées du point le plus en bas à gauche

 

upperCorner

string

coordonnées du point le plus en haut à droite

 

 

Exemple XML :

<?xml version="1.0" encoding="UTF-8"?>

<rva>

  <request>http://rva.data.rennes-metropole.fr/?key=XXX&amp;version=1.0&amp;format=xml&amp;epsg=4326&amp;cmd=getcities&amp;insee=35238</request>

  <answer>

    <cities>

      <city>

        <insee>35238</insee>

        <name>Rennes</name>

        <name2>RENNES</name2>

        <nameindex>Rennes</nameindex>

        <lowerCorner>-1.75258759787579 48.0769155146557</lowerCorner>

        <upperCorner>-1.62440453826731 48.154970542112</upperCorner>

      </city>

    </cities>

    <status code="1" message="ok"/>

  </answer>

</rva>

 

Exemple JSON :

{

   "rva":{

      "request":"http:\/\/rva.data.rennes-metropole.fr\/?key=XXX&version=1.0&format=json&epsg=4326&cmd=getcities&insee=35238",

      "answer":{

         "cities":[

            {

               "insee":"35238",

               "name":"Rennes",

               "name2":"RENNES",

               "nameindex":"Rennes",

               "lowerCorner":"-1.75258759787579 48.0769155146557",

               "upperCorner":"-1.62440453826731 48.154970542112"

            }

         ],

         "status":{

            "code":"1",

            "message":"ok"

         }

      }

   }

}

 

 

getlanes

Renvoie une liste de voies.

Exemple : http://rva.data.rennes-metropole.fr/?key=XXX&version=1.0&format=xml&epsg=4326&cmd=getlanes&insee=35047

Exemple : http://rva.data.rennes-metropole.fr/?key=XXX&version=1.0&format=xml&epsg=4326&cmd=getlanes&insee=35047&query=mimo

Codes de réponse 

-  1 = ok

-  50 = argument(s) pour la commande getlanes erroné(s) ou manquant(s)

Paramètres

 

Nom

obligatoire

Format

Description

Exemple

insee

oui

string

code INSEE de la commune

35238

query

non

string

chaîne de caractère à rechercher dans le nom de la voie.

3 caractères minimum sont requis.

mimosa

 

Si « insee=all » alors la recherche porte sur toutes les communes. Dans ce cas, le paramètre « query » doit obligatoirement être fourni.

Si « query » n’est pas fourni, alors la liste de toutes les voies d’une commune est renvoyée.

Réponse

Note : Le tri de la réponse est réalisé sur l’attribut « name3 ».

 

Nom

Format

Description

Exemple

insee

string

code insee de la commune d’appartenance de la voie

35081

idlane

integer

identifiant unique de la voie dans le RVA

4394

fantoir

string

identifiant cadastral de la voie. Unique sur la commune.

0019

type

string

Type de voie

Allée

name

string

Nom complet de la voie  accentué

Allée des Mimosas

name2

string

Nom en majuscules sans accents

ALLÉE DES MIMOSAS

name3

string

nom de la voie accentuée sans le type de voie

des Mimosas

name4

string

Nom complet de la voie accentué avec le nom de la commune

Allée des Mimosas, Clayes

nameindex

string

nom de la voie sous la forme d’index

Mimosas (Allée des)

lowerCorner

string

coordonnées du point le plus en bas à gauche

1339185.6513 7231323.75

upperCorner

string

coordonnées du point le plus en haut à droite

1339230.4927 7231386.9167

 

Exemple XML :

<?xml version="1.0" encoding="UTF-8"?>

<rva>

  <request>http://rva.data.rennes-metropole.fr/?key=xxx&version=1.0&format=xml&epsg=3948&cmd=getlanes&insee=35081&query=mimosa</request>

  <answer>

    <lanes>

      <lane>

        <insee>35081</insee>

        <idlane>4394</idlane>

        <fantoir>0019</fantoir>

        <type>Allée</type>

        <name>Allée des Mimosas</name>

        <name2>ALLÉE DES MIMOSAS</name2>

        <name3>des Mimosas</name3>

        <nameindex>Mimosas (Allée des)</nameindex>

        <lowerCorner>1339185.6513 7231323.75</lowerCorner>

        <upperCorner>1339230.4927 7231386.9167</upperCorner>

      </lane>

    <status code="1" message="ok"/>

  </answer>

</rva>

 

Exemple JSON :

{

  "rva":{

    "request":"http://rva.data.rennes-metropole.fr/?key=xxx&version=1.0&format=json&epsg=3948&cmd=getlanes&insee=35081&query=mimosa",

    "answer":{

      "lanes":[

        {

          "insee":"35081",

          "idlane":"4394",

          "fantoir":"0019",

          "type":"Allée",

          "name":"Allée des Mimosas",

          "name2":"ALLÉE DES MIMOSAS",

          "name3":"des Mimosas",

          "nameindex":"Mimosas (Allée des)",

          "lowerCorner":"1339185.6513 7231323.75",

          "upperCorner":"1339230.4927 7231386.9167"

        }

      ],

      "status":{

        "code":"1",

        "message":"ok"

      }

    }

  }

}

 

getadresses

Renvoie la liste des adresses appartenant à une voie.

En option : recherche sur une partie de l’adresse.

Exemple : http://rva.data.rennes-metropole.fr/?key=XXX&version=1.0&format=xml&epsg=4326&cmd=getaddresses&idlane=7216

Exemple : http://rva.data.rennes-metropole.fr/?key=XXX&version=1.0&format=xml&epsg=4326&cmd=getaddresses&idlane=7216&query=45

Codes de réponse 

-  1 = ok

-  50 = argument(s) pour la commande getaddresses erroné(s) ou manquant(s)

Paramètres

Nom

obligatoire

Format

Description

Exemple

idlane

oui

string

code unique de voie

4133

query

non

string

chaîne de caractère à rechercher dans le champ adr1.

1 caractère minimum est requis.

75

Réponse

 

Nom

Format

Description

Exemple

insee

string

code insee de la commune d’appartenance de la voie

35238

zipcode

string

code postal de la commune d’appartenance de la voie (entouré par des #)

#35510#

idlane

integer

identifiant unique de la voie dans le RVA

87554

idaddress

long integer

identifiant unique de l’adresse

25194

number

integer

numéro dans la voie

25

extension

string

extension

bis

building

string

lettre du bâtiment

A

addr1

string

adresse complète

25 bis

addr2

string

adresse complète avec le nom de la voie

25 bis rue des Mouettes

addr3

string

adresse complète avec le nom de la voie et le nom de la commune

25 bis rue des Mouettes Rennes

x

string

coordonnées du point

 

y

string

 

 

Exemple XML :

<?xml version="1.0" encoding="UTF-8"?>

<rva>

  <request>http://rva.data.rennes-metropole.fr/?key=XXX&amp;version=1.0&amp;format=xml&amp;epsg=4326&amp;cmd=getaddresses&amp;idlane=7216&amp;query=45</request>

  <answer>

    <addresses>

      <address>

        <insee>35051</insee>

        <zipcode>#35510#</zipcode>

        <idlane>7216</idlane>

        <idaddress>44364</idaddress>

        <number>45</number>

        <extension>bis</extension>

        <building/>

        <addr1>45 bis</addr1>

        <addr2>45 bis Boulevard de Dézerseul</addr2>

        <addr3>45 bis Boulevard de Dézerseul, Cesson-Sévigné</addr3>

        <x>-1.59113850190584</x>

        <y>48.1247769974936</y>

      </address>

      <address>

        <insee>35051</insee>

        <zipcode>#35510#</zipcode>

        <idlane>7216</idlane>

        <idaddress>44403</idaddress>

        <number>45</number>

        <extension/>

        <building/>

        <addr1>45</addr1>

        <addr2>45 Boulevard de Dézerseul</addr2>

        <addr3>45 Boulevard de Dézerseul, Cesson-Sévigné</addr3>

        <x>-1.59118019614192</x>

        <y>48.1244403237111</y>

      </address>

    </addresses>

    <status code="1" message="ok"/>

  </answer>

</rva>

 

Exemple JSON :

{
  "rva":{
    "request":"http:\/\/rva.data.rennes-metropole.fr\/?key=XXX&version=1.0&format=json&epsg=4326&cmd=getaddresses&idlane=7216&query=45",
    "answer":{
      "addresses":[
        {
          "insee":"35051",
          "zipcode":"#35510#",
          "idlane":"7216",
          "idaddress":"44364",
          "number":"45",
          "extension":"bis",
          "building":"",
          "addr1":"45 bis",
          "addr2":"45 bis Boulevard de Dézerseul",
          "addr3":"45 bis Boulevard de Dézerseul, Cesson-Sévigné",
          "x":"-1.59113850190584",
          "y":"48.1247769974936"
        },
        {
          "insee":"35051",
          "zipcode":"#35510#",
          "idlane":"7216",
          "idaddress":"44403",
          "number":"45",
          "extension":"",
          "building":"",
          "addr1":"45",
          "addr2":"45 Boulevard de Dézerseul",
          "addr3":"45 Boulevard de Dézerseul, Cesson-Sévigné",
          "x":"-1.59118019614192",
          "y":"48.1244403237111"
        }
      ],
      "status":{
        "code":"1",
        "message":"ok"
      }
    }
  }
}

 

 

getfulladresses

Renvoie la liste des adresses complètes en réponse à une chaîne de caractère de type « adresse complète ».

Exemple : http://rva.data.rennes-metropole.fr/?key=XXX&version=1.0&format=xml&epsg=4326&cmd=getfulladdresses&insee=35051&query=12 rue des al

 

Paramètres

Nom

obligatoire

Format

Description

Exemple

insee

non

string

code insee de la commune

4133

query

oui

string

chaîne de caractère à rechercher dans le champ adr3.

3 caractères minimum sont requis.

12 rue des al

 

Codes de réponse 

-  1 = ok

-  50 = argument(s) pour la commande getfulladdresses erroné(s) ou manquant(s)

 

Réponse

 

Nom

Format

Description

Exemple

insee

string

code insee de la commune d’appartenance de la voie

35238

zipcode

string

code postal de la commune d’appartenance de la voie (entouré par des #)*

#35510#

idlane

integer

identifiant unique de la voie dans le RVA

87554

idaddress

long integer

identifiant unique de l’adresse

25194

number

integer

numéro dans la voie

25

extension

string

extension

bis

building

string

lettre du bâtiment

A

addr1

string

adresse complète

25 bis

addr2

string

adresse complète avec le nom de la voie

25 bis rue des Mouettes

addr3

string

adresse complète avec le nom de la voie et le nom de la commune

25 bis rue des Mouettes Rennes

x

string

coordonnées du point

 

y

string

 

* présent uniquement si le paramètre insee a été renseigné

 

Exemple XML :

<?xml version="1.0" encoding="UTF-8"?>

<rva>

  <request>http://rva.data.rennes-metropole.fr/?key=XXX&amp;version=1.0&amp;format=xml&amp;epsg=4326&amp;cmd=getfulladdresses&amp;insee=35051&amp;query=12%20rue%20des%20l</request>

  <answer>

    <addresses>

      <address>

        <insee>35055</insee>

        <zipcode>#35135#</zipcode>

        <idlane>210</idlane>

        <idaddress>4079</idaddress>

        <number>12</number>

        <extension/>

        <building/>

        <addr1>12</addr1>

        <addr2>12 Rue des Loges</addr2>

        <addr3>12 Rue des Loges, Chantepie</addr3>

        <x>-1.62403805033044</x>

        <y>48.0887983301022</y>

      </address>

      <address>

        <insee>35281</insee>

        <zipcode>#35136#</zipcode>

        <idlane>8291</idlane>

        <idaddress>52964</idaddress>

        <number>12</number>

        <extension/>

        <building/>

        <addr1>12</addr1>

        <addr2>12 Rue des Lilas</addr2>

        <addr3>12 Rue des Lilas, Saint-Jacques-de-la-Lande</addr3>

        <x>-1.70138786655988</x>

        <y>48.0925445903238</y>

      </address>

    </addresses>

    <status code="1" message="ok"/>

  </answer>

</rva>

 

Exemple JSON :

{

  "rva":{

    "request":"http:\/\/rva.data.rennes-metropole.fr\/?key=XXX&version=1.0&format=json&epsg=4326&cmd=getfulladdresses&query=12%20rue%20des%20l",

    "answer":{

      "addresses":[

        {

          "insee":"35055",

          "idlane":"210",

          "idaddress":"4079",

          "number":"12",

          "extension":"",

          "building":"",

          "addr1":"12",

          "addr2":"12 Rue des Loges",

          "addr3":"12 Rue des Loges, Chantepie",

          "x":"-1.62403805033044",

          "y":"48.0887983301022"

        },

        {

          "insee":"35281",

          "idlane":"8291",

          "idaddress":"52964",

          "number":"12",

          "extension":"",

          "building":"",

          "addr1":"12",

          "addr2":"12 Rue des Lilas",

          "addr3":"12 Rue des Lilas, Saint-Jacques-de-la-Lande",

          "x":"-1.70138786655988",

          "y":"48.0925445903238"

        }
      ],
      "status":{
        "code":"1",
        "message":"ok"
      }
    }
  }
}

getzipcode

Renvoie le code postal associé à un code insee.

Exemple : http://rva.data.rennes-metropole.fr/?key=XXX&version=1.0&format=xml&epsg=4326&cmd=getzipcode&insee=35051

 

Paramètres

Nom

obligatoire

Format

Description

Exemple

insee

oui

string

code insee de la commune

4133

 

Codes de réponse 

-  1 = ok

-  50 = argument(s) pour la commande getzipcode erroné(s) ou manquant(s)

 

Réponse

 

Nom

Format

Description

Exemple

insee

string

code insee de la commune d’appartenance de la voie

35051

zipcode

string

code postal de la commune d’appartenance de la voie (entouré par des #)

#35510#

 

Exemple XML :

<?xml version="1.0" encoding="UTF-8"?>

<rva>

  <request>http://rva.data.rennes-metropole.fr/?key=XXX&version=1.0&format=xml&epsg=4326&cmd=getzipcode&insee=35051</request>

  <answer>

    <zipcodes>

      <zipcode>

        <insee>35055</insee>

        <zipcode>#35510#</zipcode>

      </zipcode>

    </zipcodes>

    <status code="1" message="ok"/>

  </answer>

</rva>

 

Exemple JSON :

{

  "rva":{

    "request":"http://rva.data.rennes-metropole.fr/?key=XXX&version=1.0&format=json&epsg=4326&cmd=getzipcode&insee=35051",

    "answer":{

      "zipcodes":[

        {

          "insee":"35055",

          "zipcode":"#35510#",

        }
      ],
      "status":{
        "code":"1",
        "message":"ok"
      }
    }
  }
}

getlanebyid

Retourne la voie associé à l'identifiant passé en paramètre.

Exemple : http://rva.data.rennes-metropole.fr/?key=XXX&version=1.0&format=xml&epsg=4326&cmd=getlanebyid&idlane=7216

 

Paramètres

Nom

obligatoire

Format

Description

Exemple

idlane

oui

integer

identifiant de la voie

7216

 

Codes de réponse 

-  1 = ok

-  50 = argument(s) pour la commande getlanebyid erroné(s) ou manquant(s)

 

Réponse

 

Nom

Format

Description

Exemple

insee

string

code insee de la commune d’appartenance de la voie

35081

idlane

integer

identifiant de la voie

4394

fantoir

string

identifiant cadastral de la voie. Unique sur la commune.

0019

type

string

Type de voie

Allée

name

string

Nom complet de la voie  accentué

Allée des Mimosas

name2

string

Nom en majuscules sans accents

ALLÉE DES MIMOSAS

name3

string

nom de la voie accentuée sans le type de voie

des Mimosas

name4

string

Nom complet de la voie accentué avec le nom de la commune

Allée des Mimosas, Clayes

nameindex

string

nom de la voie sous la forme d’index

Mimosas (Allée des)

lowerCorner

string

coordonnées du point le plus en bas à gauche

-1.85551397751588 48.1795331609454

upperCorner

string

coordonnées du point le plus en haut à droite

-1.85486418017891 48.1800794996932

 

Exemple XML :

<?xml version="1.0" encoding="UTF-8"?>

<rva>

  <request>http://rva.data.rennes-metropole.fr/?key=xxx&version=1.0&format=xml&epsg=4326&cmd=getlanebyid&idlane=7216</request>

  <answer>

    <lanes>

      <lane>

        <insee>35051</insee>

        <idlane>7216</idlane>

        <fantoir>0201</fantoir>

        <type>Boulevard</type>

        <name>Boulevard de Dézerseul</name>

        <name2>BOULEVARD DE DÉZERSEUL</name2>

        <name3>de Dézerseul</name3>

        <nameindex>Dézerseul (Boulevard de)</nameindex>

        <name4>Boulevard de Dézerseul, Cesson-Sévigné</name4>

        <lowerCorner>-1.60082048712836 48.1185662759986</lowerCorner>

        <upperCorner>-1.59021373900376 48.1273035288169</upperCorner>

      </lane>

    <status code="1" message="ok"/>

  </answer>

</rva>

 

Exemple JSON :

{

  "rva":{

    "request":"http://rva.data.rennes-metropole.fr/?key=xxx&version=1.0&format=json&epsg=4326&cmd=getlanebyid&idlane=7216",

    "answer":{

      "lanes":[

        {

          "insee":"35051",

          "idlane":"7216",

          "fantoir":"0201",

          "type":"Boulevard",

          "name":"Boulevard de Dézerseul",

          "name2":"BOULEVARD DE DÉZERSEUL",

          "name3":"de Dézerseul",

          "nameindex":"Dézerseul (Boulevard de)",

          "name4":"Boulevard de Dézerseul, Cesson-Sévigné",

          "lowerCorner":"-1.60082048712836 48.1185662759986",

          "upperCorner":"-1.59021373900376 48.1273035288169"

        }

      ],

      "status":{

        "code":"1",

        "message":"ok"

      }

    }

  }

}

 

getaddressbyid

Retourne une adresse en fonction de l'identifiant passé en paramètre.

Exemple : http://rva.data.rennes-metropole.fr/?key=XXX&version=1.0&format=xml&epsg=4326&cmd=getaddressbyid&idaddress=44293

Codes de réponse 

-  1 = ok

-  50 = argument(s) pour la commande getaddressbyid erroné(s) ou manquant(s)

Paramètres

Nom

obligatoire

Format

Description

Exemple

idaddress

oui

integer

identifiant unique de l'adresse

44293

Réponse

 

Nom

Format

Description

Exemple

insee

string

code insee de la commune d’appartenance de la voie

35051

zipcode

string

code postal de la commune d’appartenance de la voie (entouré par des #)

#35510#

idlane

integer

identifiant unique de la voie dans le RVA

7216

idaddress

long integer

identifiant unique de l’adresse

44293

number

integer

numéro dans la voie

2

extension

string

extension

 

building

string

lettre du bâtiment

 

addr1

string

adresse complète

2

addr2

string

adresse complète avec le nom de la voie

2 boulevard de Dézerseul

addr3

string

adresse complète avec le nom de la voie et le nom de la commune

2 boulevard de Dézerseul, Cesson-Sévigné

x

string

coordonnées du point

-1.59367401573736

y

string

48.1203008323891

 

Exemple XML :

<?xml version="1.0" encoding="UTF-8"?>

<rva>

  <request>http://rva.data.rennes-metropole.fr/?key=XXX&amp;version=1.0&format=xml&epsg=4326&cmd=getaddressbyid&idaddress=44293</request>

  <answer>

    <addresses>

      <address>

        <insee>35051</insee>

        <zipcode>#35510#</zipcode>

        <idlane>7216</idlane>

        <idaddress>44293</idaddress>

        <number>2</number>

        <extension/>

        <building/>

        <addr1>2</addr1>

        <addr2>2 boulevard de Dézerseul</addr2>

        <addr3>2 boulevard de Dézerseul, Cesson-Sévigné</addr3>

        <x>-1.59367401573736</x>

        <y>48.1203008323891</y>

      </address>

    </addresses>

    <status code="1" message="ok"/>

  </answer>

</rva>

 

Exemple JSON :

{
  "rva":{
    "request":"http://rva.data.rennes-metropole.fr/?key=XXX&version=1.0&format=json&epsg=4326&cmd=getaddressbyid&idaddress=44293",
    "answer":{
      "addresses":[
        {
          "insee":"35051",
          "zipcode":"#35510#",
          "idlane":"7216",
          "idaddress":"44293",
          "number":"2",
          "extension":"",
          "building":"",
          "addr1":"45",
          "addr2":"2 boulevard de Dézerseul",
          "addr3":"2 boulevard de Dézerseul, Cesson-Sévigné",
          "x":"-1.59367401573736",
          "y":"48.1203008323891"
        }
      ],
      "status":{
        "code":"1",
        "message":"ok"
      }
    }
  }
}