Documentation de service Web / Catégories / Services des propriétés

Services des propriétés

Propriété

Méthode	REST URI *	Description
POST	/account/(accountId)/property	Crée une propriété pour l'utilisateur spécifié. Vous devez déjà être connecté à l'utilisateur.
GET	/account/(accountId)/property/list	Émet la liste des propriétés pour un utilisateur particuler. Seules les propriétés auxquelles vous avez accès seront affichées. Vous devez déjà être connecté à l'utilisateur.
**POST	/createSampleProperties?countryCode=(countryCode)&createCount=(createCount)	Crée un ensemble d’échantillons de propriétés. Cet appel n’est disponible que dans l’environnement d’essai. **
GET	/customer/(customerId)/property/whatChanged?date=(YYYY-MM-DD)	Récupère une liste des propriétés qui ont été modifiées depuis une date précise.
GET	/idHierarchy/property/(propertyId)	Retourne l'identifiant de l'Administrateur des données de propriété (accountId) pour une propriété donnée.
GET	/property/(propertyId)	Émet l'information pour une propriété spécifique. La propriété doit déjà être partagée avec vous. Ce service peut aussi être utilisé pour un bâtiment.
PUT	/property/(propertyId)	Effectue la mise à jour de l'information pour une propriété spécifique. La propriété doit déjà être partagée avec vous.
DELETE	/property/(propertyId)	Supprime la propriété spécifiée. La propriété doit déjà être partagée avec vous.

Conception

Méthode	REST URI *	Description
GET	/property/(propertyId)/design	Retourne les valeurs pour l'ensemble des caractéristiques de conception d'une propriété existante. La propriété doit déjà être partagée avec vous.
PUT	/property/(propertyId)/design	Met à jour l'ensemble des caractéristiques de conception d'une propriété existante. La propriété doit déjà être partagée avec vous.

Mesures personnalisées

