spatial

Spatial references

List each zone for a given level with their datasets count

get

Paramètres de chemin

levelstringRequis

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

typestring · enumRequisExample: FeatureCollectionValeurs possibles:

get/spatial/coverage/{level}/

GET /api/1/spatial/coverage/{level}/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

[
  {
    "features": [
      {
        "geometry": {
          "coordinates": [
            {}
          ],
          "type": "Point"
        },
        "id": "text",
        "properties": {},
        "type": "Feature"
      }
    ],
    "type": "FeatureCollection"
  }
]

List all known spatial granularities

get

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

idstringRequis

The granularity identifier

namestringRequis

The granularity name

get/spatial/granularities/

GET /api/1/spatial/granularities/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

[
  {
    "id": "text",
    "name": "text"
  }
]

List all known levels

get

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

idstringRequis

The level identifier

namestringRequis

The level name

get/spatial/levels/

GET /api/1/spatial/levels/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

[
  {
    "id": "text",
    "name": "text"
  }
]

Fetch a zone

get

Paramètres de chemin

idstringRequis

A zone identifier

Réponses

200

Success

Aucun contenu

get/spatial/zone/{id}/

GET /api/1/spatial/zone/{id}/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

Aucun contenu

Fetch datasets for a given zone

get

Paramètres de chemin

idstringRequis

A zone identifier

Paramètres de requête

dynamicbooleanOptionnel

Append dynamic datasets

sizeintegerOptionnel

The amount of datasets to fetch

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

classstringRequis

The object class

idstringRequis

The object unique identifier

get/spatial/zone/{id}/datasets/

GET /api/1/spatial/zone/{id}/datasets/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

{
  "class": "text",
  "id": "text"
}

Geospatial zones suggest endpoint using mongoDB contains

get

Paramètres de requête

qstringRequis

The string to autocomplete/suggest

sizeintegerOptionnel

The amount of suggestion to fetch

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

codestringRequis

The territory main code

idstringRequis

The territory identifier

levelstringRequis

The territory administrative level

namestringRequis

The territory name

uristringRequis

The zone uri

get/spatial/zones/suggest/

GET /api/1/spatial/zones/suggest/?q=text HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

[
  {
    "code": "text",
    "id": "text",
    "level": "text",
    "name": "text",
    "uri": "text"
  }
]

Fetch a zone list as GeoJSON

get

Paramètres de chemin

idsstringRequis

A zone identifiers list (comma separated)

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

typestring · enumRequisExample: FeatureCollectionValeurs possibles:

get/spatial/zones/{ids}/

GET /api/1/spatial/zones/{ids}/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

{
  "features": [
    {
      "geometry": {
        "coordinates": [
          {}
        ],
        "type": "Point"
      },
      "id": "text",
      "properties": {},
      "type": "Feature"
    }
  ],
  "type": "FeatureCollection"
}