adresse.data.gouv.fr

API

Avec l'API d'adresse.data.gouv.fr, embarquez directement les données ouvertes dans votre application.

Pour plus de clarté, les exemples de commande utilisent le package httpie.

/

Point d'entrée pour la BAN.

Liste l'ensemble des points d'entrée de la BAN.

http '/'

Le retour correspond à un json contenant les différents points d'entrée de l'API:

{
    "contact": "contact@ban.somewhere.fr",
    "doc_url": "https://doc.ban.somewhere.fr",
    "endpoints": {
        "/municipality": {
            "GET": "Get Municipality collection.",
        },
        "/municipality/{identifier}": {
            "GET": "Get Municipality with 'identifier'.",
        },
        "/municipality/{identifier}/groups": {
            "GET": "Retrieve Municipality groups."
        },
        "/municipality/{identifier}/versions": {
            "GET": "Get resource versions."
        },
        "/municipality/{identifier}/versions/{version}": {
            "GET": "Get Municipality version corresponding to 'version' number."
        },
        "/postcode": {
            "GET": "Get Postcode collection.",
        },
        "/postcode/{identifier}": {
            "GET": "Get Postcode with 'identifier'.",
        },
        "/postcode/{identifier}/versions": {
            "GET": "Get resource versions."
        },
        "/postcode/{identifier}/versions/{version}": {
            "GET": "Get Postcode version corresponding to 'version' number."
        },
        "/group": {
            "GET": "Get Group collection."
        },
        "/group/{identifier}": {
            "GET": "Get Group with 'identifier'.",
        },
        "/group/{identifier}/housenumbers": {
            "GET": "Retrieve Group housenumbers."
        },
        "/group/{identifier}/versions": {
            "GET": "Get resource versions."
        },
        "/group/{identifier}/versions/{version}": {
            "GET": "Get Group version corresponding to 'version' number."
        },
        "/housenumber": {
            "GET": "Get Housenumber collection."
        },
        "/housenumber/{identifier}": {
            "GET": "Get Housenumber with 'identifier'.",
        },
        "/housenumber/{identifier}/positions": {
            "GET": "Retrieve Housenumber positions."
        },
        "/housenumber/{identifier}/versions": {
            "GET": "Get resource versions."
        },
        "/housenumber/{identifier}/versions/{version}": {
            "GET": "Get Housenumber version corresponding to 'version' number."
        },
        "/position": {
            "GET": "Get Position collection.",
        },
        "/position/{identifier}": {
            "GET": "Get Position with 'identifier'.",
        },
        "/position/{identifier}/versions": {
            "GET": "Get resource versions."
        },
        "/position/{identifier}/versions/{version}": {
            "GET": "Get Position version corresponding to 'version' number."
        },
    },
    "licence": "XXXX",
    "version": "0.0.0"
}
            

/municipality/

Liste l'ensemble des communes contenues dans la BAN.

Sans paramètre, liste les 20 premières communes :

http 'http:/municipality'

Le paramètre limit permet de lister les communes par lot de limit communes :

http 'http:/municipality?limit=50'

Le retour correspond à un json Collection :

{
    "collection": [
        {
            "alias": null,
            "attributes": {
                "source": "INSEE/COG (2015)"
            },
            "created_at": "2016-06-20T10:18:07.045602",
            "created_by": 2,
            "id": "ban-municipality-7498d75279b84748bbe6a0bc819db1c8",
            "insee": "27002",
            "modified_at": "2016-06-20T10:18:07.045602",
            "modified_by": 2,
            "name": "Acon",
            "postcodes": [
                "27570"
            ],
            "siren": null,
            "version": 1
        },
        ...
        {
            "alias": null,
            "attributes": {
                "source": "INSEE/COG (2015)"
            },
            "created_at": "2016-06-20T10:18:07.274099",
            "created_by": 1,
            "id": "ban-municipality-73838c0dd2a9429ea076ab03e3ab1e7c",
            "insee": "27021",
            "modified_at": "2016-06-20T10:18:07.274099",
            "modified_by": 1,
            "name": "Asnières",
            "postcodes": [
                "27260"
            ],
            "siren": null,
            "version": 1
        }
    ],
    "next": "http://localhost/municipality?limit=50&offset=50",
    "total": 675
}
            

Les attributs retournés sont :

  • attributes : Attribut relatif à la commune
    1. source : Origine de la donnée commune
  • id : Identifiant de la commune
  • insee : Code insee de la commune
  • name : Nom de la commune
  • postcodes : Liste des codes postaux associés à cette commune
  • siren : Code SIREN de la commune
  • version : N° de version de l'enregistrement commune
  • next : Url permettant de récupérer le prochain lot de communes
  • previous : Url permettant de récupérer le précédent lot de communes

/municipality/{identifier}

Permet d'obtenir les informations relatives à la commune identifier.

Le paramètre identifier permet de visualiser les informations relatives à la commune identifier :

http 'http:/municipality/ban-municipality-7498d75279b84748bbe6a0bc819db1c8'

Le retour correspond à un json :

{
    "alias": null,
    "attributes": {
        "source": "INSEE/COG (2015)"
    },
    "created_at": "2016-06-20T10:18:07.045602",
    "created_by": 2,
    "id": "ban-municipality-7498d75279b84748bbe6a0bc819db1c8",
    "insee": "27002",
    "modified_at": "2016-06-20T10:18:07.045602",
    "modified_by": 2,
    "name": "Acon",
    "postcodes": [
        "27570"
    ],
    "siren": null,
    "version": 1
}
            

Les attributs retournés sont :

  • attributes : Attribut relatif à la commune
    1. source : Origine de la donnée commune
  • id : Identifiant de la commune
  • insee : Code insee de la commune
  • name : Nom de la commune
  • postcodes : Liste des codes postaux associés à cette commune
  • siren : Code SIREN de la commune
  • version : N° de version de l'enregistrement commune

/municipality/{identifier}/groups

Liste l'ensemble des groupes liés à la commune identifier.

Le paramètre groups permet de lister les groupes associés à la commune identifier :

http 'http:/municipality/ban-municipality-7498d75279b84748bbe6a0bc819db1c8/groups'

Le retour correspond à un json Collection:

{
    "collection": [
        {
            "alias": null,
            "attributes": {
                "source": "DGFIP/FANTOIR (2015-07)"
            },
            "created_at": "2016-06-20T10:19:05.898122",
            "created_by": 4,
            "fantoir": "270020002",
            "id": "ban-group-6cbd8a2768354901b7d6ef366d5fbcc3",
            "ign": null,
            "kind": "way",
            "laposte": null,
            "modified_at": "2016-06-20T10:19:05.898122",
            "modified_by": 4,
            "municipality": "ban-municipality-7498d75279b84748bbe6a0bc819db1c8",
            "name": "RUE DES ATTELAGES",
            "resource": "group"
        },
        ...
        {
            "alias": null,
            "attributes": {
                "source": "DGFIP/FANTOIR (2015-07)"
            },
            "created_at": "2016-06-20T10:19:06.182304",
            "created_by": 3,
            "fantoir": "270020022",
            "id": "ban-group-998111b8e2414aef83ff436d73f5b1ef",
            "ign": null,
            "kind": "way",
            "laposte": null,
            "modified_at": "2016-06-20T10:19:06.182304",
            "modified_by": 3,
            "municipality": "ban-municipality-7498d75279b84748bbe6a0bc819db1c8",
            "name": "CHE DES PRES",
            "resource": "group"
        }
    ],
    "next": "http://localhost/municipality/ban-municipality-7498d75279b84748bbe6a0bc819db1c8/groups?offset=20",
    "total": 79
}
            

