Points de terminaison d'API REST pour Controles PEI
Suppression du contrôle PEI
Suppression du contrôle PEI 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
204 No Content
Retourne une réponse vide.
DELETE /controles_pei/{pei_id}
Détail du PEI contrôlé
Récupération des détails liés au contrôle d'un PEI d'une tournée.
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 PEI contenant les données demandées.
GET /controles_pei/{pei_id}
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
Mise à jour du PEI contrôlé
Mise à jour du PEI contrôlé 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
date_du_controle string
Date à laquelle le contrôle a été effectué.
format : date-time 20 min length 50 max length
hydraulique object
Informations sur les essais hydrauliques procédés le jour du contrôle.
volume number
Volume relevé lors des essais / contrôle hydrauliques.
format : float
debit_1bar number
Débit à 1 bar de pression relevé lors des essais / contrôle hydrauliques.
format : float
pression number
Pression relevée lors des essais / contrôle hydrauliques.
format : float
pression_statique number
Pression statique relevée lors des essais / contrôle hydrauliques.
format : float
debit_gueule_bee number
Débit gueule bée relevé lors des essais / contrôle hydrauliques.
format : float
liste_anomalies array of object
Liste des anomalies posées ou à lever suite à ce contrôle.
255 max items
code integer
Code de l'anomalie.
format : int32 ≥=0 ≤=999999
a_lever boolean
Si l'anomalie est à lever.
essais_engin_utilise string
Engin utilisé pour les essais hydrauliques.
| Valeurs possibles |
|---|
aucunAucun engin utilisé. |
fptFourgon pompe-tonne. |
mprMotopompe remorquable. |
ccfCamion-citerne feux de forêt. |
ordre integer
L'ordre du contrôle dans le livret de tournée.
format : int32 ≥=1 ≤=255
Réponses
200 OK
Retourne un Objet Tournée Deci PEI contenant les données demandées.
POST /controles_pei/{pei_id}
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