GET /datasets/:id

A propos

Cette ressource permet d'accéder à différents formats de réprésentation d'un jeu de données.

URL

https://api.mon-territoire.fr/v0/datasets/:id

Informations

Disponibilité 0.5.2
Authentification requise Authorization Code ou Client Credentials
Formats disponibles JSON, GeoJSON & CSV
Code HTTP attendu 200 ou 302 (selon le format)

Notes au sujet de l'obtention des fichiers CSV

Les fichiers CSV sont stockés sur un serveur de fichiers statiques tiers.
Cette ressource vous permet d'obtenir une URL temporaire pour télécharger un fichier CSV depuis ce serveur. Plusieurs méthodes et options sont disponibles pour obtenir cette URL.

- Redirection

En interrogeant la ressource au format CSV, vous obtiendrez l'URL dans l'en-tête de réponse Location

- Obtention de l'URL en JSON

Si votre client ne gère pas correctement la redirection HTTP, vous pouvez obtenir l'URL en JSON, en ajoutant le paramètre ?csv à l'URL.

- Encodage du fichier

Par défaut, le fichier retourné est encodé en UTF-8.
Pour intégrer le fichier dans Excel, vous devez demander un fichier au format Latin-9 (ISO-8859-15) en ajoutant le paramètre ?encoding=iso-8859-15 à l'URL.
La ressource accept aussi l'en-tête Accept-Charset à la place du paramètre si la requête est envoyée au format CSV.

- Expiration de l'URL

Par défaut, l'URL retournée à une validité d'une heure.
Pour obtenir une URL avec une durée de validité plus longue, ajoutez le paramètre ?expires=7200 à l'URL.
La valeur numérique est exprimée en secondes.

- Obtention d'un fichier CSV avec FME Workbench

Consultez les étapes de configuration du workbench.

Exemple d'obtention des données

$ http -jv GET https://api.mon-territoire.fr/v0/datasets/95ade69a-6aff-45ef-bafd-06052e5d3b86 \
    Authorization:"Bearer dGCMv3RWEcgWjgeKS5D6IUw0gv2VKmaPqJzZg9mM_3A" \
    Accept:"application/json"
GET /v0/datasets/95ade69a-6aff-45ef-bafd-06052e5d3b86 HTTP/1.1
Accept: application/json
Authorization: Bearer dGCMv3RWEcgWjgeKS5D6IUw0gv2VKmaPqJzZg9mM_3A
Content-Type: application/json; charset=utf-8

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "title":   "Locaux de catégories 7 & 8",
  "version": 3
  "total":   2567,
  "page":    1,
  "locals":  [
    {
      "id":           "201834017220219027173",
      "annee":        2018,
      "commune":      "Montpellier",
      "codcom":       "340172",
      "invariant":    "20219027173 X",
      "parcelle":     "AB 0025",
      "proprietaire": "SASU FISCALITE ET TERRITOIRE",
      "adresse":      "84 RUE MAURICE BEJART",
      "url":          /v0/ca/locaux/201834017220219027173
    },
    ...
  ]
}

Exemple d'obtention d'un fichier CSV

$ http -v GET https://api.mon-territoire.fr/v0/datasets/95ade69a-6aff-45ef-bafd-06052e5d3b86 \
    Authorization:"Bearer dGCMv3RWEcgWjgeKS5D6IUw0gv2VKmaPqJzZg9mM_3A" \
    Accept:"text/csv"
GET /v0/datasets/95ade69a-6aff-45ef-bafd-06052e5d3b86 HTTP/1.1
Accept: text/csv
Authorization: Bearer dGCMv3RWEcgWjgeKS5D6IUw0gv2VKmaPqJzZg9mM_3A

HTTP/1.1 302 Found
Location: https://static.mon-territoire.fr/datasets/95ade69a-6aff-45ef-bafd-06052e5d3b86-v3.csv?Signature=6kq6XtzBt8zja2tq7S%2FJaAPy90U%3D&Expires=1566213533

Exemple d'obtention d'un fichier CSV avec un encodage Latin 9

$ http -v GET https://api.mon-territoire.fr/v0/datasets/95ade69a-6aff-45ef-bafd-06052e5d3b86 \
    Authorization:"Bearer dGCMv3RWEcgWjgeKS5D6IUw0gv2VKmaPqJzZg9mM_3A" \
    Accept:"text/csv" \
    Accept-Charset="iso-8859-15"
GET /v0/datasets/95ade69a-6aff-45ef-bafd-06052e5d3b86?csv&encoding=iso-8859-15&expires=7200 HTTP/1.1
Accept: application/json
Accept-Charset: "iso-8859-15"
Authorization: Bearer dGCMv3RWEcgWjgeKS5D6IUw0gv2VKmaPqJzZg9mM_3A

HTTP/1.1 302 Found
Location: https://static.mon-territoire.fr/datasets/95ade69a-6aff-45ef-bafd-06052e5d3b86-v3-iso8859.csv?Signature=6kq6XtzBt8zja2tq7S%2FJaAPy90U%3D&Expires=1566213533

Exemple d'obtention d'un fichier CSV avec une requête JSON

$ http -v GET https://api.mon-territoire.fr/v0/datasets/95ade69a-6aff-45ef-bafd-06052e5d3b86\?csv \
    Authorization:"Bearer dGCMv3RWEcgWjgeKS5D6IUw0gv2VKmaPqJzZg9mM_3A" \
    Accept:"application/json"
GET /v0/datasets/95ade69a-6aff-45ef-bafd-06052e5d3b86?csv HTTP/1.1
Accept: application/json
Authorization: Bearer dGCMv3RWEcgWjgeKS5D6IUw0gv2VKmaPqJzZg9mM_3A

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "title":    "Locaux de catégories 7 & 8",
  "version":  3,
  "encoding": "UTF-8",
  "location": "https://static.mon-territoire.fr/datasets/95ade69a-6aff-45ef-bafd-06052e5d3b86-v3.csv?Signature=6kq6XtzBt8zja2tq7S%2FJaAPy90U%3D&Expires=1566213533"
}

Exemple d'obtention d'un fichier CSV avec une requête JSON et d'autres paramètres

$ http -v GET https://api.mon-territoire.fr/v0/datasets/95ade69a-6aff-45ef-bafd-06052e5d3b86\?csv \
    Authorization:"Bearer dGCMv3RWEcgWjgeKS5D6IUw0gv2VKmaPqJzZg9mM_3A" \
    Accept:"application/json" \
    encoding==iso-8859-15 \
    expires==7200
GET /v0/datasets/95ade69a-6aff-45ef-bafd-06052e5d3b86?csv&encoding=iso-8859-15&expires=7200 HTTP/1.1
Accept: application/json
Authorization: Bearer dGCMv3RWEcgWjgeKS5D6IUw0gv2VKmaPqJzZg9mM_3A

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "title":    "Locaux de catégories 7 & 8",
  "version":  3,
  "encoding": "ISO-8859-15",
  "location": "https://static.mon-territoire.fr/datasets/95ade69a-6aff-45ef-bafd-06052e5d3b86-v3-iso8859.csv?Signature=6kq6XtzBt8zja2tq7S%2FJaAPy90U%3D&Expires=1566217133
}