Documentation de service Web / Catégories / Services de signalement / Guide de l’API pour les rapports ENERGY STAR

Guide de l’API pour les rapports ENERGY STAR

Organisation des API

Les API des rapports ENERGY STAR ne visent qu’une seule composante importante que vous devriez connaître:

• Rapport

Les rapports ENERGY STAR contiennent des mesures sélectionnées par l’EPA pour vous aider à comprendre les principaux aspects de votre rendement. Cela signifie que vous n’avez pas à utiliser de composante de gabarit. Vous n’utilisez donc qu’une composante de type rapport.

Rapport

Une composante de rapport est constituée d’une période (c’est-à-dire une date de fin de période précise, une plage de dates ou autres) et d’un ensemble de propriétés. L’identifiant unique de cette composante s’appelle reportId. Vous utilisez un rapport lorsque vous effectuez l’une des actions suivantes dans un rapport ENERGY STAR:

• mettre à jour la période d'un rapport
• mettre à jour l’ensemble des propriétés
• produire le rapport
• vérifier l’état du rapport
• télécharger les résultats du rapport

Guide de référence rapide

Vous trouverez ci-dessous un guide de référence pour configurer et exécuter un rapport ENERGY STAR.

Définir la liste des propriétés et la période d’un rapport ENERGY STAR

Étape	Méthode	URI REST	Description
1.	GET	/reports?type=ENERGY_STAR	Obtenez une liste récente des rapports ENERGY STAR et l'identifiant reportId du rapport correspondant que vous voulez configurer. Cette étape peut être omise si vous connaissez déjà le rapport ENERGY STAR en question.
2.	PUT	/reports/(reportId)	Mettez à jour le rapport avec une liste de propriétés et une période en utilisant l’identifiant reportId.
3.	POST	/reports/(reportId)/generate	Produisez le rapport en utilisant l’identifiant reportId.
4.	GET	/reports/(reportId)/status	Vérifiez l’état du rapport en utilisant l’identifiant reportId jusqu’à ce que le rapport ait fini d’être généré.
5.	GET	/reports/(reportId)/download?type=(type)	Téléchargez les résultats du rapport (si la production du rapport est terminée) en utilisant l’identifiant reportId. Le rapport est diffusé sous forme de fichier. Un fichier Excel ou XML est rediffusé et ne fait pas partie de la réponse XML.