VIAMICHELIN REST API


MICHELIN Guide (Hotels and Restaurants)

 

FindPoi MICHELIN Guide - Hotels and Restaurants

 

Description : 

This function searches for the closest static POI  (Points Of Interest) from a specific location and returns a POI list (POIs MICHELIN Guide "Hotels and Restaurants") sorted by ascending distance. 

Calculation is based on as the crow flies.

URL

http://apir.viamichelin.com/apir/2/findPOI.{format}/{type}/{lg}?center=<center>&authKey=<authKey>&[dist=<dist>]&[distRange=<distRange>]&[nb=<nb>]&[nbRange=<nbRange>]&[sidx=<sidx>]&[filter=<filter>]&[field=<field>]&[source=<source>]&[orderby=<orderby>]&[charset=<charset>]

Format 

XML, JSON

PS: 

For JSON result, you must use findPOI.json2


 Changelog 

Version Description
2.0 MICHELIN REST API

 Input parameters 

Name Type Value Description

Mandatory?

Default

Min/Max

 format   String  XML, JSON2   output format  YES  N/A  N/A
 type  String  HOTEL / RESTAURANT 

 

 Type of POIs : Hotel or Restaurants

 NB:

Don’t forget to change the mandatory parameters “FILTER” & ”SOURCE” according to the POI request made

 YES  N/A  N/A
 lg  String

 fra, deu, spa, ita, eng, ces, dan, nld, fin, int, nor, pol, por, swe, ron, tur, rus, zho, zhn, jpn, prt

.../2/findPOI.xml/HOTEL/eng? 

 

Indicate in which language the data is returned. If the language asked isn’t available, the default language used will be English

 YES  N/A  N/A
 center  float : float

 center= <longitude> : <Latitude> 

 center=2.35:48,85

 Search center specified in the forme of longitude:latitude exprimed in decimal degrees -WGS 84.

 

 YES  N/A  N/A
 authkey  String  &authkey=YourAuthKey

 

 Authentication key. This could be a JS key, a token generated by the token function, or the client's id if request is signed (see signature parameter).

 

 YES  N/A  N/A
dist  Positive integer

  dist = X

 dist = 15000

 

Search radius in meters (from 0 to 200,000).

 

 NO  10000  1000 & 200 000
distRange

Positive integer : positive intéger 

 distRange=X:Y

distRange=10000:50000

X et Y sont en mètre

 

If the dist parameter is used, distRange parameter will be ignored..

 The distRange parameter indicates to the engine to look for till <X> meters around the “center” point, and if the minimum number of POI is not reached (the “nb” parameter) the engine will extend the search radius till reaching the value <Y> in meter.

 

 NO  N/A

 X : MIN = 1000

Y : MAX = 200000 

nb  Positive integer

 nb = X

 nb=50

 

Number of returned POI (from 1 to 100).

 

 

 NO

 N/A  20
 sidx   positive integer 

 sidx=X

 sidx=5

 

Allows pagination by specifying index of the first returned POI in the dataset.
For example, if sidx=2 and nb=3, answer contains only the sub POI list from the 3rd to the 5th rank.Allows pagination by specifying index of the first returned POI in the dataset.


For example, if sidx=2 and nb=3, answer contains only the sub POI list from the 3rd to the 5th rank.

 

 NO  N/A  N/A
 filter  String

 filter=(no_dog eq 1)

 

 filter=(no_smoke eq 1)

 

 filter = (categories_full_ranges in [3,4])

 

 filter = (michelin_stars ge 1)

 

filter=(cooking_type eq RST-CRE)

 When requesting POIs :

 

For a hotel research:

add the filter -> &filter=AGG.provider eq HOTGR

 

For a restaurant research:

add the filter -> &filter=AGG.provider eq RESGR

-> filter = AGG.provider eq RESGR 

PS:

Don’t forget to change the mandatory parameters “TYPE” & “SOURCE” according to the POI request made

------------------------

 Allows to filter the result list according to specific criterions.

-----------------------

 Several criterion may be applied by using a linking word like AND or OR

filter=<fieldName><operator><value>

fieldName specifies which field will be used for filtering.

<field_name> available for filtering : (see the list on the document : API - Field_name and values)

<operator>:specifies the operator to use :

- eq (equals)

- ne (not equal)

- gt (greater than)

- ge (greater than or equal)

- lt (less than)

- le (less than or equal)

- in (followed by list values between [X] and separed by ";" or ",")

- is null (equals zero)

- is not null (not equals zero)

 YES  N/A   N/A
field  String

 field=<description>,X, 

field=name,email, X

 Returns only the specified fields listed instead of a complete datasheet.   NO  N/A  N/A
source  String 

 source = RESGR

 source = HOTGR

 Specifies in which database (restaurant or hotels) the request will be executed.

PS:

Don’t forget to change the mandatory parameters “TYPE” & “FILTER” according to the POI request made

 YES  ALL  N/A
orderby  String

orderby=<source>.<fieldname>:<sortDirection>

orderby= HOTGR.categories_full_ranges:asc

or

orderby = HOTGR.categories_full_ranges:desc 

Defines which sorting rules will be applied to the result list.

<field_name> available for sorting :

hotels_stars / categories_full_ranges / price_classification / michelin_stars / rating 

<sortDirection> available : 

asc / desc

 

 NO  ASC  N/A
 chareset  String  charset=UTF-8 Specifies in which character set the response will be received.
 YES  UTF-8  N/A
 ie  String  ie=UTF-8 Specifies in which character set the response will be sent.
 YES  UTF-8  N/A

 

 

