Aller au contenu principal
NEXCLARADocumentation

pilot

Parcours du pilote : etapes calculees a partir des faits des modules, jalons, prochaine action par permission, attestation des pieces du cadre.

Les descriptions viennent du contrat, rédigé en français. Elles sont reproduites telles quelles pour rester la source de vérité.

POST /api/v1/pilot/engagement

Ouvrir le parcours du pilote (idempotent)

Ouvre le parcours sous la version courante ; deja ouvert, le rend tel quel (200).

pilotOpenEngagement

Paramètres

Aucun paramètre.

Corps de la requête

Aucun corps de requête.

Réponses

StatutDescriptionType de contenuType
200Deja ouvert.application/jsonEngagementOut
201Successful Responseapplication/jsonEngagementOut

GET /api/v1/pilot/journey

Parcours du pilote de l'institution, filtre par permission

Etat calcule de chaque etape, jalons et prochaine action du lecteur.

pilotJourney

Paramètres

Aucun paramètre.

Corps de la requête

Aucun corps de requête.

Réponses

StatutDescriptionType de contenuType
200Successful Responseapplication/jsonPilotJourneyOut

POST /api/v1/pilot/steps/{step_code}/attestations

Attester une piece du cadre, ou declarer une etape non applicable

Acte sur une etape ; la meme cle et le meme acte rejouent la meme reponse. Comme pour toute cle d'idempotence, la reponse rejouee est celle de l'acte d'origine (201) ; `replayed` dit qu'aucun acte nouveau n'a ete cree.

pilotAttestStep

Paramètres

ParamètreEmplacementTypeRequisContraintes
step_codepathstringouiminLength: 3 ; maxLength: 64

Corps de la requête

Type de contenu
application/json
Type
AttestationIn
Requis
oui

Réponses

StatutDescriptionType de contenuType
201Successful Responseapplication/jsonAttestationOut
422Validation Errorapplication/jsonHTTPValidationError