La valeur applicable à une date

GET

/instruments/{instrument}/valeur

curl --request GET \
  --url https://example.com/instruments/example/valeur \
  --header 'Authorization: Bearer <token>'

Avec date, le dernier rang publié pour la date de calcul demandée, avec son motif s’il corrige ; l’unité pour une devise ; l’absence motivée sinon — jamais d’interpolation.

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)

date

string format: date

La date de calcul demandée.

avant

string format: date

Servir la dernière valeur dont la date de calcul est strictement antérieure.

Réponses

200

La valeur servie.

Media typeapplication/json

object

instrument

required

string

date_calcul

required

string format: date

rang

required

Le rang servi — supérieur à 1, la valeur corrige.

integer

>= 1

valeur_part_ue6

required

La valeur d’une part, en micro-euros — l’unité pour une devise.

integer

sorte

required

string

Allowed values: marche administree unite

provenance

D’où la valeur est arrivée — absente pour une valeur administrée (calculée) et l’unité d’une devise.

string

Allowed values: flux_de_place saisie

motif

Le motif de la correction — présent dès le rang 2.

string

occurrence

L’occurrence de valorisation prévue à laquelle la valeur répond — absente pour une valeur hors calendrier (une régularisation, un CCB).

string

Example

{
  "sorte": "marche",
  "provenance": "flux_de_place"
}

400

Date et avant absents tous deux, ou présents tous deux, ou mal formés — 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 aucune valeur n’est applicable (l’absence est motivée — la règle de valorisation et son calendrier font foi).

Media typeapplication/json

object

motif

required

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

string

Example^generated

{
  "motif": "example"
}