L'horizon des occurrences de valorisation prévues d'un instrument

GET

/instruments/{instrument}/calendrier

curl --request GET \
  --url 'https://example.com/instruments/example/calendrier?du=2026-04-15&au=2026-04-15' \
  --header 'Authorization: Bearer <token>'

Le consommateur n’a jamais à recalculer un calendrier : le référentiel établit, publie et explique.

Autorisations

• authentification
  instruments:consultation

Paramètres

Paramètres (path)

instrument

required

string

>= 1 characters

L’identifiant publié de l’instrument — stable à vie.

Paramètres (query)

du

required

string format: date

au

required

string format: date

La borne de fin, exclue.

Réponses

200

L’horizon de la période — occurrences et absences motivées.

Media typeapplication/json

object

instrument

required

string

du

required

string format: date

au

required

La borne de fin

string format: date

occurrences

required

Array<object>

object

occurrence

required

L’identifiant stable de l’occurrence — la date ne change jamais sous lui.

string

>= 1 characters

date_valorisation

required

string format: date

heure_limite

required

string

/^([01][0-9]|2[0-3]):[0-5][0-9]$/

fuseau

required

Le fuseau IANA de l’heure limite.

string

>= 1 characters

date_publication_prevue

string format: date

date_reglement_prevue

string format: date

statut

required

string

Allowed values: prevue confirmee reportee annulee suspendue

motif

Obligatoire au sens métier pour un report, une annulation, une suspension.

string

occurrence_remplacante

L’occurrence nouvelle qui porte la date reportée — présente pour un report : jamais de modification en place.

string

lignage

Les versions de règles et de calendriers utilisées — l’explicabilité du calcul.

object

absences

required

Les dates de la période sans occurrence, chacune MOTIVÉE : l’insuffisance de l’horizon est une anomalie de qualité, jamais une autorisation implicite.

Array<object>

object

date

required

string format: date

motif

required

Inconnu — la date n’est couverte par aucun calendrier obligatoire (elle n’est JAMAIS « ouverte » par défaut) ; ferme — un calendrier l’exclut ; hors_horizon — au-delà de l’horizon glissant matérialisé.

string

Allowed values: inconnu ferme hors_horizon

Example

{
  "occurrences": [
    {
      "statut": "prevue"
    }
  ],
  "absences": [
    {
      "motif": "inconnu"
    }
  ]
}

400

La demande est irrecevable (date mal formée, bornes incohérentes…) — le motif nomme le champ.

Media typeapplication/json

object

motif

required

Le motif, qui nomme le champ ou l’identifiant en cause.

string

Example^generated

{
  "motif": "example"
}

401

Aucune identité présentée (l’exigence est du contrat, le mécanisme de l’assemblage).

403

L’identité présentée n’a pas la famille d’accès instruments:consultation.

404

L’instrument est inconnu, ou n’a pas de règle de valorisation (un CCB, une devise) — l’absence est motivée.

Media typeapplication/json

object

motif

required

Le motif, qui nomme le champ ou l’identifiant en cause.

string

Example^generated

{
  "motif": "example"
}