Documentation de service Web / Catégories / Services de compteur / Get Meter Consumption Data (Récupérer les données de consommation du compteur)

Get Meter Consumption Data (Récupérer les données de consommation du compteur)

Mise à jour le 14 août 2017

Description

Ce service Web récupère les données de consommation d'un compteur particulier. Le compteur doit déjà être partagé avec vous. Les données de consommation sont affichées par ensembles de 120 résultats. Facultativement, on peut préciser une gamme de dates pour récupérer un ensemble particulier de fiches de consommation.

Version

22.0

Méthode HTTP

GET

URL de la ressource

/meter/(meterId)/consumptionData?page=(page)&startDate=(YYYY-MM-DD)&endDate=(YYYY-MM-DD)

En-tête

Nom du champ	Valeur	Commentaires
Autorisation	Basic authentifiant

Autorisation requise

Oui

Paramètres

Nom du paramètre	Description
endDate	Facultatif. Indique la date de fin d'une gamme de dates personnalisée pour la récupération des données de consommation. Doit être une date valide, dans le format AAAA-MM-JJ.
meterId	Identifiant du compteur
page	Facultatif. Indique l'ensemble de résultats, défini par numéro de page, à récupérer. Ce paramètre n'est généralement pas inclus dans l'appel initial, et est fourni si les résultats sont paginés.
startDate	Facultatif. Indique la date de début d'une gamme de dates personnalisée pour la récupération des données de consommation. Doit être une date valide, dans le format AAAA-MM-JJ.

Schémas XML

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

Exemple de demande

L'exemple suivant montre la récupération des données de consommation pour un compteur dont l'identifiant correspond à 100. Pour récupérer seulement les fiches de consommation pour la période entre le 1 janvier 2011 et le 31 décembre 2011, vous devez fournir les paramètres URL suivants : startDate=2011-01-01&endDate=2011-12-31

GET  /meter/100/consumptionData

Exemple de réponses

L'exemple suivant affiche le premier ensemble de 120 fiches de consommation pour un compteur configuré pour les mesure précises et fournit un lien vers le prochain ensemble. Pour cet exemple, on suppose que plus de 120 fiches soient récupérées.

<?xml version="1.0" encoding="UTF-8"?>
<meterData>
    <meterConsumption estimatedValue="false">
        <id>-19</id>
        <audit>
            <createdBy>DUNAYT</createdBy>
            <createdByAccountId>-14</createdByAccountId>
            <createdDate>2012-05-25T09:59:06-04:00</createdDate>
            <lastUpdatedBy>DUNAYT</lastUpdatedBy>
            <lastUpdatedByAccountId>-14</lastUpdatedByAccountId>
            <lastUpdatedDate>2012-05-26T09:59:06-04:00</lastUpdatedDate>
        </audit>
        <startDate>2011-07-09</startDate>
        <endDate>2011-08-08</endDate>
        <usage>638021</usage>
    </meterConsumption>
    <meterConsumption estimatedValue="false">
        <id>-18</id>
        <audit>
            <createdBy>DUNAYT</createdBy>
            <createdByAccountId>-14</createdByAccountId>
            <createdDate>2012-05-25T09:59:06-04:00</createdDate>
                <lastUpdatedBy>DUNAYT</lastUpdatedBy>
            <lastUpdatedByAccountId>-14</lastUpdatedByAccountId>
            <lastUpdatedDate>2012-05-25T09:59:06-04:00</lastUpdatedDate>
        </audit>
        <startDate>2011-06-09</startDate>
        <endDate>2011-07-09</endDate>
        <usage>625291</usage>
    </meterConsumption>
    <meterConsumption estimatedValue="false">
        <id>-17</id>
        <audit>
            <createdBy>DUNAYT</createdBy>
            <createdByAccountId>-14</createdByAccountId>
            <createdDate>2012-05-25T09:59:06-04:00</createdDate>
            <lastUpdatedBy>DUNAYT</lastUpdatedBy>
            <lastUpdatedByAccountId>-14</lastUpdatedByAccountId>
            <lastUpdatedDate>2012-05-25T09:59:06-04:00</lastUpdatedDate>
        </audit>
        <startDate>2011-05-10</startDate>
        <endDate>2011-06-09</endDate>
        <usage>610219</usage>
    </meterConsumption>

    ...

    <links>
        <link httpMethod="get" link="/meter/100/consumptionData?page=2" linkDescription="next page"/>
    </links>
</meterData>

L'exemple ci-dessous récupère le premier ensemble de 120 fiches de livraison pour un compteur configuré pour la livraison en vrac, et fournit un lien vers le prochain ensemble. Pour cet exemple, on suppose que plus de 120 fiches soient récupérées.

<?xml version="1.0" encoding="UTF-8"?>
<meterData>
    <meterDelivery estimatedValue="false">
        <id>-40</id>
        <audit>
            <createdBy>DUNAYT</createdBy>
            <createdByAccountId>-14</createdByAccountId>
            <createdDate>2012-05-25T09:59:06-04:00</createdDate>
            <lastUpdatedBy>DUNAYT</lastUpdatedBy>
            <lastUpdatedByAccountId>-14</lastUpdatedByAccountId>
            <lastUpdatedDate>2012-05-26T09:59:06-04:00</lastUpdatedDate>
        </audit>
        <deliveryDate>2010-02-22</deliveryDate>
        <quantity>1400</quantity>
    </meterDelivery>
    <meterDelivery estimatedValue="false">
        <id>-43</id>
        <audit>
            <createdBy>DUNAYT</createdBy>
            <createdByAccountId>-14</createdByAccountId>
            <createdDate>2012-05-25T09:59:06-04:00</createdDate>
            <lastUpdatedBy>DUNAYT</lastUpdatedBy>
            <lastUpdatedByAccountId>-14</lastUpdatedByAccountId>
            <lastUpdatedDate>2012-05-25T09:59:06-04:00</lastUpdatedDate>
        </audit>
        <deliveryDate>2011-01-05</deliveryDate>
        <quantity>1000</quantity>
    </meterDelivery>
    <meterDelivery estimatedValue="false">
        <id>-41</id>
        <audit>
            <createdBy>DUNAYT</createdBy>
            <createdByAccountId>-14</createdByAccountId>
            <createdDate>2012-05-25T09:59:06-04:00</createdDate>
            <lastUpdatedBy>DUNAYT</lastUpdatedBy>
            <lastUpdatedByAccountId>-14</lastUpdatedByAccountId>
            <lastUpdatedDate>2012-05-25T09:59:06-04:00</lastUpdatedDate>
        </audit>
        <deliveryDate>2010-03-15</deliveryDate>
        <quantity>800</quantity>
    </meterDelivery>

    ...

    <links>
        <link httpMethod="get" link="/meter/101/consumptionData?page=2" linkDescription="next page"/>
    </links>
</meterData>

header.banner.text