Les attributs retournés sont :

  • attributes : Attribut relatif à la commune
    1. source : Origine de la donnée commune
  • fantoir : Identification DGFIP de la voie
  • id : Identifiant de la commune
  • ign : Identifiant IGN
  • kind : Type de position
  • laposte : Matricule du fichier hexavia
  • municipality : Identifiant de la commune
  • name : Nom de voie ou lieu dit
  • next : Url permettant de récupérer le prochain lot de groups associés à une commune
  • previous : Url permettant de récupérer le précédent lot de groups associés à une commune

/municipality/{identifier}/versions

Liste l'ensemble des versions liées à la commune identifier.

Le paramètre versions liste l'ensemble des versions existantes pour la commune identidier :

http 'http:/municipality/ban-municipality-7498d75279b84748bbe6a0bc819db1c8/versions'

Le retour correspond à un json Collection:

            {
                "collection": [
                    {
                        "alias": null,
                        "attributes": {
                            "source": "INSEE/COG (2015)"
                        },
                        "created_at": "2016-06-20T10:18:07.045602",
                        "created_by": 2,
                        "id": "ban-municipality-7498d75279b84748bbe6a0bc819db1c8",
                        "insee": "27002",
                        "modified_at": "2016-06-20T10:18:07.045602",
                        "modified_by": 2,
                        "name": "Acon",
                        "postcodes": [],
                        "siren": null,
                        "version": 1
                    }
                ],
                "total": 1
            }
            

Les attributs retournés sont :

  • attributes : Attribut relatif à la commune
    1. source : Origine de la donnée commune
  • id : Identifiant de la commune
  • insee : Code insee de la commune
  • name : Nom de la commune
  • postcodes : Liste des codes postaux associés à cette commune
  • siren : Code SIREN de la commune
  • version : N° de version de l'enregistrement commune

/municipality/{identifier}/versions/{version}

Permet d'obtenir la version spécifique de la commune identifier.

Le paramètre version permet de ne visualiser que la version version de la commune identifier :

http 'http:/municipality/ban-municipality-7498d75279b84748bbe6a0bc819db1c8/versions/1'

Le retour correspond à un json :

            {
                "alias": null,
                "attributes": {
                    "source": "INSEE/COG (2015)"
                },
                "created_at": "2016-06-20T10:18:07.045602",
                "created_by": 2,
                "id": "ban-municipality-7498d75279b84748bbe6a0bc819db1c8",
                "insee": "27002",
                "modified_at": "2016-06-20T10:18:07.045602",
                "modified_by": 2,
                "name": "Acon",
                "postcodes": [],
                "siren": null,
                "version": 1
            }
            

Les attributs retournés sont :

  • attributes : Attribut relatif à la commune
    1. source : Origine de la donnée commune
  • id : Identifiant de la commune
  • insee : Code insee de la commune
  • name : Nom de la commune
  • postcodes : Liste des codes postaux associés à cette commune
  • siren : Code SIREN de la commune
  • version : N° de version de l'enregistrement commune

/postcode

Liste l'ensemble des codes postaux contenus dans la BAN.

Sans paramètre, liste les 20 premiers codes postaux :

http 'http:/postcode'

Le paramètre limit permet de lister les codes postaux par lot de limit codes postaux :

http 'http:/postcode?limit=50'

Le retour correspond à un json Collection :

{
    "collection": [
        {
            "attributes": {
                "source": "La Poste (2015)"
            },
            "code": "27800",
            "created_at": "2016-06-20T10:46:35.982571",
            "created_by": 5,
            "id": "ban-postcode-8f25c2089fbb4e68a2163847a8be7cdd",
            "modified_at": "2016-06-20T10:46:35.982571",
            "modified_by": 5,
            "municipality": {
                "alias": null,
                "attributes": {
                    "source": "INSEE/COG (2015)"
                },
                "created_at": "2016-06-20T10:18:07.055213",
                "created_by": 1,
                "id": "ban-municipality-185fa749d6da44ba9c2ca7182e5afb4f",
                "insee": "27001",
                "modified_at": "2016-06-20T10:18:07.055213",
                "modified_by": 1,
                "name": "Aclou",
                "siren": null
            },
            "name": "ACLOU",
            "version": 1
        },
        ...
        {
            "attributes": {
                "source": "La Poste (2015)"
            },
            "code": "27820",
            "created_at": "2016-06-20T10:46:36.253280",
            "created_by": 5,
            "id": "ban-postcode-376559d37dfa4220ae14fb43d1c4c4d6",
            "modified_at": "2016-06-20T10:46:36.253280",
            "modified_by": 5,
            "municipality": {
                "alias": null,
                "attributes": {
                    "source": "INSEE/COG (2015)"
                },
                "created_at": "2016-06-20T10:18:07.258136",
                "created_by": 2,
                "id": "ban-municipality-da25577738974a298faf45a2c8bc616f",
                "insee": "27019",
                "modified_at": "2016-06-20T10:18:07.258136",
                "modified_by": 2,
                "name": "Armentières-sur-Avre",
                "siren": null
            },
            "name": "ARMENTIERES SUR AVRE",
            "version": 1
        }
    ],
    "next": "http://localhost/postcode?offset=20",
    "total": 677
}
            

Les attributs retournés sont :

  • attributes : Attribut relatif au code postal
    1. source : Origine de la donnée code postal
  • code : N° de code postal
  • id : Identifiant du code postal
  • municipality : Informations relatives à la commune liée au code postal
    1. source : Origine de la donnée commune
    2. id : Identifiant de la commune
    3. insee : Code insee de la commune
    4. name : Nom de la commune
    5. siren : Code siren de la municipality
  • name : Nom de la commune associée au code postal
  • version : N° de version de l'enregistrement code postal
  • next : Url permettant de récupérer le prochain lot de codes postaux
  • previous : Url permettant de récupérer le précédent lot de codes postaux

/postcode/{identifier}

Permet d'obtenir toutes les informations relatives au code postal identifier.

Le paramètre identifier permet de visualiser les informations relatives à un code postal :

http 'http:/postcode/ban-postcode-376559d37dfa4220ae14fb43d1c4c4d6'

Le retour correspond à un json :

{
    "attributes": {
        "source": "La Poste (2015)"
    },
    "code": "27820",
    "created_at": "2016-06-20T10:46:36.253280",
    "created_by": 5,
    "id": "ban-postcode-376559d37dfa4220ae14fb43d1c4c4d6",
    "modified_at": "2016-06-20T10:46:36.253280",
    "modified_by": 5,
    "municipality": {
        "alias": null,
        "attributes": {
            "source": "INSEE/COG (2015)"
        },
        "created_at": "2016-06-20T10:18:07.258136",
        "created_by": 2,
        "id": "ban-municipality-da25577738974a298faf45a2c8bc616f",
        "insee": "27019",
        "modified_at": "2016-06-20T10:18:07.258136",
        "modified_by": 2,
        "name": "Armentières-sur-Avre",
        "siren": null
    },
    "name": "ARMENTIERES SUR AVRE",
    "version": 1
}
            

Les attributs retournés sont :

  • attributes : Attribut relatif au code postal
    1. source : Origine de la donnée code postal
  • code : N° de code postal
  • id : Identifiant du code postal
  • municipality : Informations relatives à la commune liée au code postal
    1. source : Origine de la donnée commune
    2. id : Identifiant de la commune
    3. insee : Code insee de la commune
    4. name : Nom de la commune
    5. siren : Code siren de la municipality
  • name : Nom de la commune associée au code postal
  • version : N° de version de l'enregistrement code postal

