pilot
Parcours du pilote : etapes calculees a partir des faits des modules, jalons, prochaine action par permission, attestation des pieces du cadre.
Descriptions come from the contract, which is written in French. They are reproduced verbatim so that the contract remains the source of truth.
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
Parameters
No parameters.
Request body
No request body.
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
200 | Deja ouvert. | application/json | EngagementOut |
201 | Successful Response | application/json | EngagementOut |
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
Parameters
No parameters.
Request body
No request body.
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
200 | Successful Response | application/json | PilotJourneyOut |
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
Parameters
| Parameter | Location | Type | Required | Constraints |
|---|---|---|---|---|
step_code | path | string | yes | minLength: 3 ; maxLength: 64 |
Request body
- Content type
application/json- Type
AttestationIn- Required
- yes
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
201 | Successful Response | application/json | AttestationOut |
422 | Validation Error | application/json | HTTPValidationError |