Points de terminaison d'API REST pour Mains Courantes

DeleteMainCouranteMainsCourantes

Suppression d'une main courante

Suppression d'une main courante existante.

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 /mains_courantes/{main_courante_id}

GetMainCouranteMainsCourantes

Détails d'une main courante

Récupération d'une main courante existante.

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 Main Courante contenant les données demandées.

GET /mains_courantes/{main_courante_id}

Schéma de la réponse

id string required

Identifiant unique de l'objet.

format : uuid 36 fixed length

objet string required

Objet de la main courante.

256 max length

date string required

Horodatage de la main courante.

format : date-time 20 min length 50 max length

compte_rendu string required

Contenu de la main courante.

65536 max length

type string required

Type de la main courante.

Valeurs possibles
`REUNION` Réunion.
`INTERVENTION` Intervention.
`COURRIER_COURRIEL` Courriel.
`ARRETE` Arrêté.

main_courante_intervention array of object nullable

Main courante spécifique aux interventions.

50 max items

nature string required

Nature de l'intervention.

Valeurs possibles
`INCENDIE` Intervention liée à un incendie.
`SAP` Intervention liée au SAP.
`INTERVENTION_DIVERSE` Intervention diverse.

InterventionSDIS boolean nullable

Indique si l'intervention est liée au SDIS.

RCCI boolean nullable

Indique si l'intervention est liée au RCCI.

RetEx boolean nullable

Retour d'expérience sur l'intervention.

numero_intervention string nullable

Numéro de l'intervention.

256 max length

date_heure_intervention string nullable

Date et heure de début de l'intervention.

format : date-time 20 min length 50 max length

date_heure_fin_intervention string nullable

Date et heure de fin de l'intervention.

format : date-time 20 min length 50 max length

duree_intervention string nullable

Durée calculée de l'intervention entre sa date de début et sa date de fin, exprimée en jours, heures et minutes.

255 max length

observations string nullable

Observations générales sur l'intervention.

65536 max length

main_courante_reunion array of object nullable

Main courante spécifique aux réunions.

50 max items

nature string required

Nature de la réunion.

Valeurs possibles
`LOCAUX_SDIS` Réunion tenue dans les locaux du SDIS.
`EXTERIEUR_SDIS` Réunion tenue en dehors des locaux du SDIS.
`TELEPHONIQUE` Réunion tenue par téléphone.

date_creation string nullable

Date de création de l'événement.

format : date 10 fixed length

demandeur string nullable

Demandeur de la réunion.

256 max length

observations string nullable

Observations relatives à la réunion.

65536 max length

date_reunion string nullable

Date de tenue de la réunion.

format : date 10 fixed length

lieu_reunion string nullable

Lieu de la réunion. Renseigné uniquement lorsque la nature est EXTERIEUR_SDIS.

256 max length

main_courante_courriel array of object nullable

Main courante spécifique aux courriels.

50 max items

nature string required

Nature du courrier / courriel.

Valeurs possibles
`LETTRE` Lettre simple.
`MISE_EN_DEMEURE` Mise en demeure.
`AVIS_ECRIT_MOTIVE` Avis écrit motivé.
`CONSULTATION_PLU` Consultation PLU.
`RAPPORT_ORGANISME_AGREE` Rapport d'organisme agréé.
`DEMANDE_RENSEIGNEMENT` Demande de renseignement.
`DEMANDE_VISITE_PERIODIQUE` Demande de visite périodique.
`DEMANDE_VISITE_TECHNIQUE` Demande de visite technique.
`DEMANDE_VISITE_INOPINEE` Demande de visite inopinée.
`DEMANDE_VISITE_HORS_PROGRAMME` Demande de visite hors programme.
`DEMANDE_VISITE_RECEPTION` Demande de visite de réception.
`AUTORISATION_TRAVAUX` Autorisation de travaux.

date_creation_dossier string nullable

Date de création du dossier.

format : date 10 fixed length

demandeur string nullable

Demandeur à l'origine du courrier / courriel.

256 max length

date_reception_mairie string nullable