/postcode/{identifier}/versions

Liste l'ensemble des versions liées au code postal identifier.

Le paramètre versions permet de lister les versions liées au code postal identifier :

http 'http:/postcode/ban-postcode-be24a2fdfa8d434b8c830a9b55b400c4/versions'

Le retour correspond à un json Collection:

{
    "collection": [
        {
            "attributes": {
                "source": "La Poste (2015)"
            },
            "code": "27400",
            "created_at": "2016-06-20T10:46:36.009472",
            "created_by": 5,
            "id": "ban-postcode-be24a2fdfa8d434b8c830a9b55b400c4",
            "modified_at": "2016-06-20T10:46:36.009472",
            "modified_by": 5,
            "municipality": {
                "alias": null,
                "attributes": {
                    "source": "INSEE/COG (2015)"
                },
                "created_at": "2016-06-20T10:18:07.065921",
                "created_by": 2,
                "id": "ban-municipality-af7c291a310646278e1fec17c51b101d",
                "insee": "27003",
                "modified_at": "2016-06-20T10:18:07.065921",
                "modified_by": 2,
                "name": "Acquigny",
                "siren": null
            },
            "name": "ACQUIGNY",
            "version": 1
        }
    ],
    "total": 1
}
            

Les attributs retournés sont :

  • attributes : Attribut relatif au code postal
    1. source : Origine de la donnée code postal
  • code : N° de code postal
  • id : Identifiant du code postal
  • municipality : Informations relatives à la commune liée au code postal
    1. source : Origine de la donnée commune
    2. id : Identifiant de la commune
    3. insee : Code insee de la commune
    4. name : Nom de la commune
    5. siren : Code siren de la municipality
  • name : Nom de la commune associée au code postal
  • version : N° de version de l'enregitrement code postal
  • next : Url permettant de récupérer le prochain lot de codes postaux
  • previous : Url permettant de récupérer le précédent lot de codes postaux

/postcode/{identifier}/versions/{version}

Permet d'obtenir la version spécifique du code postal identifier.

Le paramètre version permet de ne visualiser que la version version d'un code postal' identifier :

http 'http:/postcode/ban-postcode-be24a2fdfa8d434b8c830a9b55b400c4/versions/1'

Le retour correspond à un json :

{
    "attributes": {
        "source": "La Poste (2015)"
    },
    "code": "27400",
    "created_at": "2016-06-20T10:46:36.009472",
    "created_by": 5,
    "id": "ban-postcode-be24a2fdfa8d434b8c830a9b55b400c4",
    "modified_at": "2016-06-20T10:46:36.009472",
    "modified_by": 5,
    "municipality": {
        "alias": null,
        "attributes": {
            "source": "INSEE/COG (2015)"
        },
        "created_at": "2016-06-20T10:18:07.065921",
        "created_by": 2,
        "id": "ban-municipality-af7c291a310646278e1fec17c51b101d",
        "insee": "27003",
        "modified_at": "2016-06-20T10:18:07.065921",
        "modified_by": 2,
        "name": "Acquigny",
        "siren": null
    },
    "name": "ACQUIGNY",
    "version": 1
}            

Les attributs retournés sont :

  • attributes : Attribut relatif au code postal
    1. source : Origine de la donnée code postal
  • code : N° de code postal
  • id : Identifiant du code postal
  • municipality : Informations relatives à la commune liée au code postal
    1. source : Origine de la donnée commune
    2. id : Identifiant de la commune
    3. insee : Code insee de la commune
    4. name : Nom de la commune
    5. siren : Code siren de la municipality
  • name : Nom de la commune associée au code postal
  • version : N° de version de l'enregistrement code postal

/group

Liste l'ensemble des groupes contenus dans la BAN.

Sans paramètre, liste les 20 premiers groupes :

http 'http:/group'

Le paramètre limit permet de lister les groupes par lot de limit groupes :

http 'http:/group?limit=50'

Le retour correspond à un json Collection :

{
    "collection": [
        {
            "alias": null,
            "attributes": {
                "source": "DGFIP/FANTOIR (2015-07)"
            },
            "created_at": "2016-06-20T10:19:05.150027",
            "created_by": 4,
            "fantoir": "270010023",
            "id": "ban-group-057b2bfc20ee47078af49b341e866677",
            "ign": null,
            "kind": "way",
            "laposte": null,
            "modified_at": "2016-06-20T10:19:05.150027",
            "modified_by": 4,
            "municipality": {
                "alias": null,
                "attributes": {
                    "source": "INSEE/COG (2015)"
                },
                "created_at": "2016-06-20T10:18:07.055213",
                "created_by": 1,
                "id": "ban-municipality-185fa749d6da44ba9c2ca7182e5afb4f",
                "insee": "27001",
                "modified_at": "2016-06-20T10:18:07.055213",
                "modified_by": 1,
                "name": "Aclou",
                "siren": null
            },
            "name": "PL DES BRUYERES",
            "version": 1
        },
        ...
        {
            "alias": null,
            "attributes": {
                "source": "DGFIP/FANTOIR (2015-07)"
            },
            "created_at": "2016-06-20T10:19:05.630876",
            "created_by": 4,
            "fantoir": "27001B008",
            "id": "ban-group-88099ac6a3cd44fd9bf480bdd7603007",
            "ign": null,
            "kind": "area",
            "laposte": null,
            "modified_at": "2016-06-20T10:19:05.630876",
            "modified_by": 4,
            "municipality": {
                "alias": null,
                "attributes": {
                    "source": "INSEE/COG (2015)"
                },
                "created_at": "2016-06-20T10:18:07.055213",
                "created_by": 1,
                "id": "ban-municipality-185fa749d6da44ba9c2ca7182e5afb4f",
                "insee": "27001",
                "modified_at": "2016-06-20T10:18:07.055213",
                "modified_by": 1,
                "name": "Aclou",
                "siren": null
            },
            "name": "LES BRUYERES SUD",
            "version": 1
        }
    ],
    "next": "http://localhost/group?offset=20",
    "total": 48539
}
            

Les attributs retournés sont :

  • attributes : Attribut relatif à un groupe
    1. source : Origine de la donnée groupe
  • fantoir : Identification DGFIP de la voie
  • id : Identifiant du groupe
  • ign : Identifiant IGN
  • kind : Type de position
  • laposte : Matricule du fichier hexavia
  • municipality : Informations relatives à la commune liée au groupe
    1. source : Origine de la donnée commune
    2. id : Identifiant de la commune
    3. insee : Code insee de la commune
    4. name : Nom de la commune
    5. siren : Code siren de la municipality
  • name : Nom de la commune associée au groupe
  • version : N° de version de l'enregistrement groupe
  • next : Url permettant de récupérer le prochain lot de groupes
  • previous : Url permettant de récupérer le précédent lot de groupes

/group/{identifier}

Permet d'obtenir toutes les informations relatives au groupe identifier.

Le paramètre identifier permet de visualiser les informations relatives à un groupe :

http 'http:/group/ban-group-88099ac6a3cd44fd9bf480bdd7603007'

Le retour correspond à un json :

