Points de terminaison d'API REST pour Sites Geographiques

PaginateSitesGeographiques

Liste paginée des sites géographiques

Récupération de la liste des sites géographiques selon des critères de recherche.

Cet endpoint nécessite l'en-tête Metarisc-Org-Id pour identifier l'organisation faisant l'appel. Le résultat de l'appel sera donc spécifique à cette organisation.

Paramètres

libelle string

Filtre sur le libellé du site géographique.

256 max length

Paramètres supplémentaires

page integer

Le numéro de la page de résultats demandé.

format : int32 ≥=1 ≤=999999 default: 1

per_page integer

Limite le nombre d'objets retournés par une page. La limite est comprise entre 1 et 100, la valeur par défaut étant de 10.

format : int32 ≥=1 ≤=100 default: 10

sort string

Propriété sur laquelle trier les résultats. L'ordre de tri par défaut est croissant (asc) sauf si la propriété est préfixée par un trait d'union (-), auquel cas l'ordre de tri sera décroissant (desc).

Propriété sur lesquelles les résultats seront triés.

pattern ^-?\w*$ 256 max length default: libelle

Valeurs possibles
libelle
ordre croissant sur libelle (asc).
-libelle
ordre décroissant sur libelle (desc).

Réponses

200 OK

Retourne un dictionnaire avec une propriété data contenant un tableau d'Objet Site Géographique (en respectant les limites de pagination). Chaque entrée du tableau constitue un Objet Site Géographique distinct. Si aucun élément n'est disponible, le tableau résultant sera vide.

GET /sites_geographiques

data array of object required

Tableau d'objets contenu dans la page.

100 max items

id string required

Identifiant unique de l'objet.

format : uuid 36 fixed length

libelle string required

Libellé du site géographique.

256 max length

geojson string required

GeoJSON représentant la géométrie du site géographique. Elle est calculée à partir des géométries des ERP qui le composent.

8192 max length

erp_periodicite_contrainte integer required nullable

Si le site contient des ERP, alors cette propriété indique la périodicité la plus contrainte des ERP. Cela permet d'organiser les visites périodiques des ERP.

format : int32 ≥=0 ≤=60 multiple of: 12

notes string required

Note associée au site géographique. Elle est utilisée pour indiquer des informations importantes sur le site.

8192 max length

type string required

Type de site géographique.

Valeurs possibles
fonctionnel
Site géographique défini par l'utilisateur pour regrouper des ERP.
géographique
Site géographique défini par des critères géographiques pour regrouper des ERP.

meta object required

Métadonnées de la pagination.

pagination object required

Ensemble d'informations liées à une réponse paginée.

total integer required

Nombre total d'objets.

format : int32 ≥=0 ≤=999999

count integer required

Nombre d'objets contenu dans la page courante.

format : int32 ≥=0 ≤=999999

per_page integer required

Nombre d'objets pouvant être retournés par une page

format : int32 ≥=1 ≤=100

current_page integer required

Numéro de la page courante.

format : int32 ≥=1 ≤=999999

total_pages integer required

Nombres de pages disponibles.

format : int32 ≥=1 ≤=999999

PostSitesGeographiques

Créer un site géographique

Création d'un site géographique.

Cet endpoint nécessite l'en-tête Metarisc-Org-Id pour identifier l'organisation faisant l'appel. Le résultat de l'appel sera donc spécifique à cette organisation.

Paramètres du corps de la requête

libelle string required

Libellé du site géographique.

256 max length

notes string

Note associée au site géographique. Elle est utilisée pour indiquer des informations importantes sur le site.

8192 max length

type string required

Type de site géographique.

Valeurs possibles
fonctionnel
Site géographique défini par l'utilisateur pour regrouper des ERP.
géographique
Site géographique défini par des critères géographiques pour regrouper des ERP.

Réponses

201 OK

Retourne l'Objet Site Géographique créé.

POST /sites_geographiques

id string required

Identifiant unique de l'objet.

format : uuid 36 fixed length

libelle string required

Libellé du site géographique.

256 max length

geojson string required

GeoJSON représentant la géométrie du site géographique. Elle est calculée à partir des géométries des ERP qui le composent.

