VIAMICHELIN REST API


findpoibycriteria

Description

Cette fonction recherche des POI. Elle retourne une liste de POIs statiques (POI client hébergés chez ViaMichelin) satisfaisant les critères passés en paramètre. Les critères peuvent-être géographiques et/ou liés au contenu informatif du POI (metanum, text).

URL

http://apir.viamichelin.com/apir/1/FindPOIByCriteria.{output}?db={db}&lg={lg}&c[i]={c[i]}&name={name}&text={text}&nb={nb}&sidx={sidx}&geobounds={geobounds}&countryLst={countryLst}&zipLst={zipLst}&orderBy={orderBy}&orderDir={orderDir}&authkey={authkey}&charset={charset}&ie={ie}&callback={callback}&signature={signature}

Format de sortie

xml, json

Comptabilisation

Une recherche de POIs = une requête facturée (quel que soit le nombre de résultats)

Versions du service

VersionDescription
1.0 Ajouté à l'API REST

 

Paramètres d'entrée

NomObligatoire?TypeDescriptionDéfaut
db oui string Identifiant unique de la base de données (fourni par ViaMichelin) N/A
lg oui string Code langue (fra, deu, spa, ita, eng, ces, dan, nld, fin, int, nor, pol, por, swe) N/A
c[i] non integer Critères de restriction de la recherche sur les valeurs de la métadonnée numérique [i]. Ce paramètre peut être multivalué. La sémantique du critère est propre à chaque base de POI.
Par exemple si l'on souhaite filtrer le critère 1 sur la valeur 1 et le critère 2 sur les valeurs 1 ou 2, on ecrira ...&c1=1&c2=1;2&....
vide
name non string Critère de recherche textuelle sur le nom des POIs. Plusieurs mots sont séparés par un '+' dans l'URL.
Voir aussi le paramètre textMode
vide
text non string Critères de recherche textuelle globale (full text). Plusieurs mots sont séparés par un '+' dans l'URL.
Voir aussi le paramètre textMode
vide
nb non positive integer Le nombre maximum de POI attendus (de 1 à 100). 20
sidx non positive integer Ce paramètre permet la pagination en spécifiant l'index du premier POI retourné dans l'ensemble des POIs trouvés.
Par exemple, si sidx=2 et nb=3, la réponse contient uniquement les POIs de rang 3 à 5
-1 (non paginée)
geobounds non float:float:float:float Filtre sur les POIs contenus dans une emprise géographique sous la forme minLon:minLat:maxLon:maxLat. vide
countryLst non string Critère de restriction de la recherche sur des codes pays. Ce paramètre peut-être multivalué. vide
zipLst non string Critère de restriction de la recherche sur des codes postaux. Ce paramètre peut-être multivalué. vide
textMode non 0: OU | 1: ET Mode de recherche appliqué aux paramètres name et text multivalués.
OU: seuls les POIs contenant au moins un des mots sont retournés.
ET: seuls les POIs contenant tous les mots sont retournés.
ET
orderBy non c[1-50] Identifiant du metanum servant de critère de tri pour les POI.
Voir aussi le paramètre orderDir.
vide
orderDir non asc | desc Sens du tri (ascendant ou descendant) sur le critàre positionné dans le paramètre orderBy. asc
authkey oui string Clef d'authentification. Cela peut-être une clef JS, un token généré par la fonction token ou l'identifiant du client en cas de signature de la requête (voir le paramètre signature) N/A
signature non string Signature de la requête avec l'algorithme HMAC-SHA1 où la clef secrète est le mot de passe du client. Si la requête est signée, authKey doit contenir l'identifiant du client, et expires doit-être valorisé. La signature s'applique sur des URL ayant leurs chaînes de caractères encodées. vide
expires non sauf si signature défini date Date GMT d'expiration de la requête au format yyyy-MM-dd'T'HH:mm:ss.SSS`'Z. vide
callback oui si json string Nom de la fonction de callback à lancer (n'a de sens que si le format vaut json) vide
charset non string Encodage des caractères dans la réponse 'ISO-8859-1'
ie non string Encodage des caractères dans la requête 'ISO-8859-1'

 

Restrictions

  • Le nombre de POI retournés par une requête nb est techniquement plafonné à 100.
  • Le nombre de POI retourné avec la pagination est techniquement plafonné à 2000.

 

Exemples de requêtes

 

Structure de la réponse

  • La structure est de type poiList open in new tab
  •  

Veuillez noter que les champs retournés qui ne seraient pas expliqués dans ce document correspondent à des champs à usage interne de ViaMichelin. Ils peuvent évoluer à tout moment et ne devraient pas être utilisés. Leur présence traduit le fait que ViaMichelin utilise en interne les mêmes services et la même infrastructure que ceux mis à disposition de ces clients.

Retour haut de page