{
    "alias": null,
    "attributes": {
        "source": "DGFIP/FANTOIR (2015-07)"
    },
    "created_at": "2016-06-20T10:19:05.630876",
    "created_by": 4,
    "fantoir": "27001B008",
    "id": "ban-group-88099ac6a3cd44fd9bf480bdd7603007",
    "ign": null,
    "kind": "area",
    "laposte": null,
    "modified_at": "2016-06-20T10:19:05.630876",
    "modified_by": 4,
    "municipality": {
        "alias": null,
        "attributes": {
            "source": "INSEE/COG (2015)"
        },
        "created_at": "2016-06-20T10:18:07.055213",
        "created_by": 1,
        "id": "ban-municipality-185fa749d6da44ba9c2ca7182e5afb4f",
        "insee": "27001",
        "modified_at": "2016-06-20T10:18:07.055213",
        "modified_by": 1,
        "name": "Aclou",
        "siren": null
    },
    "name": "LES BRUYERES SUD",
    "version": 1
}
            

Les attributs retournés sont :

  • attributes : attribut relatif au groupe
    1. source : origine de la donnée groupe
  • fantoir : Identification DGFIP de la voie
  • id : Identifiant du groupe
  • ign : Identifiant IGN
  • kind : Type de position
  • laposte : Matricule du fichier hexavia
  • municipality : Informations relatives à la commune liée au groupe
    1. source : Origine de la donnée commune
    2. id : Identifiant de la commune
    3. insee : Code insee de la commune
    4. name : Nom de la commune
    5. siren : Code siren de la municipality
  • name : Nom de la commune associée au groupe
  • version : N° de version de l'enregistrement groupe

/group/{identifier}/housenumbers

Permet d'obtenir l'ensemble des housenumbers liés au groupe identifier.

Le paramètre housenumbers permet de lister les nousenumbers associés à un groupe identifier :

http 'http:/group/ban-group-855d0bb1b3bf4463be43988aa21eb1de/housenumbers'

Le retour correspond à un json Collection:

{
    "collection": [
        {
            "attributes": {
                "source": "BAN (2016-06-05)"
            },
            "center": {
                "coordinates": [
                    1.185993,
                    49.172992
                ],
                "type": "Point"
            },
            "cia": "27003_0005_1_",
            "created_at": "2016-06-20T11:41:46.705214",
            "created_by": 9,
            "id": "ban-housenumber-53d494901c0242d0812a48f0632ed509",
            "ign": "ADRNIVX_0000000332213104",
            "laposte": null,
            "modified_at": "2016-06-20T11:41:46.705214",
            "modified_by": 9,
            "number": "1",
            "ordinal": null,
            "parent": "ban-group-855d0bb1b3bf4463be43988aa21eb1de",
            "postcode": "ban-postcode-be24a2fdfa8d434b8c830a9b55b400c4",
            "resource": "housenumber"
        },
        ...
        {
            "attributes": {
                "source": "BAN (2016-06-05)"
            },
            "center": {
                "coordinates": [
                    1.1812834,
                    49.1729015
                ],
                "type": "Point"
            },
            "cia": "27003_0005_25_",
            "created_at": "2016-06-20T10:47:02.036278",
            "created_by": 8,
            "id": "ban-housenumber-7e0c288b651f4f5d8e2e5f6c268bc6e4",
            "ign": "ADRNIVX_0000000287394830",
            "laposte": null,
            "modified_at": "2016-06-20T11:41:47.288049",
            "modified_by": 10,
            "number": "25",
            "ordinal": null,
            "parent": "ban-group-855d0bb1b3bf4463be43988aa21eb1de",
            "postcode": "ban-postcode-be24a2fdfa8d434b8c830a9b55b400c4",
            "resource": "housenumber"
        }
    ],
    "next": "http://localhost/group/ban-group-855d0bb1b3bf4463be43988aa21eb1de/housenumbers?offset=20",
    "total": 73
}
            

Les attributs retournés sont :

  • attributes : Attribut relatif au groupe
    1. source : Origine de la donnée groupe
  • center : Attribut relatif au groupe
    1. coordinates : Coordonnées longitude, latitude du groupe
    2. type : Type de la coordonnée groupe
  • cia : Clé d'Interopérabilité Adresse
  • id : Identifiant du groupe
  • ign : Identifiant IGN
  • laposte : Matricule du fichier hexavia
  • number : N° de voie
  • ordinal : Indice de répétition
  • parent : Identifiant du groupe parent
  • postcode : Identifiant du code postal

/group/{identifier}/versions

Liste l'ensemble des versions liées au groupe identifier.

Le paramètre versions permet de lister les versions liées au groupe identifier :

http 'http:/group/ban-group-855d0bb1b3bf4463be43988aa21eb1de/versions'

Le retour correspond à un json Collection:

{
    "collection": [
        {
            "alias": null,
            "attributes": {
                "source": "DGFIP/FANTOIR (2015-07)"
            },
            "created_at": "2016-06-20T10:19:07.106394",
            "created_by": 4,
            "fantoir": "270030005",
            "id": "ban-group-855d0bb1b3bf4463be43988aa21eb1de",
            "ign": null,
            "kind": "way",
            "laposte": null,
            "modified_at": "2016-06-20T10:19:07.106394",
            "modified_by": 4,
            "municipality": {
                "alias": null,
                "attributes": {
                    "source": "INSEE/COG (2015)"
                },
                "created_at": "2016-06-20T10:18:07.065921",
                "created_by": 2,
                "id": "ban-municipality-af7c291a310646278e1fec17c51b101d",
                "insee": "27003",
                "modified_at": "2016-06-20T10:18:07.065921",
                "modified_by": 2,
                "name": "Acquigny",
                "siren": null
            },
            "name": "RUE ARISTIDE BRIAND",
            "version": 1
        }
    ],
    "total": 1
}
            

Les attributs retournés sont :

  • attributes : Attribut relatif au groupe
    1. source : Origine de la donnée groupe
  • fantoir : Identification DGFIP de la voie
  • id : Identifiant du groupe
  • ign : Identifiant IGN
  • kind : Type de position
  • laposte : Matricule du fichier hexavia
  • municipality : Informations relatives à la commune liée à un groupe
    1. source : Origine de la donnée commune
    2. id : Identifiant de la commune
    3. insee : Code insee de la commune
    4. name : Nom de la commune
    5. siren : Code siren de la municipality
  • name : Nom de la commune associée au code postal
  • version : N° de version de l'enregistrement groupe
  • next : Url permettant de récupérer le prochain lot de groupes
  • previous : Url permettant de récupérer le précédent lot de groupes

/group/{identifier}/versions/{version}

Permet d'obtenir la version spécifique du groupe identifier.

Le paramètre version permet de ne visualiser que la version version d'un groupe' identifier :

http 'http:/group/ban-group-855d0bb1b3bf4463be43988aa21eb1de/versions/1'

Le retour correspond à un json :

{
    "alias": null,
    "attributes": {
        "source": "DGFIP/FANTOIR (2015-07)"
    },
    "created_at": "2016-06-20T10:19:07.106394",
    "created_by": 4,
    "fantoir": "270030005",
    "id": "ban-group-855d0bb1b3bf4463be43988aa21eb1de",
    "ign": null,
    "kind": "way",
    "laposte": null,
    "modified_at": "2016-06-20T10:19:07.106394",
    "modified_by": 4,
    "municipality": {
        "alias": null,
        "attributes": {
            "source": "INSEE/COG (2015)"
        },
        "created_at": "2016-06-20T10:18:07.065921",
        "created_by": 2,
        "id": "ban-municipality-af7c291a310646278e1fec17c51b101d",
        "insee": "27003",
        "modified_at": "2016-06-20T10:18:07.065921",
        "modified_by": 2,
        "name": "Acquigny",
        "siren": null
    },
    "name": "RUE ARISTIDE BRIAND",
    "version": 1
}
            

