Rapports

Chaque fois qu’une demande est délivrée (voir : Résumé du cycle de vie d’une demande), la demande est transmise à l’organisation concernée.

Un Administrateur récupère les demandes concernant son organisation avec :

GET /organizations/{organization}/reports

Et une demande donné est récupéré avec :

GET /reports/{report}

Cycle de vie d’une demande

Quand une nouvelle demande est générée pour une organisation, elle possède le statut NEW.

Le schéma ci-dessous montre l’évolution du statut d’une demande en fonction des actions qui sont effectuées sur cette demande.

Un endpoint unique permet de changer le statut d’une demande :

PATCH /reports/{report}/state

Par exemple, pour passer du statut NEW au statut ACCEPTED, l’administrateur de l’organisation effectuera un « accept » en passant dans le corps de la requête :

{
    "transition":"accept"
}

Une demande ne peut être clôturée (statut CLOSED) que si :

• Toutes les interventions associées à cette demande ont été clôturées ou refusées (voir ci-dessous le paragraphe reports-interventions).

Interventions

Une intervention est une action à réaliser associée à une demande et assignée à un membre de l’organisation.

Pour récupérer l’ensemble des interventions associées à une demande :

GET /reports/{report}/operations

Création et modification d’une intervention

Un administrateur crée une intervention sur une demande en effectuant la requête :

POST /operations

{
    "description":"Description de l'intervention",
    "name":"Nom de l'intervention",
    "report":"cb7118b5-a821-4cf2-9475-0c0d0efdb8d0"
}

Une intervention nouvellement créée possède le statut NEW.

Une ou plusieurs images peuvent être ajoutées à l’intervention :

POST /operations/{operation}/images

{
    "image":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAIAAAACDbGyAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH4QIVDRUfvq7u+AAAABl0RVh0Q29tbWVudABDcmVhdGVkIHdpdGggR0lNUFeBDhcAAAAUSURBVAjXY3wrIcGABJgYUAGpfABZiwEnbOeFrwAAAABJRU5ErkJggg=="
}

La description d’une intervention peut être modifiée avec la requête :

PATCH /operations/{operation}

{
    "description":"Nouvelle description"
}

Assignation

Pour assigner une intervention à un membre de l’organisation, l’administrateur de l’organisation effectue la requête :

POST /operations/{operation}/assign

{
  "member":"{member}",
}

où {member} est l’identifiant du membre à qui est assignée l’intervention.

Intervention en cours et terminée

Une fois assignée, l’intervention peut-être passée « en cours » puis « terminée », soit par la personne à qui l’intervention a été assignée, soit par un administrateur de l’organisation.

Résumé du cycle de vie d’une intervention

Commentaires

Il est possible de commenter une intervention :

POST /operations/{operation}/comments

{
    "text":"Mon commentaire"
}

Pour récupérer tous les commentaires d’une intervention :

GET /operations/{operation}/comments

Logs d’une intervention

Un administrateur peut consulter l’historique d’une intervention avec :

GET /operations/{operation}/logs

Délégation des demanes

Un administrateur d’une organisation peut déléguer une demande à l’une des organisations partenaires.

Voir : Gestion des partenariats

Pour déléguer une demande, un administrateur de l’organisation effectue la requête :

POST /organizations/{organization}/delegates

{
  "report":"cb7118b5-a821-4cf2-9475-0c0d0efdb8d0",
  "organization":"a31d9ab7-9476-45f2-8cc7-033bf40bbcfa"
}

où {organization} est l’identifiant de l’organisation courante (dont le membre est administrateur), et a31d9ab7-9476-45f2-8cc7-033bf40bbcfa est l’identifiant de l’organisation à laquelle la demane est déléguée.

Cette demande est alors partagée entre l’organisation courante et l’organisation partenaire. Cette dernière pourra effectuer les mếmes actions que l’organisation délégante sur cette demande.

L’organisation partenaire peut elle-même déléguer la demande à l’un de ses partenaires et ainsi de suite.

Export des demandes

Un administrateur peut exporter toutes les demanes de son organisation au format Excel :

POST /organizations/{organization}/reports/exports

Une archive contenant le fichier Excel listant tous les demandes et les images associées à ces demandes est alors envoyé par email à l’administrateur authentifié.