- 13 Jan 2012
- 10h45
API | Get Coopol sections
Retourne la liste des sections du Parti socialiste depuis lacoopol.fr
Accédez à la documentation technique.
Accès de la ressource
https://www.lacoopol.fr/export/sections?key=[SECRET_KEY]&format=[FORMAT]&geo=[LOCALISATION]&count=[NOMBRE]
Informations sur la ressource
Format de réponse
JSON
Méthode HTTP
GET
Authentification requise
Oui
Paramètres
SECRET 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é.
Label : key
Valeurs : (string){12}
Requis
FORMAT
Définition du format de sortie
Valeurs : (string){3,6}
- json : Le format de sortie par défaut est JSON
Requis
Exemple :
https://www.lacoopol.fr/export/sections?key=[SECRET_KEY]&format=json
LOCALISATION
Rattachement à un espace géographique
Label : geo
Valeurs : (ufloat),(ufloat), (int)
- Latitude, longitude, distance
Requis
Exemple :
https://www.lacoopol.fr/export/sections?key=[SECRET_KEY]&format=json&geo=48.849721645395206,2.3801010847091675,5000
NOMBRE
Rattachement à un espace géographique
Label : count
Valeurs : (int)
- Affiche les i valeurs d’événements
Requis
Exemple :
https://www.lacoopol.fr/export/sections?key=[SECRET_KEY]&format=json&geo=48.849721645395206,2.3801010847091675,5000&count=5
Gestion des erreurs
Une requête mal formée doit renvoyer une structure de réponse vide du type :
Erreur API Key
Wrong API Key
Erreur Format
Wrong Format
Erreur Localisation
Wrong Localisation
Spécifications sortie JSON
Output en JSON sur le schéma suivant
{ "success":true, "errors":[], "data" : [{ "field" : "valeur", "field2" : "valeur" }] }
Content-type header en output > Default: application/json
Liste des champs
- id Identifiant unique de la section
- name Nom de la section
- adresse Adresse de la section
- postal_code Code postal de la section
- city Ville de la section
- site_web Site web de la section (optionnel)
- phone Téléphone de la section (optionnel)
- facebook Page/Groupe Facebook de la section (optionnel)
- twitter Twitter ID de la section (optionnel)
- lat Latitude relatif à l’adresse de la section
- long Longitude relatif à l’adresse de la section
- distance Distance de la fédé
- creation_date Date de création de l’événement dans La coopol
Exemple
{ "success":true, "errors":[], "data": [{ "id":"0000", "name":"Parti socialiste", "adresse":"10 rue de Solférino", "postal_code":"75007", "city":"Paris", "site_web":null, "phone":null, "facebook":null, "twitter":null, "lat":"-21.3468", "long":"55.4845", "distance":2735314, "creation_date":"1286973422" }] }