header.banner.text
Documentation de service Web / Catégories / Connexion/Services de partage
Connexion/Services de partage
Les services de connexion/partage vous permettent de vous connecter aux comptes existants Portfolio Manager et de partager des propriétés et des compteurs existants. Ces services sont divisés en deux sections. La première section comprend les services qui vous permettent de répondre aux demandes de connexion et de partage provenant des utilisateurs de Portfolio Manager. De plus, il existe des services qui vous permettent de vous déconnecter d'un utilisateur ou de supprimer tout partage de propriété ou de compteur d'un client. La deuxième section comprend les services qui vous permettent de vérifier le processus de connexion/partage dans l'environnement d'essai. Ces services vous permettent de générer les demandes de connexion et de partage qui vous sont transmises. Cela permet de simuler les demandes soumises par d'autres utilisateurs de Portfolio Manager. De plus, lorsque vous simulez la génération de ces demandes provenant d'autres utilisateurs de Portfolio Manager, vous pourrez soumettre les valeurs aux champs personnalisés que vous définissez avec chaque demande. Cet ensemble de services Web est seulement disponible dans l'environnement d'essai.
Connexion/Partage
| Méthode | REST URI * | Description |
|---|---|---|
| POST | /connect/account/(accountId) | Accepte/rejette une demande de connexion en attente d'un client spécifique. |
| GET | /connect/account/pending/list | Émet la liste de demandes clients de connexion en attente. |
| POST | /disconnect/account/(accountId)?keepShares=(keepShares) | Supprime les connexions existantes entre vous et un client spécifique. Les partages existants de propriétés et de compteurs entre vous et ce client sont aussi automatiquement supprimés. |
| GET | /notification/list?clear=(clear) | Récupère la liste de notifications lorsque se produit une déconnexion ou un arrêt de partage. |
| POST | /share/meter/(meterId) | Accepte/rejette une demande de partage pour un compteur spécifique. |
| GET | /share/meter/pending/list | Émet la liste de demandes de partage de compteur en attente. Ces demandes de partage de compteur appartiennent à des clients avec qui vous êtes déjà connectés. |
| POST | /share/property/(propertyId) | Accepte/rejette une demande de partage pour une propriété spécifique. |
| GET | /share/property/pending/list | Émet la liste de demandes de partage de propriété en attente. Ces demandes de partage de propriété appartiennent à des clients avec qui vous êtes déjà connectés. |
| POST | /unshare/meter/(meterId) | Supprime les partages existants entre vous et le compteur spécifié. |
| POST | /unshare/property/(propertyId) | Supprime les partages existants entre vous et la propriété spécifiée. Les partages de compteurs existants entre vous et ce client sont aussi automatiquement supprimés. |
Création de demandes de connexion/partage
| Méthode | REST URI * | Description |
|---|---|---|
| **PUT | /account/customFieldList/recipient/(dxAccountId) | Soumet un ensemble de valeurs pour un ensemble de champs personnalisés au niveau du client.** |
| **POST | /invite/account/(dxAccountId) | Crée une demande de connexion à votre intention de la part d'un client. Vous devez exécuter ce service Web au nom du client qui doit vous fournir la demande de connexion. Cela permet de simuler une demande de connexion à votre intention de la part d'un client.** |
| **POST | /invite/account/(dxAccountId)/meter/(meterId) | Crée une demande de partage d'un compteur donné à votre intention de la part d'un client. Vous devez exécuter ce service Web au nom du client qui doit amorcer la demande de partage de compteur, et le client doit avoir accès au compteur. Cela permet de simuler une demande de partage de compteur à votre intention de la part d'un client.** |
| **POST | /invite/account/(dxAccountId)/property/(propertyId) | Crée une demande de partage d'une propriété donnée à votre intention de la part d'un client. Vous devez exécuter ce service Web au nom du client qui doit amorcer la demande de partage de propriété, et le client doit avoir accès à la propriété. Cela permet de simuler une demande de partage de propriété de la part d'un client à votre intention.** |
| **PUT | /meter/(meterId)/customFieldList/recipient/(dxAccountId) | Soumet un ensemble de valeurs pour la liste de champs personnalisés au niveau du compteur.** |
| **PUT | /property/(propertyId)/customFieldList/recipient/(dxAccountId) | Soumet un ensemble de valeurs pour un ensemble de champs personnalisés au niveau de la propriété.** |
* 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.
