MyDistrictResource Resource

REST Web Service for getting data informations on places (localities, neighborhoods, ...)

GET /mydistrict

Retourne les données quartier, commune... d'un ou plusieurs emplacements.
Les emplacements peuvent être demandés par :

  • identifiant d'emplacement placeId. Les placeId sont issus du flux /places
    dans l'objet PlaceConverter
  • une latitude et une longitude
  • un code INSEE et un placeLevel type d'emplacement
    Par exemple, pour l'iris LES HALLES 1 (751010201) : level=iris&code=751010201&country=france

Request Parameters
name type description default constraints
apiKey header clé d'authentification de l'application (à partir de l'api en version 4)    
appId header identifiant de l'application Ex : com.geoimmo.com (réservé aux applications marques-blanches Geoimmo, à partir de l'api en version 4)    
userApiKey header clé d'authentification de l'utilisateur (à partir de l'api en version 4)    
country query pays France  
data query code(s) des données attendues séparés par des virgules. Le catalogue des données est fourni par le Web Service /mydistrict/list    
latitude query latitude de l'emplacement demandé   float
level query level   "airport" or "bakery" or "bank" or "bus_station" or "city_hall" or "college" or "commune" or "country" or "departement" or "ecole" or "grocery_or_supermarket" or "gym" or "hospital" or "hypermarches" or "iris" or "lodging" or "logicImmoBorough" or "logicImmoCity" or "logicImmoProvince" or "lycee" or "meal_takeaway" or "metroLine" or "metroStation" or "parking" or "pharmacy" or "post_office" or "quartier" or "region" or "rerLine" or "rerStation" or "restaurant" or "shopping_mall" or "sncf" or "superieur" or "tramLine" or "tramStation" or "transport" or "velib"
longitude query longitude de l'emplacement demandé   float
placeid query identifiant du (des) emplacement(s) demandés séparées par des virgules    
reference query référence (INSEE...)    
templateCommune query Texte descriptif de la commune avec balises au format {code-level} (par exemple {age-commune})    
templateIris query Texte descriptif du quartier avec balises au format {code-level} (par exemple {age-commune})    
Response Body
media type data type
application/json string (JSON)

Example

Request
GET /mydistrict
Accept: application/json
apiKey: ...
appId: ...
userApiKey: ...

              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...
                
              

GET /mydistrict/list

Liste le catalogue des données disponibles sur des emplacements quartiers, communes, ...

Response Body
media type data type
application/json WebServiceAnswerMyDistrictDataAvailable (JSON)

Example

Request
GET /mydistrict/list
Accept: application/json

              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "results" : [ {
    "theme" : {
      "name" : "...",
      "ordre" : 12345,
      "code" : "..."
    },
    "code" : "...",
    "name" : "...",
    "type" : "...",
    "unit" : "...",
    "comment" : "...",
    "values" : [ {
      "placeId" : 12345,
      "numericValue" : 12345.0,
      "formattedValue" : "..."
    }, {
      "placeId" : 12345,
      "numericValue" : 12345.0,
      "formattedValue" : "..."
    } ]
  }, {
    "theme" : {
      "name" : "...",
      "ordre" : 12345,
      "code" : "..."
    },
    "code" : "...",
    "name" : "...",
    "type" : "...",
    "unit" : "...",
    "comment" : "...",
    "values" : [ {
      "placeId" : 12345,
      "numericValue" : 12345.0,
      "formattedValue" : "..."
    }, {
      "placeId" : 12345,
      "numericValue" : 12345.0,
      "formattedValue" : "..."
    } ]
  } ],
  "total_results" : 12345,
  "nb_results" : 12345,
  "status" : "...",
  "error_message" : "..."
}