Les attributs retournés sont :

  • attributes : Attribut relatif au groupe
    1. source : Origine de la donnée groupe
  • fantoir : Identification DGFIP de la voie
  • id : Identifiant du groupe
  • ign : Identifiant IGN
  • kind : Type de position
  • laposte : Matricule du fichier hexavia
  • municipality : Informations relatives à la commune liée à un groupe
    1. source : Origine de la donnée commune
    2. id : Identifiant de la commune
    3. insee : Code insee de la commune
    4. name : Nom de la commune
    5. siren : Code siren de la municipality
  • name : Nom de la commune associée au code postal
  • version : N° de version de l'enregistrement groupe

/housenumber

Liste l'ensemble des housenumber contenus dans la BAN.

Sans paramètre, liste les 20 premiers housenumber :

http 'http:/housenumber'

Le paramètre limit permet de lister les housenumber par lot de limit housenumber :

http 'http:/housenumber?limit=50'

Le retour correspond à un json Collection :

{
    "collection": [
        {
            "ancestors": [],
            "attributes": {
                "source": "BAN (2016-06-05)"
            },
            "center": null,
            "cia": "27231_0047_0_",
            "created_at": "2016-06-20T12:58:12.696170",
            "created_by": 13,
            "id": "ban-housenumber-91152fe98759472f9df04d19093cbb07",
            "ign": "ADRNIVX_0000000325891892",
            "laposte": null,
            "modified_at": "2016-06-20T12:58:12.696170",
            "modified_by": 13,
            "number": "0",
            "ordinal": null,
            "parent": {
                "alias": null,
                "attributes": {
                    "source": "DGFIP/FANTOIR (2015-07)"
                },
                "created_at": "2016-06-20T10:24:18.015248",
                "created_by": 3,
                "fantoir": "272310047",
                "id": "ban-group-2211302a7d0b4bc99be5b8a428e8cb2b",
                "ign": null,
                "kind": "way",
                "laposte": null,
                "modified_at": "2016-06-20T10:24:18.015248",
                "modified_by": 3,
                "municipality": "ban-municipality-34afc30d8b084af1a5a170e072ac2fb4",
                "name": "RUE DES SOUPIRS"
            },
            "postcode": {
                "attributes": {
                    "source": "La Poste (2015)"
                },
                "code": "27120",
                "created_at": "2016-06-20T10:46:38.366513",
                "created_by": 6,
                "id": "ban-postcode-2df6922954604d44b367b84c2d0a0ecc",
                "modified_at": "2016-06-20T10:46:38.366513",
                "modified_by": 6,
                "municipality": "ban-municipality-34afc30d8b084af1a5a170e072ac2fb4",
                "name": "FAINS"
            },
            "version": 1
        },
        ...
        {
            "ancestors": [],
            "attributes": {
                "source": "BAN (2016-06-05)"
            },
            "center": null,
            "cia": "27239_B041_0_",
            "created_at": "2016-06-20T14:17:59.053841",
            "created_by": 15,
            "id": "ban-housenumber-047ea9c100554b9db4f4fb72b3eeac5b",
            "ign": "ADRNIVX_0000000325887238",
            "laposte": null,
            "modified_at": "2016-06-20T14:17:59.053841",
            "modified_by": 15,
            "number": "0",
            "ordinal": null,
            "parent": {
                "alias": null,
                "attributes": {
                    "source": "DGFIP/FANTOIR (2015-07)"
                },
                "created_at": "2016-06-20T10:24:28.757309",
                "created_by": 4,
                "fantoir": "27239B041",
                "id": "ban-group-94f08c86f351423ba9358fe542a11967",
                "ign": null,
                "kind": "area",
                "laposte": null,
                "modified_at": "2016-06-20T10:24:28.757309",
                "modified_by": 4,
                "municipality": "ban-municipality-b7e3be4ffe5242a59173ef1c5fbaa049",
                "name": "LA MOTTE"
            },
            "postcode": {
                "attributes": {
                    "source": "La Poste (2015)"
                },
                "code": "27270",
                "created_at": "2016-06-20T10:46:38.445463",
                "created_by": 5,
                "id": "ban-postcode-099578c5fb854975a1309c0376eda992",
                "modified_at": "2016-06-20T10:46:38.445463",
                "modified_by": 5,
                "municipality": "ban-municipality-b7e3be4ffe5242a59173ef1c5fbaa049",
                "name": "FERRIERES ST HILAIRE"
            },
            "version": 1
        }
    ],
    "next": "http://localhost/housenumber?offset=20",
    "total": 249862
}
            

Les attributs retournés sont :

  • attributes : Attribut relatif à un housenumber
    1. source : Origine de la donnée housenumber
  • center : Position par défaut
  • cia : Clé d'Interopérabilité Adresse
  • id : Identifiant du housenumber
  • ign : Identifiant IGN
  • laposte : Matricule du fichier hexavia
  • number : N° de voie
  • ordinal : Indice de répétition
  • parent : Informations relatives au groupe associé au housenumber
    1. source : Origine de la donnée groupe associée
    2. fantoir : Identification DGFIP de la voie
    3. id : Identifiant du groupe associé
    4. ign : Identifiant IGN
    5. kind : Type de position
    6. laposte : Matricule du fichier hexavia
    7. municipality : Identifiant de la commune
    8. name : Nom du groupe
  • postcode : Informations relatives au code postal
    1. source : Origine de la donnée code postal
    2. code : Code postal associé
    3. id : Identifiant du code postal associé
    4. municipality : Identifiant de la commune
    5. name : Nom de la commune associée au code postal
  • version : N° de version de l'enregistrement housenumber
  • next : Url permettant de récupérer le prochain lot de housenumber
  • previous : Url permettant de récupérer le précédent lot de housenumber

/housenumber/{identifier}

Permet d'obtenir toutes les informations relatives au housenumber identifier.

Le paramètre identifier permet de visualiser les informations relatives à un housenumber :

http 'http:/housenumber/ban-housenumber-047ea9c100554b9db4f4fb72b3eeac5b'

Le retour correspond à un json :

{
    "ancestors": [],
    "attributes": {
        "source": "BAN (2016-06-05)"
    },
    "center": null,
    "cia": "27239_B041_0_",
    "created_at": "2016-06-20T14:17:59.053841",
    "created_by": 15,
    "id": "ban-housenumber-047ea9c100554b9db4f4fb72b3eeac5b",
    "ign": "ADRNIVX_0000000325887238",
    "laposte": null,
    "modified_at": "2016-06-20T14:17:59.053841",
    "modified_by": 15,
    "number": "0",
    "ordinal": null,
    "parent": {
        "alias": null,
        "attributes": {
            "source": "DGFIP/FANTOIR (2015-07)"
        },
        "created_at": "2016-06-20T10:24:28.757309",
        "created_by": 4,
        "fantoir": "27239B041",
        "id": "ban-group-94f08c86f351423ba9358fe542a11967",
        "ign": null,
        "kind": "area",
        "laposte": null,
        "modified_at": "2016-06-20T10:24:28.757309",
        "modified_by": 4,
        "municipality": "ban-municipality-b7e3be4ffe5242a59173ef1c5fbaa049",
        "name": "LA MOTTE"
    },
    "postcode": {
        "attributes": {
            "source": "La Poste (2015)"
        },
        "code": "27270",
        "created_at": "2016-06-20T10:46:38.445463",
        "created_by": 5,
        "id": "ban-postcode-099578c5fb854975a1309c0376eda992",
        "modified_at": "2016-06-20T10:46:38.445463",
        "modified_by": 5,
        "municipality": "ban-municipality-b7e3be4ffe5242a59173ef1c5fbaa049",
        "name": "FERRIERES ST HILAIRE"
    },
    "version": 1
}
            

