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

Ajouter un compteur

Mise à jour le 11 mars 2021

Description

Ce service Web crée un compteur pour une propriété spécifique en fonction de l'information fournie dans la demande XML, et il établit toutes les autres permissions de partage nécessaires entre vous et l'utilisateur Portfolio Manager. Il retourne l'identifiant unique au compteur nouvellement créé et un lien vers le service Web correspondant pour le récupérer. Cette propriété doit déjà être partagée avec vous et vous devez avoir l'accès en écriture pour cette propriété.

Version

22.0

Méthode HTTP

POST

URL de la ressource

/property/(propertyId)/meter

En-tête

Nom du champ Valeur Commentaires
Autorisation Basic authentifiant
Type de contenu application/xml

Autorisation requise

Oui

Paramètres

Nom du paramètre Description
propertyId Identifiant de la propriété à laquelle sera ajouté le compteur

Schémas XML

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

Exemples de demande

L'exemple suivant montre la création d'un nouveau compteur électrique appartenant à la propriété dont l'identifiant correspond à 893.

POST  /property/893/meter

<?xml version="1.0" encoding="UTF-8"?>
<meter>
    <type>Electric</type>
    <name>Electric Main Meter</name>
    <unitOfMeasure>kBtu (thousand Btu)</unitOfMeasure>
    <metered>true</metered>
    <firstBillDate>2010-01-01</firstBillDate>
    <inUse>true</inUse>
</meter>

L'exemple suivant montre la création d'un nouveau compteur de type Autre. Le compteur est créé pour la propriété dont l'identifiant correspond à 893.

POST  /property/893/meter

<?xml version="1.0" encoding="UTF-8"?>
<meter>
    <type>Other (Energy)</type>
    <name>Other</name>
    <otherDescription>Combination Fuel Type</otherDescription>
    <unitOfMeasure>kBtu (thousand Btu)</unitOfMeasure>
    <metered>true</metered>
    <firstBillDate>2010-01-01</firstBillDate>
    <inUse>true</inUse>
</meter>

L'exemple suivant montre la création d'un compteur énergétique TI (pour les centres de données). Le compteur TI est créé pour la propriété dont l'identifiant correspond à 893. Prenez note que le compteur TI doit être lié à un centre de données.

POST  /property/893/meter

<?xml version="1.0" encoding="UTF-8"?>
<meter>
    <type>Power Distribution Unit (PDU) Input Energy</type>
    <name>PDU Meter</name>
    <unitOfMeasure>kWh (thousand Watt-hours)</unitOfMeasure>
    <firstBillDate>2010-01-01</firstBillDate>
    <inUse>true</inUse>
</meter>

L'exemple suivant montre la création d'un compteur de déchets ramassés régulièrement pour une propriété dont l'identifiant correspond à 893.

POST  /property/893/meter

<?xml version="1.0" encoding="UTF-8"?>
<wasteMeter>
    <type>Disposed - Beverage Containers (aluminum, glass, plastic)</type>
    <name>Regular Collection of Beverage Containers</name>
    <unitOfMeasure>tons</unitOfMeasure>
    <dataEntryMethod>regular</dataEntryMethod>
    <firstBillDate>2010-01-01</firstBillDate>
    <inUse>true</inUse>
</wasteMeter>

L'exemple suivant montre la création d'un nouveau compteur électrique appartenant à la propriété dont l'identifiant correspond à 893 et le marque comme un compteur d'agrégats.

POST  /propriété/893/compteur

<?xml version="1.0" encoding="UTF-8"?>
<meter>
     <type>Electric</type>
     <name>Electric Main Meter</name>
     <unitOfMeasure>kBtu (thousand Btu)</unitOfMeasure>
     <metered>true</metered>
     <firstBillDate>2010-01-01</firstBillDate>
     <inUse>true</inUse>
     <aggregateMeter>true</aggregateMeter>
</meter>

Exemple de réponse

L'exemple suivant indique que le compteur a été créé avec succès. Il affiche aussi l'identifiant du nouveau compteur (432) et un lien Internet vers le service Web pour récupérer la propriété.

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