GET /search

A propos

Cette ressource permet de rechercher des données parmi les fichier importés et disponibles.
Une recherche s'effectue dans un ou plusieurs fichiers. Les fichiers doivent être spécifiés lors de la requête.

Certains critères de recherche sont communs à tout les fichiers. D'autres sont spécifiques à chaque fichier.
Consultez la section Fichiers pour plus de détails.

La recherche s'effectue par défault sur la dernière année disponible pour chaque fichier. Vous pouvez cependant sélectionner une autre année dans les critères de recherche.

La liste des résultats est paginée à raison de 50 éléments par page.

Les résultats ont des propriétés différentes selon le fichier selectionné.
Consultez la section Fichiers pour plus de détails.

URL

https://api.mon-territoire.fr/search

Informations

Disponibilité 0.1.0
Authentification requise Authorization Code
Code HTTP attendu 200

Paramètres

file String|Array requis Fichier(s) de recherche
filter String|Object requis Critère(s) de recherche
page Integer optionel Numéro de la page de résultat

Réponse

La réponse est un objet de type clé/valeur :

  • La clé correspond au fichier de recherche.
  • La valeur est un objet incluant le nombre total de résultats, les informations de pagination et la page de résultat.
total Integer Nombre de résultats trouvés (toutes pages confondues)
page Integer Numéro de la page selectionnée
results Array Tableau des résultats dont la structure dépend du fichier sélectionné.
Consultez la section Fichiers pour plus de détails.

Exemples

Recherche dans un fichier

$ http -jv GET https://api.mon-territoire.fr/search \
    Authorization:"Bearer dGCMv3RWEcgWjgeKS5D6IUw0gv2VKmaPqJzZg9mM_3A" \
    Accept:"application/json"
    file='CBT' \
    filter='Fiscalité & Territoire'
GET /search HTTP/1.1
Accept: application/json
Authorization: Bearer dGCMv3RWEcgWjgeKS5D6IUw0gv2VKmaPqJzZg9mM_3A
Content-Type: application/json; charset=utf-8

{
  "file":   "CBT",
  "filter": "Fiscalité & Territoire"
}

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

{
  "CBT": {
    "total": 1,
    "page":  1,
    "results": [
      {
        "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":          "https://api.mon-territoire.fr/v0/ca/locaux/201834017220219027173"
      }
    ]
  }
}

Recherche dans plusieurs fichiers

$ http -jv GET https://api.mon-territoire.fr/search \
    Authorization:"Bearer dGCMv3RWEcgWjgeKS5D6IUw0gv2VKmaPqJzZg9mM_3A" \
    Accept:"application/json"
    file:='["CBT","CFE"]' \
    filter:='{ "nom": "Fiscalité & Territoire" }'
GET /search HTTP/1.1
Accept: application/json
Authorization: Bearer dGCMv3RWEcgWjgeKS5D6IUw0gv2VKmaPqJzZg9mM_3A
Content-Type: application/json; charset=utf-8

{
  "file": [
    "CBT",
    "CFE"
  ],
  "filter": {
    "nom": "Fiscalité & Territoire"
  }
}

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

{
  "CBT": {
    "total": 1,
    "page":  1,
    "results": [
      {
        "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":          "https://api.mon-territoire.fr/v0/ca/locaux/201834017220219027173"
      }
    ]
  },
  "CFE": {
    "total": 1,
    "page":  1,
    "results": [
      {
        "id":           '2018340172040206',
        "annee":        2018,
        "commune":      "Montpellier",
        "codcom":       "340172",
        "nocpte":       "040206"
        "siren":        "511022394",
        "nom":          "FISCALITE ET TERRITOIRE",
        "adresse":      "84 Rue Maurice Béjart",
        "cfe":          10245,
        "url":          "https://api.mon-territoire.fr/v0/cfe/2018340172040206"
      }
    ]
  }
}

Recherche sans résultats

$ http -jv GET https://api.mon-territoire.fr/search \
    Authorization:"Bearer dGCMv3RWEcgWjgeKS5D6IUw0gv2VKmaPqJzZg9mM_3A" \
    Accept:"application/json"
    file='CBT' \
    filter='sfkhjgkzjshdg'
GET /search HTTP/1.1
Accept: application/json
Authorization: Bearer dGCMv3RWEcgWjgeKS5D6IUw0gv2VKmaPqJzZg9mM_3A
Content-Type: application/json; charset=utf-8

{
  "file":   "CBT",
  "filter": "sfkhjgkzjshdg"
}

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

{
  "CBT": {
    "total":   0,
    "page":    1,
    "results": []
  }
}