Méthode	REST URI *	Description
GET	/property/(propertyId)/customMetrics	Renvoie une liste de mesures personnalisées pour une propriété donnée. La propriété doit déjà être partagée avec vous.
GET	/property/(propertyId)/customMetrics/(customMetricSlot)	Ce service Web renvoie des renseignements relatifs à une mesure personnalisée particulière pour une propriété donnée. La propriété doit déjà être partagée avec vous.
POST	/property/(propertyId)/customMetrics/(customMetricSlot)	Ajoute une mesure personnalisée pour une propriété donnée. La propriété doit déjà être partagée avec vous et vous devez avoir un accès en écriture à la propriété.
PUT	/property/(propertyId)/customMetrics/(customMetricSlot)	Met à jour une mesure personnalisée particulière pour une propriété donnée. La propriété doit déjà être partagée avec vous.
DELETE	/property/(propertyId)/customMetrics/(customMetricSlot)	Supprime une mesure personnalisée particulière pour une propriété donnée. La propriété doit déjà être partagée avec vous.
GET	/property/(propertyId)/customMetrics/availablePropertyUseDetails	Renvoie une liste des détails d'utilisation d'une propriété donnée qui peuvent être utilisés pour définir une mesure personnalisée (le dénominateur d'une mesure personnalisée). La propriété doit déjà être partagée avec vous.
GET	/reports/metrics?groupIds=(groupIds)&availableToCustomMetrics=true	Renvoie une liste de mesures disponibles qui peuvent être utilisées pour définir une mesure personnalisée (le numérateur d'une mesure personnalisée).

Service public de distribution d'électricité

Méthode	REST URI *	Description
PUT	/property/(propertyId)/edu/(eduCode)	Affecte un service public de distribution électrique pour une propriété donnée. Le taux d'émission électrique pour cette propriété sera basé sur ce service public de distribution électrique. La propriété doit déjà être partagée avec vous et vous devez avoir un accès en écriture à cette propriété.
GET	/property/(propertyId)/edu/list	Émet la liste des services publics de distribution électrique qui peuvent être affectés à une propriété particulière. La liste indique aussi le service public de distribution électrique actuellement affecté à la propriété. La propriété doit déjà être partagée avec vous et vous devez avoir un accès en écriture à cette propriété.

Usine de production d'énergie

Méthode	REST URI *	Description
DELETE	/property/(propertyId)/pgp	Supprime la centrale électrique actuellement assignée à la propriété spécifiée et ne laisse aucune centrale électrique assignée à la propriété.
PUT	/property/(propertyId)/pgp/(plantCode)	Affecte une centrale électrique particulière à une propriété donnée. Le taux d'émission électrique pour cette propriété sera basé sur cette centrale de distribution électrique. La propriété doit déjà être partagée avec vous et vous devez avoir un accès en écriture à cette propriété.
GET	/property/(propertyId)/pgp/list	Émet la liste des centrales électriques pour une propriété spécifique. La liste indique aussi la centrale électrique actuellement affectée à la propriété. La propriété doit déjà être partagée avec vous et vous devez avoir un accès en écriture à cette propriété.

La station météorologique Internationale

Méthode	REST URI *	Description
PUT	/property/(propertyId)/internationalWeatherStation/(internationalWeatherStationId)	Attribue une station météorologique internationale précise à une propriété donnée. La station météorologique est utilisée afin de déterminer les conditions météorologiques de référence pour votre propriété.
GET	/property/internationalWeatherStation/list?page=(page)&country=(country)	Affiche une liste des stations météorologiques internationales pour un code pays précis.

Identificateurs uniques

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

Informations de vérification

Méthode	REST URI *	Description
GET	/property/(propertyId)/verification	Émet les informations de vérification pour une propriété spécifique. La propriété doit déjà être partagée avec vous. Ce service peut aussi être utilisé pour un bâtiment.
POST	/property/(propertyId)/verification	Crée des renseignements de vérification sous une propriété en particulier. La propriété doit déjà avoir été partagée avec vous.
PUT	/property/(propertyId)/verification	Effectue la mise à jour de l'information de vérification pour une propriété spécifique. La propriété doit déjà être partagée avec vous.
DELETE	/property/(propertyId)/verification	Supprime les informations de vérification sous une propriété spécifique. La propriété doit déjà être partagée avec vous.
GET	/property/(propertyId)/verification/professionalDesignation	Retourne la portion partie du titre professionnel des renseignements de vérification pour une propriété en particulier. La propriété doit déjà avoir été partagée avec vous. Ce service peut aussi être utilisé pour un bâtiment.
DELETE	/property/(propertyId)/verification/professionalDesignation	Supprime toutes les données sur les titres professionnels des renseignements de vérification pour une propriété en particulier. La propriété doit déjà avoir été partagée avec vous. Ce service peut aussi être utilisé pour un bâtiment.
POST	/property/(propertyId)/verification/professionalDesignation/(designationTypeId)	Crée un titre professionnel précis dans les renseignements de vérification pour une propriété en particulier. La propriété doit déjà avoir été partagée avec vous. Ce service peut aussi être utilisé pour un bâtiment.
PUT	/property/(propertyId)/verification/professionalDesignation/(designationTypeId)	Met à jour les permis pour un titre professionnel précis qui se rattache aux renseignements de vérification d’une propriété. La propriété correspondante doit déjà avoir été partagée avec vous.
DELETE	/property/(propertyId)/verification/professionalDesignation/(designationTypeId)	Supprime un type de titre professionnel précis et ses permis à partir des renseignements de vérification pour une propriété en particulier. La propriété correspondante doit déjà avoir été partagée avec vous.
PUT	/property/(propertyId)/verification/professionalDesignation/(designationTypeId)/(index)	Met à jour le permis professionnel précis pour un titre professionnel précis de vérification d’une propriété. La propriété correspondante doit déjà avoir été partagée avec vous.
DELETE	/property/(propertyId)/verification/professionalDesignation/(designationTypeId)/(index)	Supprime un permis de titre professionnel unique précis sous les renseignements de vérification pour une propriété en particulier. La propriété correspondante doit déjà avoir été partagée avec vous.
GET	/property/professionalDesignation/list	Renvoie une liste de types de titre professionnel.

Divers

Méthode	REST URI *	Description
GET	/billboardMetric/list	Renvoie une liste des mesures pouvant être utilisées pour mettre à jour le « tableau d'affichage » pour les utlisateurs finaux.
GET	/customer/(customerId)/property/(propertyId)/billboardMetricSetting	Renvoie le réglage des mesures du « tableau d'affichage » utilisé par un client et une propriété en particulier.
PUT	/customer/(customerId)/property/(propertyId)/billboardMetricSetting	Mettre à jour les mesures présentées dans le « tableau d'affichage » pour un compte et une propriété d'un client.
GET	/energyPerformanceProject/(energyPerformanceProjectId)	Retourne les informations sur un projet de rendement énergétique particulier. La propriété associée doit déjà être partagée avec vous.
PUT	/energyPerformanceProject/(energyPerformanceProjectId)	Met à jour les informations sur un projet de rendement énergétique particulier. La propriété associée doit déjà être partagée avec vous.
DELETE	/energyPerformanceProject/(energyPerformanceProjectId)	Supprime un projet de rendement énergétique particulier. La propriété associée doit déjà être partagée avec vous.
GET	/property/(propertyId)/baselineAndTarget	Récupère les paramètres de rendement de référence et cible.
PUT	/property/(propertyId)/baselineAndTarget	Met à jour les paramètres de rendement de référence et cible.
GET	/property/(propertyId)/billboardMetricSetting	Renvoie les paramètres métriques du « tableau d'affichage » pour le compte authentifié et la propriété indiquée.
PUT	/property/(propertyId)/billboardMetricSetting	Mettre à jour les mesures présentées dans le « tableau d'affichage » pour votre compte et la propriété.
GET	/property/(propertyId)/customFieldList	Émet une liste de champs personnalisés et leurs valeurs correspondantes pour une propriété spécifique.
POST	/property/(propertyId)/energyPerformanceProject	Ajoute un projet de rendement énergétique à une propriété particulière. La propriété doit déjà être partagée avec vous avec un accès en écriture.
GET	/property/(propertyId)/energyPerformanceProject/list	Récupère une liste de projets de rendement énergétique pour une propriété particulière. La propriété doit déjà être partagée avec vous.
GET	/property/eGridSubregion/list	Retourne une liste de sous-régions eGrid.
GET	/property/federalAgency/list	Émet la liste des organismes fédéraux.

* 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.