Les attributs retournés sont :

  • attributes : attribut relatif à un housenumber
    1. source : origine de la donnée housenumber
  • center : Position par défaut
  • cia : Clé d'Interopérabilité Adresse
  • id : Identifiant du housenumber
  • ign : Identifiant IGN
  • laposte : matricule du fichier hexavia
  • number : N° de voie
  • ordinal : Indice de répétition
  • parent : Informations relatives au groupe associé au housenumber
    1. source : Origine de la donnée groupe associée
    2. fantoir : Identification DGFIP de la voie
    3. id : Identifiant du groupe associé
    4. ign : Identifiant IGN
    5. kind : Type de position
    6. laposte : Matricule du fichier hexavia
    7. municipality : Identifiant de la commune
    8. name : Nom de la commune parente
  • postcode : Informations relatives au code postal
    1. source : Origine de la donnée code postal
    2. code : Code postal associé
    3. id : Identifiant du code postal associé
    4. municipality : Identifiant de la commune
    5. name : Nom de la commune associée au code postal
  • version : N° de version de l'enregistrement housenumber
  • next : Url permettant de récupérer le prochain lot de housenumber
  • previous : Url permettant de récupérer le précédent lot de housenumber

/housenumber/{identifier}/positions

Permet d'obtenir l'ensemble des positions liées au housenumber identifier.

Le paramètre positions permet de lister les positions associés à un housenumber identifier :

http 'http:/housenumber/ban-housenumber-e51ec5e93c5e4bc3a6ed491d7e862148/positions'

Le retour correspond à un json Collection:

{
    "collection": [
        {
            "attributes": null,
            "center": {
                "coordinates": [
                    1.1691397,
                    49.1521282
                ],
                "type": "Point"
            },
            "comment": null,
            "created_at": "2016-06-20T11:43:11.230653",
            "created_by": 11,
            "housenumber": "ban-housenumber-e51ec5e93c5e4bc3a6ed491d7e862148",
            "id": "ban-position-2573d3177d9d473f8eea676bc4a64cd7",
            "kind": "entrance",
            "modified_at": "2016-06-20T11:43:11.230653",
            "modified_by": 11,
            "name": null,
            "parent": null,
            "positioning": "other",
            "resource": "position",
            "source": "DGFiP/BANO (2016-04)"
        }
    ],
    "total": 1
}
            

Les attributs retournés sont :

  • center : Attribut relatif à la position
    1. coordinates : Coordonnées longitude, latitude de la position
    2. type : Type de la coordonnée position
  • comment : Commentaire lié à la position
  • housenumber : Identifiant du housenumber
  • id : Identifiant de la position
  • kind : Type de position
  • name : Nom de la position
  • parent : Position parente
  • positioning : Méthode d'obtention des coordonnées géographiques
  • source : Origine de la donnée housenumber

/housenumber/{identifier}/versions

Liste l'ensemble des versions liées au housenumber identifier.

Le paramètre versions permet de lister les versions liées au housenumber identifier :

http 'http:/housenumber/ban-housenumber-e51ec5e93c5e4bc3a6ed491d7e862148/versions'

Le retour correspond à un json Collection:

{
    "collection": [
        {
            "ancestors": [],
            "attributes": {
                "source": "DGFiP/BANO (2016-04)"
            },
            "center": null,
            "cia": "27014_0057_10_",
            "created_at": "2016-06-20T10:47:31.736089",
            "created_by": 7,
            "id": "ban-housenumber-e51ec5e93c5e4bc3a6ed491d7e862148",
            "ign": null,
            "laposte": null,
            "modified_at": "2016-06-20T10:47:31.736089",
            "modified_by": 7,
            "number": "10",
            "ordinal": null,
            "parent": {
                "alias": null,
                "attributes": {
                    "source": "DGFIP/FANTOIR (2015-07)"
                },
                "created_at": "2016-06-20T10:19:20.505441",
                "created_by": 4,
                "fantoir": "270140057",
                "id": "ban-group-001c4d71360a497cbbf1bb54c7917c4a",
                "ign": null,
                "kind": "way",
                "laposte": null,
                "modified_at": "2016-06-20T10:19:20.505441",
                "modified_by": 4,
                "municipality": "ban-municipality-ac79c2e510134e1cbc321cebbe04a82f",
                "name": "RUE DES RIVES DE L ITON"
            },
            "postcode": null,
            "version": 1
        },
        {
            "ancestors": [],
            "attributes": {
                "source": "BAN (2016-06-05)"
            },
            "center": null,
            "cia": "27014_0057_10_",
            "created_at": "2016-06-20T10:47:31.736089",
            "created_by": 7,
            "id": "ban-housenumber-e51ec5e93c5e4bc3a6ed491d7e862148",
            "ign": "ADRNIVX_0000000287406573",
            "laposte": null,
            "modified_at": "2016-06-20T11:42:52.380367",
            "modified_by": 9,
            "number": "10",
            "ordinal": null,
            "parent": {
                "alias": null,
                "attributes": {
                    "source": "DGFIP/FANTOIR (2015-07)"
                },
                "created_at": "2016-06-20T10:19:20.505441",
                "created_by": 4,
                "fantoir": "270140057",
                "id": "ban-group-001c4d71360a497cbbf1bb54c7917c4a",
                "ign": null,
                "kind": "way",
                "laposte": null,
                "modified_at": "2016-06-20T10:19:20.505441",
                "modified_by": 4,
                "municipality": "ban-municipality-ac79c2e510134e1cbc321cebbe04a82f",
                "name": "RUE DES RIVES DE L ITON"
            },
            "postcode": {
                "attributes": {
                    "source": "La Poste (2015)"
                },
                "code": "27400",
                "created_at": "2016-06-20T10:46:36.187261",
                "created_by": 6,
                "id": "ban-postcode-443e760be9534704a9bb854a59148baa",
                "modified_at": "2016-06-20T10:46:36.187261",
                "modified_by": 6,
                "municipality": "ban-municipality-ac79c2e510134e1cbc321cebbe04a82f",
                "name": "AMFREVILLE SUR ITON"
            },
            "version": 2
        }
    ],
    "total": 2
}
            

Les attributs retournés sont :

  • attributes : Attribut relatif à un housenumber
    1. source : Origine de la donnée housenumber
  • center : Position par défaut
  • cia : Clé d'Interopérabilité Adresse
  • id : Identifiant du housenumber
  • ign : Identifiant IGN
  • laposte : Matricule du fichier hexavia
  • number : N° de voie
  • ordinal : Indice de répétition
  • parent : Informations relatives au groupe associé au housenumber
    1. source : Origine de la donnée groupe associée
    2. fantoir : Identification DGFIP de la voie
    3. id : Identifiant du groupe associé
    4. ign : Identifiant IGN
    5. kind : Type de position
    6. laposte : Matricule du fichier hexavia
    7. name : Nom du groupe associé
  • postcode : Informations relatives au code postal
    1. source : Origine de la donnée code postal
    2. code : Code postal associé
    3. id : Identifiant du code postal associé
    4. municipality : Nom du la commune associée
    5. name : Nom du code postal
  • version : N° de version de l'enregistrement housenumber
  • next : Url permettant de récupérer le prochain lot de housenumber
  • previous : Url permettant de récupérer le précédent lot de housenumber

/housenumber/{identifier}/versions/{version}

Permet d'obtenir la version spécifique du housenumber identifier.

