Documentation de service Web / Catégories / Services de compteur / Récupérer la liste de compteurs

Récupérer la liste de compteurs

Mise à jour le 8 août 2016

Description

Ce service Web récupère la liste de tous les compteurs pour une propriété donnée, ou seulements de celles dont vous avez accès. La propriété doit déjà être partagée avec vous.

Version

22.0

Méthode HTTP

GET

URL de la ressource

/property/(propertyId)/meter/list?myAccessOnly=(myAccessOnly)

En-tête

Nom du champ Valeur Commentaires
Autorisation Basic authentifiant

Autorisation requise

Oui

Paramètres

Nom du paramètre Description
myAccessOnly Facultatif. Si cette variable est réglée vrai, cet appel récupérera seulement les compteurs auxquels vous avez accès. Sinon, il récupérera tous les compteurs dans la propriété.
propertyId Identifiant de la propriété

Schémas XML

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

Exemples de demande

L'exemple suivant montre la récupération d'une liste de tous les compteurs pour une propriété dont l'identifiant correspond à 200.

GET  /property/200/meter/list

L'exemple suivant montre la récupération d'une liste de compteurs pour une propriété dont l'identifiant correspond à 200. Seuls les compteurs dont vous avez accès seront récupérés.

GET  /property/200/meter/list?myAccessOnly=true

Exemple de réponse

L'exemple suivant affiche la liste de compteurs qui appartiennent à la propriété dont l'identifiant correspond à 200. Cette liste comprend les liens de service Web permettant de récupérer l'information de chaque compteur. Chaque lien inclut une allusion an nom du compteur.

<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok">
    <links>
        <link httpMethod="GET" link="/meter/41" linkDescription="This is the GET url for this Meter." hint="Electric Main Meter"/>
        <link httpMethod="GET" link="/meter/23" linkDescription="This is the GET url for this Meter." hint="Water Main Meter"/>
    </links>
</response>
ENVIRONNEMENT DE PRODUCTION