Date de réception en mairie.

format : date 10 fixed length

date_envoi_transit string nullable

Date d'envoi / transit du courrier.

format : date 10 fixed length

date_reception_sdis string nullable

Date de réception au SDIS.

format : date 10 fixed length

observations string nullable

Observations relatives au courrier / courriel.

65536 max length

date_reponse string nullable

Date de réponse.

format : date 10 fixed length

date_transfert_commission_competente string nullable

Date de transfert à la commission compétente.

format : date 10 fixed length

date_reception_commission_competente string nullable

Date de réception à la commission compétente.

format : date 10 fixed length

main_courante_arrete array of object nullable

Main courante spécifique aux arrêtés.

50 max items

nature string required

Nature de l'événement lié aux arrêtés.

Valeurs possibles
`OUVERTURE` Ouverture de l'arrêté.
`FERMETURE` Fermeture de l'arrêté.
`MISE_EN_DEMEURE` Mise en demeure.
`UTILISATION_EXCEPTIONNELLE_LOCAUX` Utilisation exceptionnelle de l'arrêté.

date_creation string nullable

Date de création de l'événement.

format : date 10 fixed length

observations string nullable

Observations relatives à l'événement.

65536 max length

date_signature string nullable

Date de signature de l'acte.

format : date 10 fixed length

PostMainCouranteMainsCourantes

Mise à jour d'une main courante

Mise à jour d'une main courante existante 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

objet string

Objet de la main courante.

256 max length

date string

Horodatage de la main courante.

format : date-time 20 min length 50 max length

compte_rendu string

Contenu de la main courante.

65536 max length

type string

Type de la main courante.

Valeurs possibles
`REUNION` Réunion.
`INTERVENTION` Intervention.
`COURRIER_COURRIEL` Courriel.
`ARRETE` Arrêté.

main_courante_intervention array of object

Main courante spécifique aux interventions.

50 max items

nature string

Nature de l'intervention.

Valeurs possibles
`INCENDIE` Intervention liée à un incendie.
`SAP` Intervention liée au SAP.
`INTERVENTION_DIVERSE` Intervention diverse.

InterventionSDIS boolean

Indique si l'intervention est liée au SDIS.

RCCI boolean

Indique si l'intervention est liée au RCCI.

RetEx boolean

Retour d'expérience sur l'intervention.

numero_intervention string

Numéro de l'intervention.

256 max length

date_heure_intervention string

Date et heure de début de l'intervention.

format : date-time 20 min length 50 max length

date_heure_fin_intervention string

Date et heure de fin de l'intervention.

format : date-time 20 min length 50 max length

observations string

Observations générales sur l'intervention.

65536 max length

main_courante_reunion array of object

Main courante spécifique aux réunions.

50 max items

nature string

Nature de la réunion.

Valeurs possibles
`LOCAUX_SDIS` Réunion tenue dans les locaux du SDIS.
`EXTERIEUR_SDIS` Réunion tenue en dehors des locaux du SDIS.
`TELEPHONIQUE` Réunion tenue par téléphone.

date_creation string

Date de création de l'événement.

format : date 10 fixed length

demandeur string

Demandeur de la réunion.

256 max length

observations string

Observations relatives à la réunion.

65536 max length

date_reunion string

Date de tenue de la réunion.

format : date 10 fixed length

lieu_reunion string

Lieu de la réunion. Renseigné uniquement lorsque la nature est EXTERIEUR_SDIS.

256 max length

main_courante_courriel array of object

Main courante spécifique aux courriels.

50 max items

nature string

Nature du courrier / courriel.

Valeurs possibles
`LETTRE` Lettre simple.
`MISE_EN_DEMEURE` Mise en demeure.
`AVIS_ECRIT_MOTIVE` Avis écrit motivé.
`CONSULTATION_PLU` Consultation PLU.
`RAPPORT_ORGANISME_AGREE` Rapport d'organisme agréé.
`DEMANDE_RENSEIGNEMENT` Demande de renseignement.
`DEMANDE_VISITE_PERIODIQUE` Demande de visite périodique.
`DEMANDE_VISITE_TECHNIQUE` Demande de visite technique.
`DEMANDE_VISITE_INOPINEE` Demande de visite inopinée.
`DEMANDE_VISITE_HORS_PROGRAMME` Demande de visite hors programme.
`DEMANDE_VISITE_RECEPTION` Demande de visite de réception.
`AUTORISATION_TRAVAUX` Autorisation de travaux.

