Le document de la restitution

GET

/v1/entreprises/{entreprise}/restitutions/{restitution}/contenu

const url = 'https://passerelle.teneur.exemple/v1/entreprises/example/restitutions/example/contenu';
const options = {
  method: 'GET',
  headers: {'Correlation-Id': 'example', Authorization: 'Bearer <token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://passerelle.teneur.exemple/v1/entreprises/example/restitutions/example/contenu \
  --header 'Authorization: Bearer <token>' \
  --header 'Correlation-Id: example'

Autorisations

jetonPartenaire

Paramètres

Paramètres (path)

entreprise

required

string

>= 1 characters

L’identifiant publié de l’entreprise chez ce teneur de compte. Il désigne la ressource ; un identifiant d’entreprise dans une URL ne vaut jamais autorisation.

restitution

required

string

>= 1 characters

La référence de la restitution, telle que le catalogue la publie.

Paramètres (header)

Correlation-Id

required

string

>= 1 characters <= 128 characters

L’identifiant que le teneur de compte donne à l’échange dans son journal. Obligatoire : notre trace dit qui a lu quoi, jamais pour qui, et ce champ est la seule jointure entre les deux journaux. Il est restitué dans la réponse.

Réponses

200

Le document, dans le format annoncé par la fiche de restitution.

string format: binary

Headers

Correlation-Id

string

>= 1 characters <= 128 characters

L’identifiant de corrélation reçu, restitué tel quel — la jointure entre le journal du teneur et le nôtre.

401

401 — aucune identité présentée, ou jeton invalide : signature, émetteur, dates, tenant, ou audience obtenue pour une autre surface. La réponse porte WWW-Authenticate: Bearer error="invalid_token".

application/json

object

code

required

Le code stable sur lequel un portail se branche — le motif, lui, est écrit pour être lu par une personne et peut changer sans rupture.

string

Allowed values: DEMANDE_MAL_FORMEE CHAMP_INVALIDE NON_AUTHENTIFIE HORS_PERIMETRE_SOUSCRIT RESSOURCE_INCONNUE REJEU_DIVERGENT ECRITURE_REFUSEE AGREGAT_RETENU

motif

required

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

string

champ

Le champ en cause, quand l’erreur en désigne un.

string

correlation

L’identifiant de corrélation de l’appel — le même que l’en-tête restitué.

string

Example

{
  "code": "DEMANDE_MAL_FORMEE"
}

Headers

WWW-Authenticate

string

Le défi d’authentification, au format des jetons porteurs.

403

403 — le cas d’usage n’est pas dans le périmètre souscrit de ce client. La réponse ne dit jamais si la ressource existe.

application/json

object

code

required

Le code stable sur lequel un portail se branche — le motif, lui, est écrit pour être lu par une personne et peut changer sans rupture.

string

Allowed values: DEMANDE_MAL_FORMEE CHAMP_INVALIDE NON_AUTHENTIFIE HORS_PERIMETRE_SOUSCRIT RESSOURCE_INCONNUE REJEU_DIVERGENT ECRITURE_REFUSEE AGREGAT_RETENU

motif

required

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

string

champ

Le champ en cause, quand l’erreur en désigne un.

string

correlation

L’identifiant de corrélation de l’appel — le même que l’en-tête restitué.

string

Example

{
  "code": "DEMANDE_MAL_FORMEE"
}

404

404 — la restitution est inconnue de ce teneur, ou la convention n’en prévoit aucun document.

application/json

object

code

required

Le code stable sur lequel un portail se branche — le motif, lui, est écrit pour être lu par une personne et peut changer sans rupture.

string

Allowed values: DEMANDE_MAL_FORMEE CHAMP_INVALIDE NON_AUTHENTIFIE HORS_PERIMETRE_SOUSCRIT RESSOURCE_INCONNUE REJEU_DIVERGENT ECRITURE_REFUSEE AGREGAT_RETENU

motif

required

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

string

champ

Le champ en cause, quand l’erreur en désigne un.

string

correlation

L’identifiant de corrélation de l’appel — le même que l’en-tête restitué.

string

Example

{
  "code": "DEMANDE_MAL_FORMEE"
}