Le paramètre version permet de ne visualiser que la version version d'un housenumber' identifier :

http 'http:/housenumber/ban-housenumber-e51ec5e93c5e4bc3a6ed491d7e862148/versions/1'

Le retour correspond à un json :

{
    "ancestors": [],
    "attributes": {
        "source": "DGFiP/BANO (2016-04)"
    },
    "center": null,
    "cia": "27014_0057_10_",
    "created_at": "2016-06-20T10:47:31.736089",
    "created_by": 7,
    "id": "ban-housenumber-e51ec5e93c5e4bc3a6ed491d7e862148",
    "ign": null,
    "laposte": null,
    "modified_at": "2016-06-20T10:47:31.736089",
    "modified_by": 7,
    "number": "10",
    "ordinal": null,
    "parent": {
        "alias": null,
        "attributes": {
            "source": "DGFIP/FANTOIR (2015-07)"
        },
        "created_at": "2016-06-20T10:19:20.505441",
        "created_by": 4,
        "fantoir": "270140057",
        "id": "ban-group-001c4d71360a497cbbf1bb54c7917c4a",
        "ign": null,
        "kind": "way",
        "laposte": null,
        "modified_at": "2016-06-20T10:19:20.505441",
        "modified_by": 4,
        "municipality": "ban-municipality-ac79c2e510134e1cbc321cebbe04a82f",
        "name": "RUE DES RIVES DE L ITON"
    },
    "postcode": null,
    "version": 1
}
            

Les attributs retournés sont :

  • attributes : Attribut relatif au groupe
    1. source : Origine de la donnée groupe
  • center : Position par défaut
  • cia : Clé d'Interopérabilité Adresse
  • id : Identifiant du housenumber
  • ign : Identifiant IGN
  • laposte : Matricule du fichier hexavia
  • number : N° de voie
  • ordinal : Indice de répétition
  • parent : Informations relatives au groupe associé au housenumber
    1. source : Origine de la donnée groupe associé
    2. fantoir : Identification DGFIP de la voie
    3. id : Identifiant du groupe associé
    4. ign : Identifiant IGN
    5. kind : Type de position
    6. laposte : Matricule du fichier hexavia
    7. name : Nom du groupe associé
  • postcode : Informations relatives au code postal
  • version : N° de version de l'enregistrement housenumber

/position/

Liste l'ensemble des positions contenues dans la BAN.

Sans paramètre, liste les 20 premières positions :

http 'http:/position'

Le paramètre limit permet de lister les positions par lot de limit positions :

http 'http:/position?limit=50'

Le retour correspond à un json Collection :

{
    "collection": [
        {
            "attributes": null,
            "center": {
                "coordinates": [
                    1.1691397,
                    49.1521282
                ],
                "type": "Point"
            },
            "comment": null,
            "created_at": "2016-06-20T11:43:11.230653",
            "created_by": 11,
            "housenumber": {
                "attributes": {
                    "source": "BAN (2016-06-05)"
                },
                "center": {
                    "coordinates": [
                        1.1691397,
                        49.1521282
                    ],
                    "type": "Point"
                },
                "cia": "27014_0057_10_",
                "created_at": "2016-06-20T10:47:31.736089",
                "created_by": 7,
                "id": "ban-housenumber-e51ec5e93c5e4bc3a6ed491d7e862148",
                "ign": "ADRNIVX_0000000287406573",
                "laposte": null,
                "modified_at": "2016-06-20T11:42:52.380367",
                "modified_by": 9,
                "number": "10",
                "ordinal": null,
                "parent": "ban-group-001c4d71360a497cbbf1bb54c7917c4a",
                "postcode": "ban-postcode-443e760be9534704a9bb854a59148baa"
            },
            "id": "ban-position-2573d3177d9d473f8eea676bc4a64cd7",
            "kind": "entrance",
            "modified_at": "2016-06-20T11:43:11.230653",
            "modified_by": 11,
            "name": null,
            "parent": null,
            "positioning": "other",
            "source": "DGFiP/BANO (2016-04)",
            "version": 1
        },
        ...
        {
            "attributes": null,
            "center": {
                "coordinates": [
                    1.3354327,
                    49.1714559
                ],
                "type": "Point"
            },
            "comment": null,
            "created_at": "2016-06-20T11:43:11.589286",
            "created_by": 12,
            "housenumber": {
                "attributes": {
                    "source": "BAN (2016-06-05)"
                },
                "center": {
                    "coordinates": [
                        1.3354327,
                        49.1714559
                    ],
                    "type": "Point"
                },
                "cia": "27022_0074_62_",
                "created_at": "2016-06-20T10:48:27.768694",
                "created_by": 8,
                "id": "ban-housenumber-8c142bac6de74bf08f1e7d01076d5307",
                "ign": "ADRNIVX_0000000287396476",
                "laposte": null,
                "modified_at": "2016-06-20T12:23:58.365989",
                "modified_by": 14,
                "number": "62",
                "ordinal": null,
                "parent": "ban-group-a5bf46ba9297470389a9cabf48dc93aa",
                "postcode": "ban-postcode-c3d11efe38c44365ae7afff74645055a"
            },
            "id": "ban-position-62e9721012074895866274c0139d3ff2",
            "kind": "entrance",
            "modified_at": "2016-06-20T11:43:11.589286",
            "modified_by": 12,
            "name": null,
            "parent": null,
            "positioning": "other",
            "source": "DGFiP/BANO (2016-04)",
            "version": 1
        }
    ],
    "next": "http://localhost/position?offset=20",
    "total": 139484
}
            

Les attributs retournés sont :

  • center : Attribut relatif à la position
    1. coordinates : Coordonnées longitude, latitude de la position
    2. type : Type de la coordonnée position
  • comment : Commentaire de la position
  • housenumber : Attributs relatifs au housenumber associé
    1. attributes : Attribut relatif à un housenumber
      1. source : Origine de la donnée housenumber
    2. center : Attribut relatif à la position du housenumber
      1. coordinates : Coordonnées longitude, latitude de la position du housenumber
      2. type : Type de la coordonnée position du housenumber
    3. cia : Clé d'Interopérabilité Adresse
    4. id : Identifiant du housenumber
    5. ign : Identifiant IGN
    6. laposte : Matricule du fichier hexavia
    7. number : N° de voie
    8. ordinal : Indice de répétition
    9. parent : Identifiant du groupe associé au housenumber
    10. postcode : Origine de la donnée housenumber
  • id : Identifiant de la position
  • kind : Type de position
  • name : Nom de la position
  • parent : Position parente
  • positioning : Méthode d'obtention des coordonnées géographiques
  • source : Origine de la donnée position
  • version : N° de version de l'enregistrement position
  • next : Url permettant de récupérer le prochain lot de positions
  • previous : Url permettant de récupérer le précédent lot de positions

/position/{identifier}

Permet d'obtenir les informations relatives à la position identifier.

Le paramètre identifier permet de visualiser les informations relatives à une position identifier :

http 'http:/position/ban-position-62e9721012074895866274c0139d3ff2'

Le retour correspond à un json :

