Documentation de service Web / Catégories / Services de signalement / Obtenez la liste de gabarits de rapport

Obtenez la liste de gabarits de rapport

Mise à jour le 12 février 2023

Description

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

Version

25.0

Méthode HTTP

GET

URL de la ressource

/reports/templates?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
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 modèles de rapports individualisés.

GET  /reports/templates?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="86123" httpMethod="GET" link="/reports/templates/86123" linkDescription="This is the GET url for this Template." hint="Energy Report 2022"/>
          <link id="18634" httpMethod="GET" link="/reports/templates/18634" linkDescription="This is the GET url for this Template." hint="Water Report 2022"/>
          <link id="8666" httpMethod="GET" link="/reports/templates/8666" linkDescription="This is the GET url for this Template." hint="City 2022 Data Request"/>
          <link id="85116" httpMethod="GET" link="/reports/templates/85116" linkDescription="This is the GET url for this Template." hint="Partner of the Year Report"/>
     </links>
</response>
ENVIRONNEMENT DE PRODUCTION