ELRM developer Bac à sable

Cycle de vie d'un dossier#

Un dossier avance par étapes. L'API vous dit toujours où il en est et ce que vous pouvez faire.

Étape et actions#

Toute réponse de dossier (POST …/dossiers, GET …/suivi, routes d'inscription) contient :

  • stage : l'étape courante ;
  • allowed_actions : les actions que votre clé peut déclencher maintenant.
{
  "id": "…",
  "numero": "DEV-2026-1400",
  "stage": "inscriptions_ouvertes",
  "allowed_actions": ["set_apprenants", "validate_inscriptions"],
  "montant_ht": 2340.0,
  "montant_ttc": 2808.0,
  "remise_pct": 10.0,
  "lignes": [ … ]
}

Une action tentée hors étape répond 409 invalid_state, avec details.stage et details.allowed_actions. Votre code n'a pas à reproduire la machine d'état : lisez allowed_actions et affichez / activez ce qui s'y trouve.

Les étapes#

stage Ce qui se passe Qui agit
devis_en_preparation Devis en préparation par l'organisme (dossiers ouverts hors API uniquement) ELRM
devis_envoye Devis envoyé au client, en attente de son accord (hors API) Le client
inscriptions_ouvertes Dossier accepté. Un dossier créé par l'API y est dès sa création. Actions : set_apprenants, validate_inscriptions Vous
inscriptions_validees Apprenants placés en session ; le dossier est verrouillé ELRM
documents_envoyes Convention et documents d'entrée en formation envoyés (signature électronique ou papier) ELRM / signataires
documents_signes Documents signés aucun
formation_en_cours La session a commencé aucun
formation_terminee Session terminée aucun
facture_envoyee Facture émise ELRM
documents_fin_envoyes Attestations et documents de fin de formation disponibles (GET …/documents) ELRM
refuse Devis refusé aucun
expire Devis expiré sans confirmation aucun

L'énumération est additive : de nouvelles étapes peuvent apparaître (une étape intermédiaire, une variante de financement). Ignorez les valeurs que vous ne connaissez pas, et appuyez-vous sur allowed_actions pour savoir si vous avez quelque chose à faire.

Les actions#

Action Route Étape
set_apprenants PUT …/inscriptions/apprenants, PUT …/apprenants/{id}/session, … inscriptions_ouvertes
validate_inscriptions POST …/inscriptions/valider inscriptions_ouvertes

Dossiers créés hors API#

Un dossier ouvert par ELRM ou par l'espace client (pas par votre intégration) vous est visible dans GET /dossiers, avec ses événements et ses documents. Vous ne le confirmez pas, c'est le client qui l'a fait. En revanche, s'il est accepté et pas encore verrouillé, allowed_actions contient set_apprenants et validate_inscriptions : vous pouvez y inscrire les apprenants comme pour vos propres dossiers.

Ce que vous ne faites pas par l'API#

L'organisme garde la main sur : le contenu et les prix du devis, le choix final des sessions (vous proposez parmi sessions_candidates), la facture, les documents de fin de formation. Ces étapes vous sont visibles (via stage, les événements et les documents) mais pas pilotables.

Suivre l'avancement#

Deux moyens, complémentaires :

  • GET …/dossiers/{id}/suivi : l'état à l'instant t.
  • GET …/dossiers/{id}/evenements?since=… : tout ce qui s'est passé depuis votre dernier appel, y compris ce que fait l'organisme. Voir Suivre un dossier.

Il n'y a pas de webhooks pour l'instant.