date_creation_dossier string

Date de création du dossier.

format : date 10 fixed length

demandeur string

Demandeur à l'origine du courrier / courriel.

256 max length

date_reception_mairie string

Date de réception en mairie.

format : date 10 fixed length

date_envoi_transit string

Date d'envoi / transit du courrier.

format : date 10 fixed length

date_reception_sdis string

Date de réception au SDIS.

format : date 10 fixed length

observations string

Observations relatives au courrier / courriel.

65536 max length

date_reponse string

Date de réponse.

format : date 10 fixed length

date_transfert_commission_competente string

Date de transfert à la commission compétente.

format : date 10 fixed length

date_reception_commission_competente string

Date de réception à la commission compétente.

format : date 10 fixed length

main_courante_arrete array of object

Main courante spécifique aux arrêtés.

50 max items

nature string

Nature de l'événement lié aux arrêtés.

Valeurs possibles
`OUVERTURE` Ouverture de l'arrêté.
`FERMETURE` Fermeture de l'arrêté.
`MISE_EN_DEMEURE` Mise en demeure.
`UTILISATION_EXCEPTIONNELLE_LOCAUX` Utilisation exceptionnelle de l'arrêté.

date_creation string

Date de création de l'événement.

format : date 10 fixed length

observations string

Observations relatives à l'événement.

65536 max length

date_signature string

Date de signature de l'acte.

format : date 10 fixed length

Réponses

200 OK

Retourne un Objet Main Courante contenant les données demandées.

POST /mains_courantes/{main_courante_id}

Schéma de la réponse

id string required

Identifiant unique de l'objet.

format : uuid 36 fixed length

objet string required

Objet de la main courante.

256 max length

date string required

Horodatage de la main courante.

format : date-time 20 min length 50 max length

compte_rendu string required

Contenu de la main courante.

65536 max length

type string required

Type de la main courante.

Valeurs possibles
`REUNION` Réunion.
`INTERVENTION` Intervention.
`COURRIER_COURRIEL` Courriel.
`ARRETE` Arrêté.

main_courante_intervention array of object nullable

Main courante spécifique aux interventions.

50 max items

nature string required

Nature de l'intervention.

Valeurs possibles
`INCENDIE` Intervention liée à un incendie.
`SAP` Intervention liée au SAP.
`INTERVENTION_DIVERSE` Intervention diverse.

InterventionSDIS boolean nullable

Indique si l'intervention est liée au SDIS.

RCCI boolean nullable

Indique si l'intervention est liée au RCCI.

RetEx boolean nullable

Retour d'expérience sur l'intervention.

numero_intervention string nullable

Numéro de l'intervention.

256 max length

date_heure_intervention string nullable

Date et heure de début de l'intervention.

format : date-time 20 min length 50 max length

date_heure_fin_intervention string nullable

Date et heure de fin de l'intervention.

format : date-time 20 min length 50 max length

duree_intervention string nullable

Durée calculée de l'intervention entre sa date de début et sa date de fin, exprimée en jours, heures et minutes.

255 max length

observations string nullable

Observations générales sur l'intervention.

65536 max length

main_courante_reunion array of object nullable

Main courante spécifique aux réunions.

50 max items

nature string required

Nature de la réunion.

Valeurs possibles
`LOCAUX_SDIS` Réunion tenue dans les locaux du SDIS.
`EXTERIEUR_SDIS` Réunion tenue en dehors des locaux du SDIS.
`TELEPHONIQUE` Réunion tenue par téléphone.

date_creation string nullable

Date de création de l'événement.

format : date 10 fixed length

demandeur string nullable