Hotels and Restaurants filters

<Tag_name>   Description
 Meaning / Values  
<cooking_type>  Cooking styles available

 

 Country cooking (China) : WLD-ASI-CHN
 Modern / Creative : RST-CRE
 Country cooking (Italia) : WLD-EUR-ITA
 International / Classical / Traditional : RST-TRD
 FrenchBrasserie : WLD-EUR-FRA-LYO 
 Meat & Grill : RST-MEA
 Country cooking (Japan) : WLD-ASI-JPN
 Country cooking (Spain) : WLD-EUR-ESP
 Country cooking (Germany): WLD-EUR-GER
 Country cooking (France) : WLD-EUR-FRA 
 Mediterranean cooking : WLD-EUR-ITA-MED
 Country cooking (England) : WLD-EUR-GBR-ENG
 Sea & Fish Cooking : RST-FSH
 Country cooking (India) : WLD-ASI-IND
 World cooking : RST-GSTC

 

 MG: fra? / GG : lg=fra  Available languages 

fra (Français)
deu (Allemand)
eng (Anglais)
ita (Italien)
nld (Néerlandais)
pol (Polonais)
por (Portugais)
spa (Espagnol)
ces (Tchèque)
dan (Danois)
fin (Finnois)
int (English international)
nor (Norvégien)
swe (Suédois)
tur (Turque)
ron (Roumain)
zho (Chinese)
zhn (Chinese Nong zhuang)
jpn (japonais)
prt (Brazilian Portuguese ) 
rus (Russian)

<name> Restaurant - place - Hotel - Chef  String
<price_classification>   Price range 

 1/ Less than 50 EUR
 2/ Between 50 and 70 EUR
 3/ Between 70 and 90 EUR
 4/ Between 90 and 130 EUR
 5/ More than 130 EUR

<categorie_full_ranges>  Comfort class

 2/ Quite comfortable restaurant (1 fork)
 3/Comfortable restaurant  (2 forks)
 4/Very comfortable restaurant (3 forks)
 5/Top class comfort restaurant (4 forks)
 6/ Luxury in the traditional style restaurant (5 forks)

<michelin_stars>  Restaurant awarded of a Michelin Star  [0 ; 1 ; 2 ; 3]
<breakfast>  Possibility of ordering a breakfast
 0 (NO) / 1 (YES)
<breakfast_price_included>  Breakfast price included in the room price  0 (NO) / 1 (YES)
<brunch>  Possibility of ordering a brunch
 0 (NO) / 1 (YES)
<air_conditioning>   Availability of the air conditioning  0 (NO) / 1 (YES)
<aquatic>  Presence of a swimming pool  0 (NO) / 1 (YES)
<bib_gourmand>  Availability of a high quality & affordable menu  0 (NO) / 1 (YES)
<cocktail>  Possibility of ordering of cocktails  0 (NO) / 1 (YES)
<conférence_hall>  Availability of a conference hall  0 (NO) / 1 (YES)
<disabled_room>  Availability of disabled room  0 (NO) / 1 (YES)
<eat_late>  Possibility of ordering / eating late  0 (NO) / 1 (YES)
<for_children>  Place / Structure dedicated to children
 0 (NO) / 1 (YES)
<garden>  Presence of a garden  0 (NO) / 1 (YES)
<good_value_menu>  Availability of a good value menu (less than 20 €)   0 (NO) / 1 (YES)
<hydrotherapy>  Possibility of a hydrotherapy  0 (NO) / 1 (YES)
<interesting_wine_list>  Presence of an interesting wine list  0 (NO) / 1 (YES)
<michelin_guide_selection>  Restaurant/Hotel selected by the Michelin Guide  0 (NO) / 1 (YES)
<parking>  Presence of a parking  0 (NO) / 1 (YES)
<pleasant>  Described as a pleasant spot  0 (NO) / 1 (YES)
<quiet>  Described as a quiet spot
 0 (NO) / 1 (YES)
<sake>  Availability of sake inside  0 (NO) / 1 (YES)
<sport>  Availability of sport infrastructure  0 (NO) / 1 (YES)
<valet>  Availability of a valet service
 0 (NO) / 1 (YES)
<no_dog>  Impossibility of bringing a dog  0 (NO) / 1 (YES)
<no_smoke>  Impossibility of smoking inside  0 (NO) / 1 (YES)

Editorial Guidelines

To access to editorial guidline of MICHELIN Guide and icons, you will need the login and password provided  by MICHELIN SUPPORT (login: XXXX_001 / password: XXXX) and go to the documentation section:

http://www.admin.viamichelin.com

PS

The "criteria" file in the "documentation" section, is only for version 1 of the API REST and JavaScript APIs.

Examples

Scenario 1:

Find 30 hotels from MICHELIN Guide at arround 1.5 km from Paris 75000. 

Preferred language: English.

 

http://apir.viamichelin.com/apir/2/findPoi.xml/HOTEL/eng?center=2.35:48.85&nb=30&dist=1500&source=HOTGR&filter=AGG.provider%20eq%20HOTGR&charset=UTF-8&ie=UTF-8&authKey=YourAuthKey 

 

Scenario 2 :

Find 10 restaurants from MICHELIN Guide 1 km at arround Paris 75000 

Prefered language: English.

http://apir.viamichelin.com/apir/2/findPoi.xml/RESTAURANT/eng?center=2.35:48.85&nb=10&dist=1000&source=RESGR&filter=AGG.provider%20eq%20RESGR&charset=UTF-8&ie=UTF-8&authKey=YourAuthKey