Documentation de service Web / Catégories / Services d'utilisation de la propriété

Services d'utilisation de la propriété

Les services d'usage de la propriété vous permettent de définir l'usage et l'exploitation d'une propriété. Ces services sont divisés en trois parties. Les deux premières parties (Usage de la propriété et Détails de l'usage) vous permettent d'ajouter, de mettre à jour et de supprimer les types d'usage d'une propriété, ainsi que de gérer leurs caractéristiques d'exploitation. La troisième partie (Usage personnalisé d'une propriété et détails de l'usage) vous permet de créer jusqu'à deux nouveaux détails d'usage personnalisé afin que vous puissiez suivre les renseignements les plus pertinents pour votre organisation. Pour en savoir plus sur les détails d'usage personnalisé, consultez les questions fréquemment posées.

Utilisation de la propriété

Méthode REST URI * Description
GET /customer/(customerId)/propertyUse/whatChanged?date=(YYYY-MM-DD) Affiche une liste d’utilisations de propriété dont les détails d’utilisation ont été modifiés depuis une date précise.
GET /idHierarchy/propertyUse/(propertyUseId) Retourne l'identifiant de l'Administrateur des données de propriété (accountId) et de la propriété pour une utilisation de propriété donnée.
POST /property/(propertyId)/propertyUse Crée une utilisation de la propriété pour une propriété spécifique. La propriété doit déjà être partagée avec vous.
GET /property/(propertyId)/propertyUse/list Émet la liste d'utilisations de propriété pour une propriété spécifique. La propriété doit déjà être partagée avec vous.
GET /propertyUse/(propertyUseId) Émet l'information pour une utilisation de propriété spécifique. L'information comprend des données générales sur l'utilisation de la propriété et sur ses détails d'utilisation courants. La propriété correspondante doit déjà être partagée avec vous.
PUT /propertyUse/(propertyUseId) Effectue la mise à jour d'une utilisation de la propriété spécifique. Actuellement, seul le nom peut être mis à jour. La propriété correspondante doit déjà être partagée avec vous.
DELETE /propertyUse/(propertyUseId) Supprime une utilisation de la propriété spécifique. La propriété correspondante doit déjà être partagée avec vous.

Détails d'utilisation

Méthode REST URI * Description
GET /customer/(customerId)/useDetails/whatChanged?date=(YYYY-MM-DD) Affiche une liste d’utilisations de propriété dont les détails d’utilisation ont été modifiés depuis une date précise.
GET /idHierarchy/useDetails/(useDetailId) Renvoie les identifiants à l’administrateur des données de la propriété (identifiant du compte), à la propriété et à l’utilisation de la propriété pour une fiche concernant un détail d'utilisation particulier.
POST /propertyUse/(propertyUseId)/useDetails Effectue la mise à jour d'un ensemble précis de détails d'utilisation de propriété (p. ex., heures d'exploitation, etc.). La mise à jour est apportée en tant que révision. La propriété correspondante doit déjà être partagée avec vous.
GET /propertyUse/(propertyUseId)/useDetailsRevisions?currentAsOfStart=(YYYY-MM-DD)&currentAsOfEnd=(YYYY-MM-DD) Émet l'historique de révision pour un ensemble précis de détails d'utilisation de propriété. La propriété correspondante doit déjà être partagée avec vous.
GET /useDetails/(useDetailsId) Retourne les informations particulières pour un détail d'utilisation donné. La propriété correspondante doit déjà être partagée avec vous.
PUT /useDetails/(useDetailsId) Effectue la mise à jour d'un ensemble précis de détails d'utilisation. La mise à jour est apportée en tant que correctif. La propriété correspondante doit déjà être partagée avec vous.

Usage personnalisé d'une propriété et détails de l’utilisation

Méthode REST URI * Description
GET /customUse/(propertyId) Renvoie des renseignements sur l'usage personnalisé de la propriété, si un tel usage a été défini pour la propriété indiquée. Les renseignements comprennent des données générales sur les détails de l'usage personnalisé qui ont été créés pour suivre les données importantes pour votre organisation.
GET /customUse/(propertyId)/detailRevisions?currentAsOfStart=(YYYY-MM-DD)&currentAsOfEnd=(YYYY-MM-DD) Renvoie l'historique des révisions des détails de l'utilisation personnalisé de la propriété. La propriété correspondante doit déjà être partagée avec vous.
POST /customUse/(propertyId)/details Met à jour un ensemble particulier de renseignements sur l’utilisation personnalisé. La mise à jour est effectuée en tant que révision. La propriété correspondante doit déjà être partagée avec vous.
GET /customUse/details/(detailsId) Renvoie des renseignements sur les détails d'utilisation particulier d'un détail d'utilisation personnalisé donné. La propriété correspondante doit déjà être partagée avec vous.
PUT /customUse/details/(detailsId) Met à jour un ensemble particulier de renseignements sur l’utilisation personnalisé. La mise à jour est effectuée en tant que correction. La propriété correspondante doit déjà être partagée avec vous.
DELETE /customUse/details/(detailsId) Supprime les détails d'un utilisation personnalisé particulier.

* 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