- 19 Déc 2011
- 11h05
API | Bureau de vote primaires citoyennes
Cette API vous permet d’accéder aux informations relatives à un bureau de vote des primaires citoyennes
Accédez à la documentation technique.
Accès de la ressource
http://bureauxdevote.lesprimairescitoyennes.fr/[FORMAT]/bvp/[IDENTIFIANT_BVP]/[API_KEY]
Informations sur la ressource
Format de réponse
JSON
Méthode HTTP
GET
Authentification requise
Oui
Paramètres
FORMAT
Définition du format de sortie
Valeurs : (string){3,6}
- json : Le format de sortie par défaut est JSON
Requis
Exemple :
http://bureauxdevote.lesprimairescitoyennes.fr/json
IDENTIFIANT_BVP
Numéro d’identification unique du bureau de vote primaire
Valeurs : (string)
- Identifiant du bureau de vote
Requis
Exemple :
http://bureauxdevote.lesprimairescitoyennes.fr/json/bvp/324754
API KEY
Sans authentification, il est impossible de sortir les flux. Il convient donc de spécifier une clé secrète permettant de donner la visibilité de l’export correspondant.
Nous contacter pour obtenir la clé.
Valeurs : (string){32}
Requis
Exemple :
http://bureauxdevote.lesprimairescitoyennes.fr/json/bvp/324754/[API_KEY]
Gestion des erreurs
Une requête mal formée doit renvoyer une structure de réponse vide du type :
Erreur API Key
Si la clé secrète est invalide ou mal formée, retourne selon le cas une :
404 – NOT FOUND
403 – ACCESS FORBIDDEN
Erreur IDENTIFIANT BVP NON NUMERIQUE
Retourne :
{ "error": { "type":"numeric", "message":"Identifant de bureau de vote non num\u00e9rique" } }
Erreur IDENTIFIANT INVALIDE
Retourne :
{ "error": { "type":"invalid", "message":"Identifant de bureau de vote invalide" } }
Erreur Localisation
Wrong Localisation
Spécifications sortie JSON
Output en JSON sur le schéma suivant
{ "id":"", "nom":"", "adresse":"", "lon":"", "lat":"", "departement":"", "ville":"" }
Content-type header en output > Default: application/json
Liste des champs
- id Identifiant unique du bureau de vote des primaires citoyennes
- nom Nom du bureau de vote des primaires citoyennes
- adresse Adresse du bureau de vote des primaires citoyennes
- lon Longitude du bureau de vote
- lat Lattitude du bureau de vote
- departement Département du bureau de vote des primaires citoyennes
- ville Ville du bureau de vote des primaires citoyennes
Exemple
{ "id":"324754", "nom":"9E - A - Mairie Du Ixe", "adresse":"6, Rue Drouot", "lon":"2.3404089", "lat":"48.8726588", "departement":"75", "ville":"Paris 9e arrondissement" }