Documentation de service Web / Catégories / Services de signalement / Guide API – réponse aux données

Guide de réponse aux données de l’API

Organisation des API

Les interfaces de programmation d’applications (API) de réponse de données sont conçues pour que vous puissiez répondre aux requêtes de données au nom du client auquel vous êtes connecté, de la même manière que votre client peut répondre aux requêtes de données de son côté à l’aide de l’interface utilisateur. Vous pouvez également utiliser les mêmes interfaces API pour répondre aux requêtes de données dans votre propre compte. Ces API s’interfacent avec les requêtes de données et ne sont donc disponibles que dans l’environnement de production, puisque la création de requêtes de données ne peut être effectuée que dans l’interface utilisateur. Ces interfaces API ne permettent pas de créer des requêtes de données, mais seulement d’y répondre. Les interfaces API de réponse de données sont conçues autour de deux concepts importants que vous devez connaître:

Requête de données
Réponse de données

Requête de données

Votre client doit déjà avoir accédé à la requête de données et celle-ci doit figurer dans son compte Portfolio Manager dans l’onglet Signalement. Il n’existe pas d’interface API pour accéder initialement à la requête de données au nom de votre client. L’identifiant unique d’une requête de données est appelé dataRequestId.

Réponse de données

Les étapes pour répondre à une requête de données sont les mêmes que si vous répondiez à une requête de données dans l’interface utilisateur. Chaque fois que vous répondez à une requête de données, vous devez faire référence à une réponse de données. Une réponse de données comprend une liste de propriétés pour lesquelles vous souhaitez diffuser des renseignements. Chaque fois que vous générez un aperçu de la réponse de données, celui-ci remplacera l’aperçu de la réponse de données généré précédemment jusqu’à ce qu’il soit soumis (c’est-à-dire envoyé). L’identifiant unique d’une réponse de données est appelé dataResponseId.

Guide de référence rapide

Vous trouverez ci-dessous un guide de référence rapide pour répondre à une requête de données concernant un client spécifique. On suppose que vous êtes connecté au client et que celui-ci a déjà accepté la requête de données.

Étapes générales pour répondre à une requête de données

Ces étapes décrivent le scénario typique de réponse à une requête de données.

Étape	Méthode	REST URI	Description
1.	GET	/reports/customers/(customerId)/dataRequests?status=(status)	Obtenez une liste de toutes les requêtes de données pour votre client en utilisantcustomerId. Vous pouvez sauter cette étape si vous connaissez déjà ledataRequestId.
2.	GET	/reports/customers/(customerId)/dataRequests/(dataRequestId)	Si nécessaire, obtenez des détails sur la requête de données en utilisantdataRequestId.
3.	POST	/reports/customers/(customerId)/dataResponses	Créez ou préparez une réponse de données avec une liste de propriétés. Un dataResponseId est envoyé. Cette étape peut être ignorée si vous avez déjà une réponse de données active qui n’a pas été soumise (c’est-à-dire envoyée).
4.	POST	/reports/customers/(customerId)/dataResponses/(dataResponseId)/generate	Générez un aperçu de la réponse de données en utilisant dataResponseId.
5.	GET	/reports/customers/(customerId)/dataResponses/(dataResponseId)/status	Vérifiez l’état de l’aperçu de la réponse de données à l’aide de dataResponseIdjusqu’à ce que l’aperçu de la réponse de données ait fini d’être généré.
6.	GET	/reports/customers/(customerId)/dataResponses/(dataResponseId)/download?type=(type)	Téléchargez l’aperçu de la réponse de données en utilisantdataResponseId. L’aperçu de la réponse de données est transmis sous forme de fichier. Il ne fait pas partie du corps de la réponse XML.
7.	POST	/reports/customers/(customerId)/dataResponses/(dataResponseId)/send	Soumettez la réponse de données en utilisant dataResponseId.
8.	GET	/reports/customers/(customerId)/dataResponses/(dataResponseId)/receipt/download	Téléchargez le reçu PDF en utilisant dataResponseId.

Nouvelle soumission d’une réponse pour la même propriété

YVous avez déjà soumis (c’est-à-dire envoyé) une réponse de données pour une propriété spécifique et vous vous êtes rendu compte que vous deviez soumettre à nouveau une réponse de données pour la même propriété. Pour soumettre une autre réponse de données pour cette même propriété, vous devez générer une nouvelle réponse d’aperçu, la réviser, puis la soumettre. Vous trouverez ci-dessous les grandes lignes de l’étape à suivre.

Étape	Méthode	REST REST URI	Description
1.	POST	/reports/customers/(customerId)/dataResponses	Créez ou préparez une nouvelle réponse de données avec une liste correcte de propriétés. Un dataResponseId est envoyé. Suivez les mêmes étapes pour générer un aperçu de la réponse de données, pour le vérifier et pour soumettre la réponse de données. Notez que la propriété référencée dans la réponse de données la plus récente remplacera la même propriété dans la soumission de la réponse de données précédente.

Régénération d’un aperçu de réponse pour une propriété différente

Vous avez déjà généré un aperçu de la réponse de données qui fait référence à la mauvaise propriété (mais vous ne l’avez pas encore soumis) et vous devez mettre à jour la réponse de données pour qu’elle fasse référence à la bonne propriété. Pour vous assurer que la réponse de données fait référence à la bonne propriété, vous devez mettre à jour cette réponse de données avec la bonne propriété, la réviser, puis la soumettre. Vous trouverez ci-dessous les grandes lignes de l’étape à suivre.

Étape	Méthode	REST URI	Description
1.	PUT	/reports/customers/(customerId)/dataResponses/(dataResponseId)	Mettez à jour la réponse de données avec la liste correcte des propriétés en utilisant dataResponseId. Suivez les mêmes étapes pour générer un aperçu de la réponse de données, pour le vérifier et pour soumettre la réponse de données. Notez que la propriété référencée dans la réponse de données la plus récente remplacera la propriété dans la soumission de la réponse de données précédente.

header.banner.text