Documentation de service Web / Catégories / Services de compte de base / Créer un client

Créer un client

Mise à jour le 25 août 2019

Description

Ce service Web crée un compte pour un client en fonction de l'information fournie dans la demande XML et il établit une connexion à votre compte. Il retourne l'identifiant unique au compte nouvellement créé et un lien vers le service Web correspondant pour le récupérer.

. Après avoir créé un nouveau compte de Portfolio Manager pour votre client, vous voudrez peut-être lui fournir les renseignements sur son compte d'utilisateur (c.-à-d. nom d'utilisateur, mot de passe, questions de sécurité, etc.). Si vous décidez de leur fournir ces informations, vous devrez les communiquer en toute sécurité à votre client vous-même. Aucun des services Web de Portfolio Manager ne transmettra ces renseignements d'utilisateur à votre client pour vous.

Version

22.0

Méthode HTTP

POST

URL de la ressource

/customer

En-tête

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

Autorisation requise

Oui

Paramètres

Aucun

Schémas XML

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

Exemples de demande

L'exemple suivant montre la création d'un compte client.

POST  /customer

<?xml version="1.0" encoding="UTF-8"?>
<account>
     <username>acme_customer</username>
     <password>PA$sw0r6</password>
     <webserviceUser>true</webserviceUser>
     <searchable>false</searchable>
     <billboardMetric>score</billboardMetric>
     <contact>
          <firstName>Jack</firstName>
          <lastName>Brown</lastName>
          <address address1="123 South St" city="Arlington" state="VA" postalCode="22201" country="US"/>
          <email>jack_brown@acme.com</email>
          <jobTitle>Building Administrator Data Exchange User</jobTitle>
          <phone>703-555-2121</phone>
     </contact>
     <organization name="ACME Corporation">
          <primaryBusiness>Other</primaryBusiness>
          <otherBusinessDescription>other</otherBusinessDescription>
          <energyStarPartner>true</energyStarPartner>
          <energyStarPartnerType>Service and Product Providers</energyStarPartnerType>
     </organization>
</account>

Dans l’exemple suivant, un compte est créé. Si le compte appartient à une entité canadienne, un paramètre de préférences courriel (PreferenceCourrielCompteCanadien) est inclus afin d’indiquer si le compte peut recevoir des informations ENERGY STAR de la part de Ressources naturelles Canada (RNCan).

POST  /customer

<?xml version="1.0" encoding="UTF-8"?>
<account>
     <username>acme_customer</username>
     <password>PA$sw0r6</password>
     <webserviceUser>true</webserviceUser>
     <searchable>false</searchable>
     <billboardMetric>score</billboardMetric>
     <contact>
          <firstName>Jack</firstName>
          <lastName>Brown</lastName>
          <address address1="123 South St" city="Edmonton" state="AB" postalCode="T5G 2S7" country="CA"/>
          <email>jack_brown@acme.com</email>
          <jobTitle>Building Administrator Data Exchange User</jobTitle>
          <phone>703-555-2121</phone>
     </contact>
     <organization name="ACME Corporation">
          <primaryBusiness>Other</primaryBusiness>
          <otherBusinessDescription>other</otherBusinessDescription>
          <energyStarPartner>true</energyStarPartner>
          <energyStarPartnerType>Service and Product Providers</energyStarPartnerType>
     </organization>
     <emailPreferenceCanadianAccount>true</emailPreferenceCanadianAccount>
</account>

Exemple de réponse

L'exemple suivant indique que le compte client.a été créé avec succès.

<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok">
     <id>23421</id>
     <links>
          <link httpMethod="GET" link="/customer/23421" linkDescription="This is the GET url for this Customer."/>
     </links>
</response>
ENVIRONNEMENT D'ESSAI