Documentation de service Web / Catégories / Services de compte de base

Services de compte de base

Les services de comptes vous permettent de gérer les comptes de Portfolio Manager. Ces services sont divisés en deux sections. La première section comprend les services qui vous permettent de créer et de gérer votre propre compte ainsi que les comptes appartenant à vos clients. La deuxième section comprend les services qui vous permettent de gérer les paramètres avancés qui définissent vos services, comme vos conditions d'utilisation, les types de carburant pris en charge, les champs personnalisés, etc.

Comptes

Méthode REST URI * Description
GET /account Émet l'information générale pour votre compte.
POST /account Crée un compte destiné à offrir les services d'échange de données.
PUT /account Effectue la mise à jour de votre compte.
GET /account/(accountId)/customFieldList Émet une liste de champs personnalisés et leurs valeurs pour un compte client spécifié.
GET /billboardMetric/list Renvoie une liste de mesures pouvant être utilisées pour mettre à jour le « tableau d'affichage » présenté aux utilisateurs finaux.
POST /customer Crée un compte pour votre client et établit une connexion à votre compte.
GET /customer/(customerId) Émet l'information générale de compte pour un client spécifié avec qui vous êtes connecté.
PUT /customer/(customerId) Effectue la mise à jour d'un compte pour un client avec qui vous êtes déjà connecté.
GET /customer/list Émet la liste des clients avec qui vous avez des connexions.

Paramètres avancés pour les organismes qui s'échangent des données

Méthode REST URI * Description
GET /dataExchangeSettings Émet les paramètres qui définissent votre service d'échange de données.
PUT /dataExchangeSettings Effectue la mise à jour des paramètres qui définissent votre service d'échange de données.
POST /dataExchangeSettings/customField Crée un champ personnalisé. Les champs personnalisés que vous sélectionnez sont utilisés pour recueillir des données supplémentaires de vos clients pendant le processus de connexion/partage.
GET /dataExchangeSettings/customField/(customFieldId) Émet l'information pour un champ personnalisé spécifique. Les champs personnalisés que vous sélectionnez sont utilisés pour recueillir des données supplémentaires de vos clients pendant le processus de connexion/partage.
PUT /dataExchangeSettings/customField/(customFieldId) Effectue la mise à jour du champ personnalisé spécifié. Les champs personnalisés que vous sélectionnez sont utilisés pour recueillir des données supplémentaires de vos clients pendant le processus de connexion/partage.
DELETE /dataExchangeSettings/customField/(customFieldId) Supprime le champ personnalisé spécifié. Les champs personnalisés que vous sélectionnez sont utilisés pour recueillir des données supplémentaires de vos clients pendant le processus de connexion/partage.
GET /dataExchangeSettings/customField/list Émet la liste de champs personnalisés que vous avez définis pour votre compte. Les champs personnalisés que vous sélectionnez sont utilisés pour recueillir des données supplémentaires de vos clients pendant le processus de connexion/partage.

* 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