Clore un programme

POST

/programmes-de-versement/{programme}/clore

curl --request POST \
  --url https://example.com/programmes-de-versement/example/clore \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "versionAttendue": 1, "motif": "example", "commentaire": "example" }'

Un programme clos NE SE RÉACTIVE PAS : on en crée un nouveau. C’est ce qui garde lisible l’historique de ce que le porteur a voulu, et quand.

Autorisations

• authentification
  operations:saisie

Paramètres

Paramètres (path)

programme

required

string

L’identifiant publié du programme de versement.

Corps de la requête^required

Media typeapplication/json

object

versionAttendue

required

integer

motif

required

Motif CODIFIÉ. On ne sort pas une entité du cycle en silence.

string

commentaire

string

Example^generated

{
  "versionAttendue": 1,
  "motif": "example",
  "commentaire": "example"
}

Réponses

200

Le programme est clos.

Media typeapplication/json

object

programmeRef

required

string

etat

required

string

Allowed values: ACTIF SUSPENDU INEXECUTABLE CLOS

motifInexecutable

Présent SEULEMENT à l’état INEXECUTABLE. Un programme inexécutable dit toujours pourquoi il l’est — mandat révoqué, support cessant d’être ordonnable.

string

version

required

integer

Example

{
  "etat": "ACTIF"
}

409

409 — VERSION PÉRIMÉE ou TRANSITION INTERDITE par le cycle de vie. Rien n’a été écrit. L’appelant relit et recommence ; il ne réessaie pas à l’aveugle.

Media typeapplication/json

object

code

required

string

message

required

string

Example^generated

{
  "code": "example",
  "message": "example"
}