Demandeur de la réunion.

256 max length

observations string nullable

Observations relatives à la réunion.

65536 max length

date_reunion string nullable

Date de tenue de la réunion.

format : date 10 fixed length

lieu_reunion string nullable

Lieu de la réunion. Renseigné uniquement lorsque la nature est EXTERIEUR_SDIS.

256 max length

main_courante_courriel array of object nullable

Main courante spécifique aux courriels.

50 max items

nature string required

Nature du courrier / courriel.

Valeurs possibles
`LETTRE` Lettre simple.
`MISE_EN_DEMEURE` Mise en demeure.
`AVIS_ECRIT_MOTIVE` Avis écrit motivé.
`CONSULTATION_PLU` Consultation PLU.
`RAPPORT_ORGANISME_AGREE` Rapport d'organisme agréé.
`DEMANDE_RENSEIGNEMENT` Demande de renseignement.
`DEMANDE_VISITE_PERIODIQUE` Demande de visite périodique.
`DEMANDE_VISITE_TECHNIQUE` Demande de visite technique.
`DEMANDE_VISITE_INOPINEE` Demande de visite inopinée.
`DEMANDE_VISITE_HORS_PROGRAMME` Demande de visite hors programme.
`DEMANDE_VISITE_RECEPTION` Demande de visite de réception.
`AUTORISATION_TRAVAUX` Autorisation de travaux.

date_creation_dossier string nullable

Date de création du dossier.

format : date 10 fixed length

demandeur string nullable

Demandeur à l'origine du courrier / courriel.

256 max length

date_reception_mairie string nullable

Date de réception en mairie.

format : date 10 fixed length

date_envoi_transit string nullable

Date d'envoi / transit du courrier.

format : date 10 fixed length

date_reception_sdis string nullable

Date de réception au SDIS.

format : date 10 fixed length

observations string nullable

Observations relatives au courrier / courriel.

65536 max length

date_reponse string nullable

Date de réponse.

format : date 10 fixed length

date_transfert_commission_competente string nullable

Date de transfert à la commission compétente.

format : date 10 fixed length

date_reception_commission_competente string nullable

Date de réception à la commission compétente.

format : date 10 fixed length

main_courante_arrete array of object nullable

Main courante spécifique aux arrêtés.

50 max items

nature string required

Nature de l'événement lié aux arrêtés.

Valeurs possibles
`OUVERTURE` Ouverture de l'arrêté.
`FERMETURE` Fermeture de l'arrêté.
`MISE_EN_DEMEURE` Mise en demeure.
`UTILISATION_EXCEPTIONNELLE_LOCAUX` Utilisation exceptionnelle de l'arrêté.

date_creation string nullable

Date de création de l'événement.

format : date 10 fixed length

observations string nullable

Observations relatives à l'événement.

65536 max length

date_signature string nullable

Date de signature de l'acte.

format : date 10 fixed length

PaginateDocumentsMainCouranteMainsCourantes

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 /mains_courantes/{main_courante_id}/documents

Schéma de la réponse

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.

65536 max length

type string required

Type de la pièce jointe.

Valeurs possibles
`photo` Photo.
`plan` Plan.
`annexe` Annexe.
`divers` Divers.
`rapport de vérification réglementaire après travaux` Rapport 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

PostDocumentsMainCouranteMainsCourantes

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.

65536 max length

type string required

Type de la pièce jointe.

Valeurs possibles
`photo` Photo.
`plan` Plan.
`annexe` Annexe.
`divers` Divers.
`rapport de vérification réglementaire après travaux` Rapport 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 /mains_courantes/{main_courante_id}/documents

Schéma de la réponse

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.

65536 max length

type string required

Type de la pièce jointe.

Valeurs possibles
`photo` Photo.
`plan` Plan.
`annexe` Annexe.
`divers` Divers.
`rapport de vérification réglementaire après travaux` Rapport 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.

GetParticipantsMainCouranteMainsCourantes

Liste complète des participants de la main courante

