Documentation de service Web / Catégories / Services de compteur / Récupérer des données sur les déchets

Récupérer des données sur les déchets

Mise à jour le 8 août 2016

Description

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

Version

22.0

Méthode HTTP

GET

URL de la ressource

/meter/(meterId)/wasteData?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 sur les déchets. 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 sur les déchets. 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 wasteData.xsd

Exemple de demande

L'exemple suivant montre la récupération des données sur les déchets pour un compteur dont l'identifiant correspond à 100. Pour récupérer seulement les fiches sur les déchets 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/wasteData

Exemple de réponse

L'exemple suivant affiche le premier ensemble de 120 fiches sur les déchets et fournit un lien vers le prochain ensemble. Pour cet exemple, on suppose que plus de 20 fiches soient récupérées.

<?xml version="1.0" encoding="UTF-8"?>
<wasteDataList>
    <wasteData estimatedValue="true">
        <audit>
            <createdBy>ACME</createdBy>
            <createdDate>2016-06-02T15:08:52.663-04:00</createdDate>
            <lastUpdatedBy>ACME</lastUpdatedBy>
            <lastUpdatedDate>2016-06-02T15:08:52.663-04:00</lastUpdatedDate>
        </audit>
        <id>783569361</id>
        <startDate>2013-01-01</startDate>
        <endDate>2013-01-31</endDate>
        <quantity>50</quantity>
        <cost>100</cost>
        <disposalDestination>
            <id>597370</id>
            <incinerationPercentage>25</incinerationPercentage>
            <landfillPercentage>25</landfillPercentage>
            <unknownDestPercentage>25</unknownDestPercentage>
            <wasteToEnergyPercentage>25</wasteToEnergyPercentage>
        </disposalDestination>
    </wasteData>
    <wasteData estimatedValue="true">
        <audit>
            <createdBy>ACME</createdBy>
            <createdDate>2016-06-02T15:08:52.663-04:00</createdDate>
            <lastUpdatedBy>ACME</lastUpdatedBy>
            <lastUpdatedDate>2016-06-02T15:08:52.663-04:00</lastUpdatedDate>
        </audit>
        <id>783569362</id>
        <startDate>2013-02-01</startDate>
        <endDate>2013-02-28</endDate>
        <quantity>50</quantity>
        <cost>100</cost>
        <disposalDestination>
            <id>597373</id>
            <incinerationPercentage>25</incinerationPercentage>
            <landfillPercentage>25</landfillPercentage>
            <unknownDestPercentage>25</unknownDestPercentage>
            <wasteToEnergyPercentage>25</wasteToEnergyPercentage>
        </disposalDestination>
    </wasteData>

    ...

    <links>
        <link httpMethod="get" link="/meter/100/wasteData?page=2" linkDescription="next page"/>
    </links>
</wasteDataList>
ENVIRONNEMENT D'ESSAI