Documentation de service Web / Catégories / Services de compteur

Services de compteur

Les services de compteurs vous permettent de gérer les compteurs dans Portfolio Manager. Ces services prennent en charge toutes les catégories de compteur (tous les carburants, l'eau, la TI des centres de traitement de données, les déchets, le débit d'eau et d'eau usée). Vous avez également la possibilité de définir l'énergie verte. Vous devez déjà être connecté à vos clients pour pouvoir gérer leurs compteurs.

Compteur

Méthode REST URI * Description
GET /customer/(customerId)/meter/whatChanged?date=(YYYY-MM-DD) Récupère une liste des compteurs qui ont été modifiés depuis une date spécifique.
GET /idHierarchy/meter/(meterId) Retourne l'identifiant de l'Administrateur des données de propriété (accountId) et de la propriété pour un compteur donné.
GET /meter/(meterId) Émet l'information pour un compteur donné. Le compteur doit déjà être partagé avec vous.
PUT /meter/(meterId) Effectue la mise à jour de l'information pour un compteur spécifique. Le compteur doit déjà être partagé avec vous et vous devez avoir l'accès en écriture pour ce compteur.
DELETE /meter/(meterId) Supprime le compteur spécifié. Le compteur doit déjà être partagé avec vous.
POST /property/(propertyId)/meter Ajoute un compteur pour une propriété spécifique. Cette propriété doit déjà être partagée avec vous et vous devez avoir l'accès en écriture pour cette propriété.
GET /property/(propertyId)/meter/list?myAccessOnly=(myAccessOnly) Émet la liste des compteurs pour une propriété donnée. La propriété doit déjà être partagée avec vous.
GET /property/(propertyId)/meter/whatChanged?date=(YYYY-MM-DD) Permet de renvoyer une liste de compteurs qui ont été modifiés depuis une date précise, pour une propriété bien déterminée.

Association de compteurs pour propriété

Méthode REST URI * Description
GET /association/property/(propertyId)/meter Retourne la liste des compteurs qui sont associés à une propriété donnée. La propriété correspondante doit déjà être partagée avec vous.
POST /association/property/(propertyId)/meter Associe une liste de compteurs sélectionnés à une propriété donnée. La propriété et les compteurs à associer doivent déjà être partagés avec vous.
POST /association/property/(propertyId)/meter/(meterId) Associe un compteur (unique) donné à une propriété donnée. La propriété et le compteur doivent déjà être partagés avec vous.
DELETE /association/property/(propertyId)/meter/(meterId) Dissocie un compteur sélectionné d'une propriété donnée. La propriété et le compteur doivent déjà être partagés avec vous.

Association de compteurs pour utilisation dans les propriétés

Méthode REST URI * Description
GET /association/propertyUse/(propertyUseId)/meter Retourne la liste des compteurs qui sont associés à une utilisation de propriété donnée. La propriété correspondante doit déjà être partagée avec vous.
POST /association/propertyUse/(propertyUseId)/meter Associe une liste de compteurs sélectionnés pour une utilisation de propriété donnée. La propriété correspondante et les compteurs doivent déjà être partagés avec vous.
POST /association/propertyUse/(propertyUseId)/meter/(meterId) Associe un compteur (unique) donné à une utilisation de propriété donnée. La propriété et le compteur doivent déjà être partagés avec vous.
DELETE /association/propertyUse/(propertyUseId)/meter/(meterId) Dissocie un compteur sélectionné d'une utilisation de la propriété donnée. La propriété et le compteur doivent déjà être partagés avec vous.

Données de consommation

Méthode REST URI * Description
PUT /consumptionData/(consumptionDataId) Effectue la mise à jour d'une entrée spécifique de données de consommation de compteur. Le compteur doit déjà être partagé avec vous et vous devez y avoir l'accès en écriture.
DELETE /consumptionData/(consumptionDataId) Supprime une entrée de données de consommation d'un compteur spécifique. Le compteur doit déjà être partagé avec vous et vous devez avoir l'accès en écriture pour ce compteur.
GET /customer/(customerId)/meter/consumptionData/whatChanged?date=(YYYY-MM-DD) Récupère une liste de compteurs d'un client spécifique qui ont subi des modifications à leurs données de consommation depuis une date spécifique.
GET /idHierarchy/consumptionData/(consumptionDataId) Retourne l'identifiant de l'Administrateur des données de propriété (accountId), de la propriété et du compteur pour une fiche de consommation donnée.
POST /meter/(meterId)/consumptionData Ajoute les données de consommation, d'énergie verte (facultative) et de demande (facultative) à un compteur spécifique. La propriété à laquelle appartient le compteur doit déjà être partagée avec vous et vous devez avoir l'accès en écriture pour ce compteur.
GET /meter/(meterId)/consumptionData?page=(page)&startDate=(YYYY-MM-DD)&endDate=(YYYY-MM-DD) Récupère les données de consommation pour un compteur donné en ensembles de 120. Le compteur doit déjà être partagé avec vous.
DELETE /meter/(meterId)/consumptionData?startDate=(YYYY-MM-DD)&endDate=(YYYY-MM-DD) Supprime toutes les données de consommation d'un compteur spécifique. Le compteur doit déjà être partagé avec vous et vous devez y avoir l'accès en écriture.

Green Power Offsite

Méthode REST URI * Description
GET /offsiteGreenPowerPurchases/(id) Returns information for a specific offsite Green Power purchase record. The corresponding property must already be shared with you.
PUT /offsiteGreenPowerPurchases/(id) Updates a specific offsite Green Power purchase record. The corresponding property must already be shared with you and you must have write access to the property.
DELETE /offsiteGreenPowerPurchases/(id) Deletes a specific offsite Green Power purchase record. The corresponding property must already be shared with you and you must have write access to the property.
GET /property/(propertyId)/offsiteGreenPowerPurchases Returns a list of offsite Green Power purchases for a specific property. The corresponding property must already be shared with you.
POST /property/(propertyId)/offsiteGreenPowerPurchases Adds an offsite Green Power purchase record to a specific property. The corresponding property must already be shared with you and you must have write access to the property.

Green Power Onsite

Méthode REST URI * Description
GET /meter/(meterId)/onsiteRenewableDetails Returns information for all of the onsite Green Power renewable detail records for a specific meter in sets of 1000. You must have access to the meter.
POST /meter/(meterId)/onsiteRenewableDetails Adds an onsite Green Power renewable detail record for a specified meter. The meter must already be shared with you and you must have write access to the meter.
GET /meter/(meterId)/onsiteRenewableOptionalInfo Returns the additional/optional onsite Green Power renewable detail information for a specific meter. The meter must already be shared with you.
POST /meter/(meterId)/onsiteRenewableOptionalInfo Adds additional/optional onsite Green Power renewable detail information for a specific meter. The meter must already be shared with you and you must have write access to the meter.
PUT /meter/(meterId)/onsiteRenewableOptionalInfo Updates the additional/optional onsite Green Power renewable detail information for a specific meter. The meter must already be shared with you and you must have write access to the meter.
GET /onsiteRenewableDetails/(id) Returns information for a specific onsite Green Power renewable detail record. The meter must already be shared with you.
PUT /onsiteRenewableDetails/(id) Updates a specific onsite Green Power renewable detail record. The meter must already be shared with you and you must have write access to the meter.
DELETE /onsiteRenewableDetails/(id) Deletes a specific onsite Green Power renewable detail record. The meter must already be shared with you and you must have write access to the meter.

Données sur les déchets

Méthode REST URI * Description
GET /customer/(customerId)/meter/wasteData/whatChanged?date=(YYYY-MM-DD) Récupère une liste de compteurs d'un client spécifique qui ont subi des modifications à leurs données sur les déchets depuis une date spécifique.
GET /idHierarchy/wasteData/(wasteDataId) Récupère l'identifiant de l'Administrateur des données de propriété (accountId), de la propriété et du compteur pour une fiche précise de données sur les déchets.
POST /meter/(meterId)/wasteData Ajoute les données sur les déchets à un compteur donné. La propriété à laquelle appartient le compteur doit déjà être partagée avec vous et vous devez avoir l'accès en écriture pour ce compteur.
GET /meter/(meterId)/wasteData?page=(page)&startDate=(YYYY-MM-DD)&endDate=(YYYY-MM-DD) Émet les données sur les déchets pour un compteur donné en ensembles de 120. Le compteur doit déjà être partagé avec vous.
DELETE /meter/(meterId)/wasteData?startDate=(YYYY-MM-DD)&endDate=(YYYY-MM-DD) Supprime toutes les données sur les déchets d'un compteur de déchets spécifique. Le compteur doit déjà être partagé avec vous et vous devez y avoir l'accès en écriture.
PUT /wasteData/(wasteDataId) Effectue la mise à jour d'une entrée de données sur les déchets. Le compteur doit déjà être partagé avec vous et vous devez avoir l'accès en écriture pour ce compteur.
DELETE /wasteData/(wasteDataId) Supprime une entrée de données sur les déchets d'un compteur donnée. Le compteur doit déjà être partagé avec vous et vous devez avoir l'accès en écriture pour ce compteur.

Identifiants uniques

Méthode REST URI * Description
POST /meter/(meterId)/identifier Ajoute un identifiant de compteur. Le compteur doit déjà être partagé avec vous.
GET /meter/(meterId)/identifier/(identifierId) Émet la valeur pour l'identifiant de compteur spécifié pour un compteur donnée. Le compteur doit déjà être partagée avec vous.
PUT /meter/(meterId)/identifier/(identifierId) Effectue la mise à jour de la valeur de l'identifiant spécifié pour un compteur spécifique. Le compteur doit déjà être partagée avec vous.
DELETE /meter/(meterId)/identifier/(identifierId) Supprime la valeur d’un identifiant particulier d’un compteur donné. Le compteur doit déjà avoir été partagé avec vous.
GET /meter/(meterId)/identifier/list Émet la liste de valeurs d'identifiant pour un compteur donnée. Le compteur doit déjà être partagée avec vous.
GET /meter/identifier/list Émet la liste d'identifiants standard et uniques dont l'utilisation est approuvée par l'EPA.
GET /property/(propertyId)/meter/identifier/list Émet la liste de toutes de valeurs d'identifiant pour un compteur donnée. Le compteur doit déjà être partagée avec vous.

Agrégation du compteur

Méthode REST URI * Description
GET /meter/(meterId)/aggregateMeter Récupère des informations si le compteur spécifié est un compteur global qui représente plusieurs compteurs individuels.
POST /meter/(meterId)/individual Ajouter un compteur individuel à un compteur individuel qui sont compris dans le total du compteur agrégé. Le compteur agrégé doit déjà être partagé avec vous et vous devez avoir un accès en écriture.
DELETE /meter/(meterId)/individual Supprime tous les renseignements des compteurs individuels qui sont compris dans le total du compteur agrégé. Le compteur agrégé doit déjà être partagé avec vous et vous devez avoir un accès en écriture.
GET /meter/(meterId)/individual/list Affiche une liste de tous les compteurs individuels qui sont agrégés dans le compteur parent spécifié. Le compteur parent doit déjà être partagé avec vous.
GET /meter/individual/(individualMeterId) Affiche les renseignements relatifs à un compteur individuel qui sont compris dans le total du compteur agrégé. Le compteur agrégé doit déjà être partagé avec vous.
PUT /meter/individual/(individualMeterId) Met à jour les renseignements relatifs à un compteur individuel qui sont compris dans le total du compteur agrégé. Le compteur agrégé doit déjà être partagé avec vous et vous devez avoir un accès en écriture.
DELETE /meter/individual/(individualMeterId) Supprime les renseignements relatifs à un compteur individuel qui sont compris dans le total du compteur agrégé. Le compteur agrégé doit déjà être partagé avec vous et vous devez avoir un accès en écriture.

Divers

Méthode REST URI * Description
GET /meter/(meterId)/customFieldList Émet une liste de vos champs personnalisés et leurs valeurs pour un compteur spécifique.

* Pour l'environnement d'essai, par rapport à l'URI de base :  https://portfoliomanager.energystar.gov/wstest

** services Web sont uniquement disponibles dans l'environnement d'essai.

ENVIRONNEMENT D'ESSAI