{
    "attributes": null,
    "center": {
        "coordinates": [
            1.3354327,
            49.1714559
        ],
        "type": "Point"
    },
    "comment": null,
    "created_at": "2016-06-20T11:43:11.589286",
    "created_by": 12,
    "housenumber": {
        "attributes": {
            "source": "BAN (2016-06-05)"
        },
        "center": {
            "coordinates": [
                1.3354327,
                49.1714559
            ],
            "type": "Point"
        },
        "cia": "27022_0074_62_",
        "created_at": "2016-06-20T10:48:27.768694",
        "created_by": 8,
        "id": "ban-housenumber-8c142bac6de74bf08f1e7d01076d5307",
        "ign": "ADRNIVX_0000000287396476",
        "laposte": null,
        "modified_at": "2016-06-20T12:23:58.365989",
        "modified_by": 14,
        "number": "62",
        "ordinal": null,
        "parent": "ban-group-a5bf46ba9297470389a9cabf48dc93aa",
        "postcode": "ban-postcode-c3d11efe38c44365ae7afff74645055a"
    },
    "id": "ban-position-62e9721012074895866274c0139d3ff2",
    "kind": "entrance",
    "modified_at": "2016-06-20T11:43:11.589286",
    "modified_by": 12,
    "name": null,
    "parent": null,
    "positioning": "other",
    "source": "DGFiP/BANO (2016-04)",
    "version": 1
}
            

Les attributs retournés sont :

  • center : Attribut relatif à la position
    1. coordinates : Coordonnées longitude, latitude de la position
    2. type : Type de la coordonnée position
  • comment : Commentaire de la position
  • housenumber : Attributs relatifs au housenumber associé
    1. attributes : Attribut relatif à un housenumber
      1. source : Origine de la donnée housenumber
    2. center : Attribut relatif à la position du housenumber
      1. coordinates : Coordonnées longitude, latitude de la position du housenumber
      2. type : Type de la coordonnée position du housenumber
    3. cia : Clé d'Interopérabilité Adresse
    4. id : Identifiant du housenumber
    5. ign : Identifiant IGN
    6. laposte : Matricule du fichier hexavia
    7. number : N° de voie
    8. ordinal : Indice de répétition
    9. parent : Identifiant du groupe associé au housenumber
    10. postcode : Origine de la donnée housenumber
  • id : Identifiant de la position
  • kind : Type de position
  • name : Nom de la position
  • parent : Position parente
  • positioning : Méthode d'obtention des coordonnées géographiques
  • source : Origine de la donnée position
  • version : N° de version de l'enregistrement position

/position/{identifier}/versions

Liste l'ensemble des versions liées à la position identifier.

Le paramètre versions permet de lister les versions liées à la position identifier :

http 'http:/position/ban-position-62e9721012074895866274c0139d3ff2/versions'

Le retour correspond à un json Collection:

{
    "collection": [
        {
            "attributes": null,
            "center": {
                "coordinates": [
                    1.3354327,
                    49.1714559
                ],
                "type": "Point"
            },
            "comment": null,
            "created_at": "2016-06-20T11:43:11.589286",
            "created_by": 12,
            "housenumber": {
                "attributes": {
                    "source": "DGFiP/BANO (2016-04)"
                },
                "center": {
                    "coordinates": [
                        1.3354327,
                        49.1714559
                    ],
                    "type": "Point"
                },
                "cia": "27022_0074_62_",
                "created_at": "2016-06-20T10:48:27.768694",
                "created_by": 8,
                "id": "ban-housenumber-8c142bac6de74bf08f1e7d01076d5307",
                "ign": null,
                "laposte": null,
                "modified_at": "2016-06-20T10:48:27.768694",
                "modified_by": 8,
                "number": "62",
                "ordinal": null,
                "parent": "ban-group-a5bf46ba9297470389a9cabf48dc93aa",
                "postcode": null
            },
            "id": "ban-position-62e9721012074895866274c0139d3ff2",
            "kind": "entrance",
            "modified_at": "2016-06-20T11:43:11.589286",
            "modified_by": 12,
            "name": null,
            "parent": null,
            "positioning": "other",
            "source": "DGFiP/BANO (2016-04)",
            "version": 1
        }
    ],
    "total": 1
}
            

Les attributs retournés sont :

  • center : Attribut relatif à la position
    1. coordinates : Coordonnées longitude, latitude de la position
    2. type : Type de la coordonnée position
  • comment : Commentaire de la position
  • housenumber : Attributs relatifs au housenumber associé
    1. attributes : Attribut relatif à un housenumber
      1. source : Origine de la donnée housenumber
    2. center : Attribut relatif à la position du housenumber
      1. coordinates : Coordonnées longitude, latitude de la position du housenumber
      2. type : Type de la coordonnée position du housenumber
    3. cia : Clé d'Interopérabilité Adresse
    4. id : Identifiant du housenumber
    5. ign : Identifiant IGN
    6. laposte : Matricule du fichier hexavia
    7. number : N° de voie
    8. ordinal : Indice de répétition
    9. parent : Identifiant du groupe associé au housenumber
    10. postcode : Origine de la donnée housenumber
  • id : Identifiant de la position
  • kind : Type de position
  • name : Nom de la position
  • parent : Position parente
  • positioning : Méthode d'obtention des coordonnées géographiques
  • source : Origine de la donnée position
  • version : N° de version de l'enregistrement position

/position/{identifier}/versions/{version}

Permet d'obtenir la version spécifique de la position identifier.

Le paramètre version permet de ne visualiser que la version version d'une position' identifier :

http 'http:/position/ban-position-62e9721012074895866274c0139d3ff2/versions/1'

Le retour correspond à un json :

{
    "attributes": null,
    "center": {
        "coordinates": [
            1.3354327,
            49.1714559
        ],
        "type": "Point"
    },
    "comment": null,
    "created_at": "2016-06-20T11:43:11.589286",
    "created_by": 12,
    "housenumber": {
        "attributes": {
            "source": "DGFiP/BANO (2016-04)"
        },
        "center": {
            "coordinates": [
                1.3354327,
                49.1714559
            ],
            "type": "Point"
        },
        "cia": "27022_0074_62_",
        "created_at": "2016-06-20T10:48:27.768694",
        "created_by": 8,
        "id": "ban-housenumber-8c142bac6de74bf08f1e7d01076d5307",
        "ign": null,
        "laposte": null,
        "modified_at": "2016-06-20T10:48:27.768694",
        "modified_by": 8,
        "number": "62",
        "ordinal": null,
        "parent": "ban-group-a5bf46ba9297470389a9cabf48dc93aa",
        "postcode": null
    },
    "id": "ban-position-62e9721012074895866274c0139d3ff2",
    "kind": "entrance",
    "modified_at": "2016-06-20T11:43:11.589286",
    "modified_by": 12,
    "name": null,
    "parent": null,
    "positioning": "other",
    "source": "DGFiP/BANO (2016-04)",
    "version": 1
}
            

Les attributs retournés sont :

  • center : Attribut relatif à la position
    1. coordinates : Coordonnées longitude, latitude de la position
    2. type : Type de la coordonnée position
  • comment : Commentaire de la position
  • housenumber : Attributs relatifs au housenumber associé
    1. attributes : Attribut relatif à un housenumber
      1. source : Origine de la donnée housenumber
    2. center : Attribut relatif à la position du housenumber
      1. coordinates : Coordonnées longitude, latitude de la position du housenumber
      2. type : Type de la coordonnée position du housenumber
    3. cia : Clé d'Interopérabilité Adresse
    4. id : Identifiant du housenumber
    5. ign : Identifiant IGN
    6. laposte : Matricule du fichier hexavia
    7. number : N° de voie
    8. ordinal : Indice de répétition
    9. parent : Identifiant du groupe associé au housenumber
    10. postcode : Origine de la donnée housenumber
  • id : Identifiant de la position
  • kind : Type de position
  • name : Nom de la position
  • parent : Position parente
  • positioning : Méthode d'obtention des coordonnées géographiques
  • source : origine de la donnée position
  • version : N° de version de l'enregistrement position