Documentation de service Web / Catégories / Services de signalement / Récupérer la liste de rapports

Récupérer la liste de rapports

Mise à jour le 12 février 2023

Description

Ce service Web renvoie la liste des rapports de votre compte.

Version

22.0

Méthode HTTP

GET

URL de la ressource

/reports?type=(type)

En-tête

Nom du champ Valeur Commentaires
Autorisation Basic authentifiant

Autorisation requise

Oui

Paramètres

Nom du paramètre Description
type Facultatif. Précise le type de gabarit de rapport à retourner. Voici les paramètres valides:
  • CUSTOM
  • ENERGY_STAR
  • DATA_REQUEST
  • DATA_RESPONSE
Valeur par défaut : tous. Seuls les paramètres CUSTOM et ENERGY_STAR sont actuellement pris en charge.

Schémas XML

Demande/réponse Nom de schéma
Demande Aucun
Réponse response.xsd

Exemple de demande

L’exemple suivant récupère tous les rapports individualisés.

GET  /reports?type=CUSTOM

Exemple de réponse

L’exemple suivant montre les résultats lorsque vous utilisez ce service Web.

<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok">
     <links>
          <link id="2209517" hint="My Energy Savings" linkDescription="This is the GET url for this Report." link="/reports/2209517" httpMethod="GET"/>
          <link id="2209514" hint="Energy Report 2022" linkDescription="This is the GET url for this Report." link="/reports/2209514" httpMethod="GET"/>
          <link id="2209516" hint="Water Report 2022" linkDescription="This is the GET url for this Report." link="/reports/2209516" httpMethod="GET"/>
     </links>
</response>
ENVIRONNEMENT D'ESSAI