8192 max length

erp_periodicite_contrainte integer required nullable

Si le site contient des ERP, alors cette propriété indique la périodicité la plus contrainte des ERP. Cela permet d'organiser les visites périodiques des ERP.

format : int32 ≥=0 ≤=60 multiple of: 12

notes string required

Note associée au site géographique. Elle est utilisée pour indiquer des informations importantes sur le site.

8192 max length

type string required

Type de site géographique.

Valeurs possibles
fonctionnel
Site géographique défini par l'utilisateur pour regrouper des ERP.
géographique
Site géographique défini par des critères géographiques pour regrouper des ERP.
DeleteSiteGeographiqueSitesGeographiques

Suppression d'un site géographique

Suppression d'un site géographique (cette opération n'impacte pas les ERP liés).

Cet endpoint nécessite l'en-tête Metarisc-Org-Id pour identifier l'organisation faisant l'appel. Le résultat de l'appel sera donc spécifique à cette organisation.

Réponses

204 No Content

Retourne une réponse vide.

DELETE /sites_geographiques/{site_geographique_id}

GetSiteGeographiqueSitesGeographiques

Détails d'un site géographique

Récupération de l'ensemble des données d'un site géographique.

Cet endpoint nécessite l'en-tête Metarisc-Org-Id pour identifier l'organisation faisant l'appel. Le résultat de l'appel sera donc spécifique à cette organisation.

Réponses

200 OK

Retourne un Objet Site Géographique contenant les données demandées.

GET /sites_geographiques/{site_geographique_id}

id string required

Identifiant unique de l'objet.

format : uuid 36 fixed length

libelle string required

Libellé du site géographique.

256 max length

geojson string required

GeoJSON représentant la géométrie du site géographique. Elle est calculée à partir des géométries des ERP qui le composent.

8192 max length

erp_periodicite_contrainte integer required nullable

Si le site contient des ERP, alors cette propriété indique la périodicité la plus contrainte des ERP. Cela permet d'organiser les visites périodiques des ERP.

format : int32 ≥=0 ≤=60 multiple of: 12

notes string required

Note associée au site géographique. Elle est utilisée pour indiquer des informations importantes sur le site.

8192 max length

type string required

Type de site géographique.

Valeurs possibles
fonctionnel
Site géographique défini par l'utilisateur pour regrouper des ERP.
géographique
Site géographique défini par des critères géographiques pour regrouper des ERP.
PatchSiteGeographiqueSitesGeographiques

Mise à jour d'un site géographique

Mise à jour d'un site géographique.

Cet endpoint nécessite l'en-tête Metarisc-Org-Id pour identifier l'organisation faisant l'appel. Le résultat de l'appel sera donc spécifique à cette organisation.

Paramètres du corps de la requête

libelle string

Libellé du site géographique.

256 max length

notes string nullable

Note associée au site géographique. Elle est utilisée pour indiquer des informations importantes sur le site.

8192 max length

type string

Type de site géographique.

Valeurs possibles
fonctionnel
Site géographique défini par l'utilisateur pour regrouper des ERP.
géographique
Site géographique défini par des critères géographiques pour regrouper des ERP.

Réponses

200 OK

Retourne un Objet Site Géographique contenant les données demandées.

PATCH /sites_geographiques/{site_geographique_id}

id string required

Identifiant unique de l'objet.

format : uuid 36 fixed length

libelle string required

Libellé du site géographique.

256 max length

geojson string required

GeoJSON représentant la géométrie du site géographique. Elle est calculée à partir des géométries des ERP qui le composent.

8192 max length

erp_periodicite_contrainte integer required nullable

Si le site contient des ERP, alors cette propriété indique la périodicité la plus contrainte des ERP. Cela permet d'organiser les visites périodiques des ERP.

format : int32 ≥=0 ≤=60 multiple of: 12

notes string required

Note associée au site géographique. Elle est utilisée pour indiquer des informations importantes sur le site.

8192 max length

type string required

Type de site géographique.

Valeurs possibles
fonctionnel
Site géographique défini par l'utilisateur pour regrouper des ERP.
géographique
Site géographique défini par des critères géographiques pour regrouper des ERP.