Aller au contenu

Les documents de référence en transverse

GET
/documents
curl --request GET \
--url 'https://example.com/documents?type=prospectus&niveau_d_attache=vehicule&etat_d_analyse=a_analyser&page=1&taille=50' \
--header 'Authorization: Bearer <token>'
instrument
string
>= 1 characters
type
string
Allowed values: prospectus dic reglement_du_fonds lettre_aux_porteurs
niveau_d_attache
string
Allowed values: vehicule instrument
etat_d_analyse
string
Allowed values: a_analyser analyse ecart_detecte
recu_depuis
string format: date
page
integer
default: 1 >= 1

La page demandée, à partir de 1.

taille
integer
default: 50 >= 1 <= 500

Le nombre de lignes par page.

La page demandée.

Media typeapplication/json
object
lignes
required
Array<object>
object
document
required
string
type
required
string
Allowed values: prospectus dic reglement_du_fonds lettre_aux_porteurs
libelle
string
version
required
string
langue

Le code de langue du document (fr

string
edite_le
required
string format: date
applicable_le
string format: date
derniere_revue_le

La date de dernière revue déclarée par l’émetteur — distincte de la date d’édition (le DIC se revoit sans changer).

string format: date
recu_le
string format: date-time
empreinte
required

L’empreinte du fichier — le contenu vit derrière l’adaptateur de stockage.

string
emetteur

L’intervenant émetteur.

string
niveau_d_attache
required

Le niveau déclaré par type — prospectus, règlement et lettre au véhicule ; DIC à l’instrument (celui d’une catégorie de parts est celui de son instrument).

string
Allowed values: vehicule instrument
instrument

L’instrument rattaché

string
etat_d_analyse

L’état de la chaîne d’analyse documentaire — le détail vit au contrat d’administration.

string
Allowed values: a_analyser analyse ecart_detecte
ecarts

Le nombre d’écarts relevés par la dernière analyse — null tant qu’aucune analyse n’a eu lieu.

integer | null
total
required
integer | null
Example
{
"lignes": [
{
"type": "prospectus",
"niveau_d_attache": "vehicule",
"etat_d_analyse": "a_analyser"
}
]
}

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
Examplegenerated
{
"motif": "example"
}

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

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