Liste des participants de la main courante.

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 tableau d'Objet Main Courante Affectation. Chaque entrée du tableau constitue un Objet Main Courante Affectation distinct. Si aucun élément n'est disponible, le tableau résultant sera vide.

GET /mains_courantes/{main_courante_id}/participants

Schéma de la réponse

data array of object required

Liste d'objets.

100 max items

id string required

Identifiant unique de l'objet.

format : uuid 36 fixed length

utilisateur object required

Utilisateur affecté à la main courante.

id string required

Identifiant unique de l'utilisateur.

256 max length

first_name string required nullable

Prénom de l'utilisateur.

256 max length

last_name string required nullable

Nom de l'utilisateur.

256 max length

created_at string required

Date à laquelle l'utilisateur a été créé.

format : date-time 20 min length 50 max length

updated_at string required nullable

Date à laquelle l'utilisateur a été mis à jour.

format : date-time 20 min length 50 max length

timezone string required

Identifiant 'tz database' du Fuseau horaire de l'utilisateur. Voir : https://www.iana.org/time-zones Liste des fuseaux horaires : https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

256 max length

is_active boolean required

État d'activation du compte utilisateur.

is_verified boolean required

État de vérification du compte utilisateur.

fonction string required nullable

Fonction de l'utilisateur.

256 max length

avatar_url string required nullable

Lien URL vers l'avatar de l'utilisateur.

format : uri 512 max length

roles array of string unique items required nullable

Liste des rôles de l'utilisateur.

10 max items

string

Le rôle de l'utilisateur.

Valeurs possibles
`administrateur_fonctionnel` Administrateur fonctionnel.
`valideur` Valideur.
`visionneur_simple` Visionneur simple.
`visionneur_complet` Visionneur complet.
`attributeur` Attributeur.
`relecteur` Relecteur.
`rapporteur` Rapporteur.
`preventionniste` Préventionniste.
`secretariat_commission_securite` Secrétariat commission de sécurité.
`secretariat` Secrétariat.

PostParticipantsMainCouranteMainsCourantes

Ajout d'une participation dans la main courante

Ajoute une participation à une main courante. Vous pouvez affecter plusieurs personnes à la main courante, y compris vous-même.

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

utilisateur_id string required

Identifiant de l'utilisateur à affecter à la main courante.

256 max length

Réponses

201 OK

Retourne l'Objet Main Courante Affectation créé.

POST /mains_courantes/{main_courante_id}/participants

Schéma de la réponse

id string required

Identifiant unique de l'objet.

format : uuid 36 fixed length

utilisateur object required

Utilisateur affecté à la main courante.

id string required

Identifiant unique de l'utilisateur.

256 max length

first_name string required nullable

Prénom de l'utilisateur.

256 max length

last_name string required nullable

Nom de l'utilisateur.

256 max length

created_at string required

Date à laquelle l'utilisateur a été créé.

format : date-time 20 min length 50 max length

updated_at string required nullable

Date à laquelle l'utilisateur a été mis à jour.

format : date-time 20 min length 50 max length

timezone string required

Identifiant 'tz database' du Fuseau horaire de l'utilisateur. Voir : https://www.iana.org/time-zones Liste des fuseaux horaires : https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

256 max length

is_active boolean required

État d'activation du compte utilisateur.

is_verified boolean required

État de vérification du compte utilisateur.

fonction string required nullable

Fonction de l'utilisateur.

256 max length

avatar_url string required nullable

Lien URL vers l'avatar de l'utilisateur.

format : uri 512 max length

roles array of string unique items required nullable

Liste des rôles de l'utilisateur.

10 max items

string

Le rôle de l'utilisateur.

Valeurs possibles
`administrateur_fonctionnel` Administrateur fonctionnel.
`valideur` Valideur.
`visionneur_simple` Visionneur simple.
`visionneur_complet` Visionneur complet.
`attributeur` Attributeur.
`relecteur` Relecteur.
`rapporteur` Rapporteur.
`preventionniste` Préventionniste.
`secretariat_commission_securite` Secrétariat commission de sécurité.
`secretariat` Secrétariat.