Points de terminaison d'API REST pour Tournées DECI
Liste paginée des tournées DECI
Liste des tournées DECI.
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é
256 max length
pei string
Filtre sur un PEI lié à la tournée
format : uuid 36 fixed length
periode string
Filtre sur les dates
pattern ^(.*)\/(.*)$ 21 min length 100 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
Réponses
200 OK
Retourne un dictionnaire avec une propriété data contenant un tableau d'Objet Tournée Deci (en respectant les limites de pagination). Chaque entrée du tableau constitue un Objet Tournée Deci distinct. Si aucun élément n'est disponible, le tableau résultant sera vide.
GET /tournees_deci
data array of object required
Tableau d'objets contenu dans la page.
100 max items
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
Ajout d'une Tournée DECI
Ajout d'une nouvelle tournée DECI.
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
Réponses
200 OK
Retourne un Objet Tournée Deci contenant les données demandées.
POST /tournees_deci
Déclenchement d'une Tournée DECI depuis un modèle
L'appel à ce endpoint permet de déclencher une nouvelle tournée DECI depuis un modèle donné. L'ID de la tournée DECI doit correspondre à une Tournée Modèle, sinon l'endpoint retournera une erreur.
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 Tournée Deci Simple contenant les données demandées.
POST /tournees_deci/{tournee_deci_id}/declencher
id string required
Identifiant unique de l'objet.
format : uuid 36 fixed length
libelle string required
Nom d'identification de la tournée.
256 max length
description string required nullable
Une chaîne de caractères arbitraire rattachée à l'objet. Souvent utile pour affichage aux utilisateurs.
8192 max length
date_de_creation string required
Date de création de la tournée.
format : date-time 20 min length 50 max length
type string required
Type de la tournée DECI.
| Valeurs possibles |
|---|
tournee_deciTournée DECI simple. |
pourcentage number required nullable
Pourcentage de complétion de la tournée (en %).
format : float ≥=0 ≤=1
est_terminee boolean required nullable
État de la complétion de la tournée.
date_de_debut string required
Date de début de la tournée.
format : date-time 20 min length 50 max length
date_de_fin string required
Date de fin de la tournée.
format : date-time 20 min length 50 max length
modele object required nullable
Si la Tournée DECI a été créé depuis un modèle, son modèle est rattaché.
id string required
Identifiant unique de l'objet.
format : uuid 36 fixed length
libelle string required
Nom d'identification de la tournée.
256 max length
description string required nullable
Une chaîne de caractères arbitraire rattachée à l'objet. Souvent utile pour affichage aux utilisateurs.
8192 max length
date_de_creation string required
Date de création de la tournée.
format : date-time 20 min length 50 max length
type string required
Type de la tournée DECI.
| Valeurs possibles |
|---|
tournee_deci_modeleModèle de tournée DECI. |
mois_debut integer required
Numéro du mois de début de la tournée programmée
format : int32 ≥=1 ≤=12
mois_fin integer required
Numéro de mois de fin de la tournéee programmée
format : int32 ≥=1 ≤=12
Liste paginée des documents
Récupération de la liste des documents.
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 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
Réponses
200 OK
Retourne un dictionnaire avec une propriété data contenant un tableau d'Objet Piece Jointe (en respectant les limites de pagination). Chaque entrée du tableau constitue un Objet Piece Jointe distinct. Si aucun élément n'est disponible, le tableau résultant sera vide.
GET /tournees_deci/{tournee_deci_id}/documents
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
url string required
Point de stockage du fichier.
format : uri 512 max length
nom string required
Nom du fichier joint.
256 max length
description string required nullable
Description du fichier joint.
8192 max length
type string required
Type de la pièce jointe.
| Valeurs possibles |
|---|
photoPhoto. |
planPlan. |
annexeAnnexe. |
diversDivers. |
rapport de vérification réglementaire après travauxRapport de vérification réglementaire après travaux. |
est_sensible boolean required
Information permettant de savoir si le contenu du document doit être considéré comme sensible par Metarisc.
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
Ajout d'un document
Ajout d'un document.
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
url string required
Point de stockage du fichier.
format : uri 512 max length
nom string required
Nom du fichier joint.
256 max length
description string nullable
Description du fichier joint.
8192 max length
type string required
Type de la pièce jointe.
| Valeurs possibles |
|---|
photoPhoto. |
planPlan. |
annexeAnnexe. |
diversDivers. |
rapport de vérification réglementaire après travauxRapport de vérification réglementaire après travaux. |
est_sensible boolean required
Information permettant de savoir si le contenu du document doit être considéré comme sensible par Metarisc.
Réponses
201 OK
Retourne l'Objet Piece Jointe créé.
POST /tournees_deci/{tournee_deci_id}/documents
id string required
Identifiant unique de l'objet.
format : uuid 36 fixed length
url string required
Point de stockage du fichier.
format : uri 512 max length
nom string required
Nom du fichier joint.
256 max length
description string required nullable
Description du fichier joint.
8192 max length
type string required
Type de la pièce jointe.
| Valeurs possibles |
|---|
photoPhoto. |
planPlan. |
annexeAnnexe. |
diversDivers. |
rapport de vérification réglementaire après travauxRapport de vérification réglementaire après travaux. |
est_sensible boolean required
Information permettant de savoir si le contenu du document doit être considéré comme sensible par Metarisc.
Détails de la tournée DECI
Récupération des détails de la tournée DECI.
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 Tournée Deci contenant les données demandées.
GET /tournees_deci/{tournee_deci_id}
Mise à jour de la tournée DECI
Mise à jour de la tournée DECI en définissant les valeurs des paramètres transmis. Tous les paramètres non fournis resteront inchangé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.
Paramètres du corps de la requête
Réponses
200 OK
Retourne un Objet Tournée Deci contenant les données demandées.
POST /tournees_deci/{tournee_deci_id}
Liste paginée des PEI liés à la tournée DECI
Récupération de la liste des contrôles PEI liés à la tournée DECI.
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 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
Réponses
200 OK
Retourne un dictionnaire avec une propriété data contenant un tableau d'Objet Tournée Deci PEI (en respectant les limites de pagination). Chaque entrée du tableau constitue un Objet Tournée Deci PEI distinct. Si aucun élément n'est disponible, le tableau résultant sera vide.
GET /tournees_deci/{tournee_deci_id}/pei
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
date_du_controle string required nullable
Date à laquelle le contrôle a été effectué.
format : date-time 20 min length 50 max length
hydraulique object required nullable
Informations sur les essais hydrauliques procédés le jour du contrôle.
volume number required nullable
Volume relevé lors des essais / contrôle hydrauliques.
format : float
debit_1bar number required nullable
Débit à 1 bar de pression relevé lors des essais / contrôle hydrauliques.
format : float
pression number required nullable
Pression relevée lors des essais / contrôle hydrauliques.
format : float
pression_statique number required nullable
Pression statique relevée lors des essais / contrôle hydrauliques.
format : float
debit_gueule_bee number required nullable
Débit gueule bée relevé lors des essais / contrôle hydrauliques.
format : float
liste_anomalies array of object required
Liste des anomalies posées ou à lever suite à ce contrôle.
255 max items
anomalie object required
Informations sur l'anomalie liée.
code integer required
Référence codifiée de l'anomalie.
format : int32 ≥=0 ≤=999999
texte string required
Description de l'anomalie.
8192 max length
indice_de_gravite integer required
L'indice de gravité permet de classifier l'impact d'une anomalie sur la vie d'un PEI.
format : int32 ≥=0 ≤=2
| Valeurs possibles |
|---|
0Réserve. |
1Anomalie. |
2Anomalie bloquante. |
a_lever boolean required
Si l'anomalie est à lever.
essais_engin_utilise string required nullable
Engin utilisé pour les essais hydrauliques.
| Valeurs possibles |
|---|
aucunAucun engin utilisé. |
fptFourgon pompe-tonne. |
mprMotopompe remorquable. |
ccfCamion-citerne feux de forêt. |
pei object required
PEI lié au contrôle.
id string required
Identifiant unique de l'objet.
format : uuid 36 fixed length
date_de_realisation string required
Date à laquelle le PEI a intégré Metarisc.
format : date-time 20 min length 50 max length
date_de_derniere_mise_a_jour string required nullable
Date de la dernière mise à jour du PEI.
format : date-time 20 min length 50 max length
descriptif_technique object
Descriptif technique actuel du PEI.
implantation object required
Implantation du PEI sous la forme d'une adresse postale.
code_postal string required nullable
Le code postal en France est une suite de cinq chiffres dont les deux premiers correspondent au département.
pattern ^(?:0[1-9]|[1-8]\d|9[0-8])\d{3}$ 5 max length
commune string required nullable
Nom de la commune.
256 max length
voie string required nullable
Libellé de la voie et de son type (exemple : "rue du point du jour").
256 max length
code_insee string required nullable
Code unique attribué à chaque commune de France.
pattern ^([013-9]\d|2[AB1-9])\d{3}$ 5 max length
arrondissement string required nullable
Le "code arrondissement" contient un chiffre (à partir de 1). Chaque arrondissement français peut ainsi être identifié par un code unique à 3 (pour la métropole) ou 4 (pour l'outre-mer) chiffres, dont respectivement les deux ou trois premiers identifient le département. Ce code est une chaine de caractère car il peut être alphanumérique (exemple : 2A1 pour AJACCIO).
256 max length
arrondissement_municipal string required nullable
L'arrondissement municipal est une subdivision territoriale des communes.
256 max length
latitude number required nullable
La latitude est une coordonnée géographique représentée par une valeur angulaire, expression de la position d'un point sur Terre, au nord ou au sud de l'équateur qui est le plan de référence. La latitude est une mesure angulaire ; elle varie entre la valeur 0° à l'équateur et 90° aux pôles.
format : double ≥=-90 ≤=90
longitude number required nullable
La longitude d'un point sur Terre est une coordonnée géographique représentée par une valeur angulaire, expression du positionnement est-ouest du point. Une longitude se mesure par rapport à une référence arbitraire qui, sur Terre, est généralement le méridien de Greenwich.
format : double ≥=-180 ≤=180
localisation_operationnelle string required nullable
Complément d'adresse à destination des services de secours.
256 max length
complement string required nullable
Complément d'adresse.
256 max length
numero string required
Identifiant MRISC unique généré par l'application.
512 max length
numero_compteur string required nullable
Le numéro de série du compteur (PIBI).
256 max length
numero_serie_appareil string required nullable
Numéro de série du PEI (si disponible).
256 max length
references_exterieures array of object required
Références externes du PEI.
25 max items
titre string required
Titre de la référence extérieure.
256 max length
valeur string required
La valeur de la référence extérieure.
256 max length
est_controle boolean required
État du contrôle.
ordre integer required
L'ordre du contrôle dans le livret de tournée.
format : int32 ≥=1 ≤=255
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
Ajout d'un PEI sur la tournée DECI
Ajout d'un PEI sur la tournée DECI.
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
pei_id string required
Identifiant du PEI à lier au contrôle.
format : uuid 36 fixed length
Réponses
200 OK
Retourne un Objet Tournée Deci PEI contenant les données demandées.
POST /tournees_deci/{tournee_deci_id}/pei
id string required
Identifiant unique de l'objet.
format : uuid 36 fixed length
date_du_controle string required nullable
Date à laquelle le contrôle a été effectué.
format : date-time 20 min length 50 max length
hydraulique object required nullable
Informations sur les essais hydrauliques procédés le jour du contrôle.
volume number required nullable
Volume relevé lors des essais / contrôle hydrauliques.
format : float
debit_1bar number required nullable
Débit à 1 bar de pression relevé lors des essais / contrôle hydrauliques.
format : float
pression number required nullable
Pression relevée lors des essais / contrôle hydrauliques.
format : float
pression_statique number required nullable
Pression statique relevée lors des essais / contrôle hydrauliques.
format : float
debit_gueule_bee number required nullable
Débit gueule bée relevé lors des essais / contrôle hydrauliques.
format : float
liste_anomalies array of object required
Liste des anomalies posées ou à lever suite à ce contrôle.
255 max items
anomalie object required
Informations sur l'anomalie liée.
code integer required
Référence codifiée de l'anomalie.
format : int32 ≥=0 ≤=999999
texte string required
Description de l'anomalie.
8192 max length
indice_de_gravite integer required
L'indice de gravité permet de classifier l'impact d'une anomalie sur la vie d'un PEI.
format : int32 ≥=0 ≤=2
| Valeurs possibles |
|---|
0Réserve. |
1Anomalie. |
2Anomalie bloquante. |
a_lever boolean required
Si l'anomalie est à lever.
essais_engin_utilise string required nullable
Engin utilisé pour les essais hydrauliques.
| Valeurs possibles |
|---|
aucunAucun engin utilisé. |
fptFourgon pompe-tonne. |
mprMotopompe remorquable. |
ccfCamion-citerne feux de forêt. |
pei object required
PEI lié au contrôle.
id string required
Identifiant unique de l'objet.
format : uuid 36 fixed length
date_de_realisation string required
Date à laquelle le PEI a intégré Metarisc.
format : date-time 20 min length 50 max length
date_de_derniere_mise_a_jour string required nullable
Date de la dernière mise à jour du PEI.
format : date-time 20 min length 50 max length
descriptif_technique object
Descriptif technique actuel du PEI.
implantation object required
Implantation du PEI sous la forme d'une adresse postale.
code_postal string required nullable
Le code postal en France est une suite de cinq chiffres dont les deux premiers correspondent au département.
pattern ^(?:0[1-9]|[1-8]\d|9[0-8])\d{3}$ 5 max length
commune string required nullable
Nom de la commune.
256 max length
voie string required nullable
Libellé de la voie et de son type (exemple : "rue du point du jour").
256 max length
code_insee string required nullable
Code unique attribué à chaque commune de France.
pattern ^([013-9]\d|2[AB1-9])\d{3}$ 5 max length
arrondissement string required nullable
Le "code arrondissement" contient un chiffre (à partir de 1). Chaque arrondissement français peut ainsi être identifié par un code unique à 3 (pour la métropole) ou 4 (pour l'outre-mer) chiffres, dont respectivement les deux ou trois premiers identifient le département. Ce code est une chaine de caractère car il peut être alphanumérique (exemple : 2A1 pour AJACCIO).
256 max length
arrondissement_municipal string required nullable
L'arrondissement municipal est une subdivision territoriale des communes.
256 max length
latitude number required nullable
La latitude est une coordonnée géographique représentée par une valeur angulaire, expression de la position d'un point sur Terre, au nord ou au sud de l'équateur qui est le plan de référence. La latitude est une mesure angulaire ; elle varie entre la valeur 0° à l'équateur et 90° aux pôles.
format : double ≥=-90 ≤=90
longitude number required nullable
La longitude d'un point sur Terre est une coordonnée géographique représentée par une valeur angulaire, expression du positionnement est-ouest du point. Une longitude se mesure par rapport à une référence arbitraire qui, sur Terre, est généralement le méridien de Greenwich.
format : double ≥=-180 ≤=180
localisation_operationnelle string required nullable
Complément d'adresse à destination des services de secours.
256 max length
complement string required nullable
Complément d'adresse.
256 max length
numero string required
Identifiant MRISC unique généré par l'application.
512 max length
numero_compteur string required nullable
Le numéro de série du compteur (PIBI).
256 max length
numero_serie_appareil string required nullable
Numéro de série du PEI (si disponible).
256 max length
references_exterieures array of object required
Références externes du PEI.
25 max items
titre string required
Titre de la référence extérieure.
256 max length
valeur string required
La valeur de la référence extérieure.
256 max length
est_controle boolean required
État du contrôle.
ordre integer required
L'ordre du contrôle dans le livret de tournée.
format : int32 ≥=1 ≤=255