Documentation de service Web / Catégories / Services de compteur / Obtenir la liste des achats d’énergie verte produite hors site

Obtenir la liste des achats d’énergie verte produite hors site

Mise à jour le 30 juin 2024

Description

Ce service Web récupère une liste de tous les enregistrements d’achat d’énergie verte produite hors site pour une propriété précise. La propriété doit déjà être partagée avec vous.

Version

22.0

Méthode HTTP

GET

URL de la ressource

/property/(propertyId)/offsiteGreenPowerPurchases

En-tête

Nom du champ Valeur Commentaires
Autorisation Basic authentifiant

Autorisation requise

Oui

Paramètres

Nom du paramètre Description
propertyId Identifiant de la propriété

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 une liste de tous les enregistrements d’achat d’énergie verte produite hors site pour une propriété ayant un numéro d’identification 841.

GET  /property/841/offsiteGreenPowerPurchases

Exemple de réponse

L’exemple suivant renvoie une liste des enregistrements d’achat d’énergie verte produite hors site pour la propriété.

<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok">
     <links>
          <link id="145" hint="Community Choice Aggregation (2023-01-01 - 2023-12-31)" linkDescription="This is the GET url for this Offsite Green Power Purchase." link="/offsiteGreenPowerPurchases/145" httpMethod="GET"/>
          <link id="2345" hint="Community Choice Aggregation (2022-01-01 - 2022-12-31)" linkDescription="This is the GET url for this Offsite Green Power Purchase." link="/offsiteGreenPowerPurchases/2345" httpMethod="GET"/>
          <link id="345773" hint="Competitive Product (direct purchase) (2023-01-01 - 2023-12-31)" linkDescription="This is the GET url for this Offsite Green Power Purchase." link="/offsiteGreenPowerPurchases/345773" httpMethod="GET"/>
     </links>
</response>
ENVIRONNEMENT D'ESSAI