Changes between Version 34 and Version 35 of Geonol/API_REST


Ignore:
Timestamp:
Oct 11, 2010, 12:32:21 PM (10 years ago)
Author:
http://cbenz.myopenid.com/
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Geonol/API_REST

    v34 v35  
    33L'API REST de [wiki:Geonol] permet de rechercher des POI dans la base de données.
    44
    5 La requête est faite par l'URL : http://annuaire.comarquage.fr/rest/poi.kml?query_string, où query_string est remplacé par les paramètres documentés ci-dessous.
     5La requête est faite par l'URL : http://annuaire.comarquage.fr/rest/poi.kml?query_string, où query_string est remplacé par les paramètres documentés ci-dessous.
    66
    77La réponse est au format KML : [http://code.google.com/intl/fr-FR/apis/kml/documentation/].
     
    99== Paramètres de la requête ==
    1010
    11   * balloon_style (int, default=0) : si le paramètre vaut 1, la balise <!BalloonStyle> est ajoutée au résultat pour chaque <Placemark>. Elle contient la mise en forme HTML de la bulle qui s'affiche lorsqu'on clique sur un point d'intérêt.
    12   * bbox (str) : définit un rectangle (bounding-box) dans lequel rechercher les organismes. La chaîne doit se composer de 4 nombres flottants séparés par une virgule. Les décimales sont séparées par un point. Les deux premiers nombres définissent le coin en bas à gauche du rectangle, et les deux derniers le coin en haut à droite. Les coordonnées sont exprimées dans le système géodésique [http://fr.wikipedia.org/wiki/WGS_84 WGS84].
    13   * format (str, default="geonol") : indique quel format utiliser pour générer le fichier KML. Cf la section « Formats » ci-dessous.
    14   * q (str) : recherche sur les différents champs de l'organisme : nom, adresse, etc. (fulltext search). Cette recherche est « approximative » : elle porte sur les radicaux des mots.
     11  * balloon_style (int, default=0) : si le paramètre vaut 1, la balise <!BalloonStyle> est ajoutée au résultat pour chaque <Placemark>. Elle contient la mise en forme HTML de la bulle qui s'affiche lorsqu'on clique sur un point d'intérêt.
     12  * center (str) : définit un point autour duquel rechercher les organismes. La chaîne doit se composer de deux nombres flottants séparés par une virgule url-encodée (%2C). Le premier nombre est la longitude, le second la latitude. Les décimales sont séparées par un point. Les coordonnées sont exprimées dans le système géodésique [http://fr.wikipedia.org/wiki/WGS_84 WGS84].
     13  * format (str, default="geonol") : indique quel format utiliser pour générer le fichier KML. Cf la section « Formats » ci-dessous.
     14  * organism_type (str, multiple) : type de l'organisme. La recherche est faite sur l'union de tous les types d'organisme fournis, le cas échéant.
     15  * organism_type_tag (str, multiple) : tag du type de l'organisme. Les types d'organismes pouvant être taggés, ce paramètre permet de rechercher tous les organismes dont le type est taggé par la valeur spécifiée. La recherche est faite sur l'union de tous les tags de types d'organisme fournis, le cas échéant.
     16  * q (str) : recherche sur les différents champs de l'organisme : nom, adresse, etc. (fulltext search). Cette recherche est « approximative » : elle porte sur les radicaux des mots.
    1517  * start (int, défaut=0) : numéro d'ordre du premier organisme retourné. Si start=0, aucun décalage n'est effectué.
    16   * tag (str, multiple) : type de l'organisme ou mot-clé associé. La recherche est faite sur l'intersection de tous les tags fournis, le cas échéant.
    17   * where (str) : nom de la commune à laquelle appartient l'organisme tel que retourné par l' « [wiki:Geonol/Autocompleter autocompleter] ». Il s'agit du nom INSEE, éventuellement suivi du numéro du département entre parenthèses, s'il existe plusieurs communes de même nom.
     18  * where (str) : nom de la commune à laquelle appartient l'organisme tel que retourné par l' « [wiki:Geonol/Autocompleter autocompleter] ». Il s'agit du nom INSEE, éventuellement suivi du numéro du département entre parenthèses, s'il existe plusieurs communes de même nom.
    1819
    1920Tous les paramètres sont optionnels et peuvent être combinés.
    2021
    21 Deux paramètres, bbox et where, définissent l'emplacement des organismes pour une recherche. Plusieurs cas sont possibles :
    22   * paramètre bbox seul : les organismes renvoyés sont situés physiquement à l'intérieur du rectangle spécifié.
    23   * paramètre where seul : les organismes renvoyés sont autour du centre de la commune spécifiée (le centre étant la mairie).
    24   * paramètres bbox et where : les organismes renvoyés sont situés physiquement à l'intérieur du rectangle spécifié. Le paramètre where est utilisé uniquement pour préciser si un organisme est compétent sur la commune correspondant au where.
     22Deux paramètres, center et where, définissent l'emplacement des organismes pour une recherche. Plusieurs cas sont possibles :
     23  * paramètre center seul : les organismes renvoyés sont situés physiquement autour du point spécifié.
     24  * paramètre where seul : les organismes renvoyés sont autour du centre de la commune spécifiée (le centre étant l'emplacement de la mairie).
     25  * paramètres center et where : les organismes renvoyés sont situés physiquement autour du point spécifié. Le paramètre where est utilisé uniquement pour préciser si un organisme est compétent sur la commune correspondant au where.
    2526
    26 Les paramètres doivent être des chaînes de caractères « url-encodées ».
     27Les paramètres doivent être des chaînes de caractères « url-encodées ».
    2728
    2829=== Format ===
     
    3233Les balises sont affichées uniquement si la donnée est disponible.
    3334
    34 Voici les formats disponibles et les champs qu'ils affichent :
    35   * geonol (par défaut) : adresse
    36   * mobidroits : addresse, numéros de téléphone, numéros de fax, emails, URL(s) du(des) site(s) web, horaires d'ouverture
     35Voici les formats disponibles et les champs qu'ils affichent :
     36  * all (par défaut) : adresse
     37  * mobidroits : addresse, numéros de téléphone, numéros de fax, emails, URL(s) du(des) site(s) web, horaires d'ouverture
    3738
    3839== Réponse ==
    3940
    40 Les balises suivantes du format KML sont utilisées. Les balises sont toujours définies, sauf mention « optionnel ».
     41Les balises suivantes du format KML sont utilisées. Les balises sont toujours définies, sauf mention « optionnel ».
    4142
    4243  * name : nom du document
     
    4546   * <Data name="start"> : même valeur que celle fournie dans la requête
    4647   * <Data name="count"> : nombre d'organismes total trouvés par la recherche, sans tenir compte de la pagination
    47   * Placemark (multiple) : définit un organisme. L'attribut 'id' est l'identifiant unique de l'organisme
     48  * Placemark id="commune-coordinates" (optionnel) : ce premier point définit le centre de la commune recherchée. Ce n'est pas un organisme. Il apparaît uniquement si le paramètre de recherche « where » a été utilisé.
     49  * Placemark (multiple) : définit un organisme. L'attribut 'id' est l'identifiant unique de l'organisme.
    4850   * name : nom de l'organisme
     51   * Point : coordonnées géographiques de l'organisme (ordre: longitude,latitude)
    4952   * address (optionnel) : adresse de l'organisme, formatée en chaîne de caractères d'une seule ligne, sans balise HTML. Les lignes de l'adresse sont séparées par des virgules.
    50    * Point : coordonnées géographiques de l'organisme (ordre: longitude,latitude)
    51    * phoneNumber (optionnel, multiple) : numéro(s) de téléphone ou de fax de l'organisme selon que la valeur commence par "tel: " ou par "fax:".
    52    * !ExtendedData (optionnel) : Données supplémentaires pour chaque Placemark
    53     * <Data name="emails"> (optionnel, multiple) : adresse(s) email de l'organisme
    54     * <Data name="web-site-urls"> (optionnel, multiple) : URL(s) du(des) site(s) web de l'organisme
    55     * <Data name="opening-hours"> (optionnel) : horaires d'ouverture de l'organisme
    56    * Style : contient le code HTML de l'info-bulle associée à l'organisme, au format utilisé par Google Maps pour rendre la couche KML. Contient le nom de l'organisme et son adresse au format hcard (http://microformats.org/wiki/hcard). Si l'organisme provient d'un annuaire qui a été indexé et que l'URL source est connue, le nom de l'organisme est un lien vers la page source de l'organisme (lien profond). Tel que mentionné dans la documentation de référence du format KML (cf ci-dessus), la chaîne de caractères "$[name]" est utilisée dans le code HTML, et doit être remplacée par le nom de l'organisme.
     53   * phoneNumber (optionnel, multiple) : numéro(s) de téléphone ou de fax de l'organisme selon que la valeur commence par "tel: " ou par "fax:".
     54   * !ExtendedData (optionnel) : Données supplémentaires pour chaque Placemark
     55    * <Data name="emails"> (optionnel, multiple) : adresse(s) email de l'organisme, séparées par une virgule s'il y en a plusieurs.
     56    * <Data name="web-site-urls"> (optionnel, multiple) : URL(s) du(des) site(s) web de l'organisme, séparées par une virgule s'il y en a plusieurs.
     57    * <Data name="opening-hours"> (optionnel) : horaires d'ouverture de l'organisme.
     58    * <Data name="is-competent"> (optionnel) : compétence de l'organisme pour la commune recherchée. Cette donnée apparaît uniquement si le paramètre de recherche « where » a été utilisé. 0 signifie non compétent, et 1 signifie compétent. Si le paramètre de recherche « where » a été utilisé, et que la donnée is-competent n'est pas renvoyée, cela signifie que la compétence de l'organisme est inconnue pour cette commune.
     59   * Style : contient le code HTML de l'info-bulle associée à l'organisme, au format utilisé par Google Maps pour rendre la couche KML. Contient le nom de l'organisme, son adresse au format hcard (http://microformats.org/wiki/hcard), et ses horaires d'ouverture. De plus, si l'organisme provient d'un annuaire qui a été indexé et que l'URL source est connue, la bulle contient un lien vers la page source de l'organisme (lien profond). Attention : tel que mentionné dans la documentation de référence du format KML (cf ci-dessus), la chaîne de caractères "$[name]" est utilisée dans le code HTML, et doit être remplacée par le nom de l'organisme.
    5760
    58 == Exemples de requêtes ==
     61== Exemples de requêtes ==
    5962
    6063  * http://annuaire.comarquage.fr/rest/poi.kml
    61   * http://annuaire.comarquage.fr/rest/poi.kml?bbox=-22.236327886227,42.237904480392,25.224609611878,51.220675627132
    62   * http://annuaire.comarquage.fr/rest/poi.kml?bbox=-22.236327886227,42.237904480392,25.224609611878,51.220675627132&start=5
     64  * http://annuaire.comarquage.fr/rest/poi.kml?center=0.96679718754413%2C46.179832551001
     65  * http://annuaire.comarquage.fr/rest/poi.kml?center=0.96679718754413%2C46.179832551001&start=5
    6366  * http://annuaire.comarquage.fr/rest/poi.kml?q=jean%20moulin
    64   * http://annuaire.comarquage.fr/rest/poi.kml?bbox=-22.236327886227,42.237904480392,25.224609611878,51.220675627132&q=jean%20moulin
    65   * http://annuaire.comarquage.fr/rest/poi.kml?tag=tgi
    66   * http://annuaire.comarquage.fr/rest/poi.kml?where=bordeaux
    67   * http://annuaire.comarquage.fr/rest/poi.kml?tag=tgi&where=bordeaux
    68   * http://annuaire.comarquage.fr/rest/poi.kml?tag=tgi&where=bordeaux&balloon_style=1
    69   * http://annuaire.comarquage.fr/rest/poi.kml?tag=tgi&format=mobidroits
     67  * http://annuaire.comarquage.fr/rest/poi.kml?center=0.96679718754413%2C46.179832551001&q=jean%20moulin
     68  * http://annuaire.comarquage.fr/rest/poi.kml?organism_type=mairie
     69  * http://annuaire.comarquage.fr/rest/poi.kml?organism_type=drass&organism_type=drca
     70  * http://annuaire.comarquage.fr/rest/poi.kml?organism_type_tag=emploi&organism_type_tag=justice
     71  * http://annuaire.comarquage.fr/rest/poi.kml?where=33000%20Bordeaux
     72  * http://annuaire.comarquage.fr/rest/poi.kml?organism_type=tgi&where=bordeaux
     73  * http://annuaire.comarquage.fr/rest/poi.kml?format=mobidroits
    7074
    7175
     
    8084http://maps.google.fr?q=http://xxx/file.kml
    8185
    82 Exemple :
    83   * http://maps.google.fr?q=http://annuaire.comarquage.fr/rest/poi.kml?bbox=-22.236327886227,42.237904480392,25.224609611878,51.220675627132
     86Exemple :
     87  * http://maps.google.fr?q=http://annuaire.comarquage.fr/rest/poi.kml?center=0.96679718754413%2C46.179832551001