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

Créer un compte

Mise à jour le 25 août 2019

Description

Ce service Web crée un compte pour offrir des services Web d'échange de données. Un compte est créé en fonction de l'information fournie dans la demande XML. Il retourne l'identifiant unique au compte nouvellement créé et un lien vers le service Web correspondant pour le récupérer.

Version

22.0

Méthode HTTP

POST

URL de la ressource

/account

En-tête

Nom du champ Valeur Commentaires
Type de contenu application/xml

Autorisation requise

Non

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 nouveau compte.

POST  /account

<?xml version="1.0" encoding="UTF-8"?>
<account>
     <username>acme_dx_user</username>
     <password>PA$sw0r6</password>
     <webserviceUser>true</webserviceUser>
     <searchable>true</searchable>
     <billboardMetric>score</billboardMetric>
     <contact>
          <firstName>John</firstName>
          <lastName>Doe</lastName>
          <address address1="123 Main St" city="Arlington" state="VA" postalCode="22201" country="US"/>
          <email>john_doe@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 nouveau compte est créé. Si le compte appartient à une entité canadienne, un paramètre de préférences courriel (PreferenceCourrielCompteCanadien) peut également être inclus afin d’indiquer si le compte peut recevoir des informations ENERGY STAR de la part de Ressources naturelles Canada (RNCan).

POST  /compte

<?xml version="1.0" encoding="UTF-8"?>
<account>
     <username>acme_dx_user</username>
     <password>PA$sw0r6</password>
     <webserviceUser>true</webserviceUser>
     <searchable>true</searchable>
     <billboardMetric>score</billboardMetric>
     <contact>
          <firstName>John</firstName>
          <lastName>Doe</lastName>
          <address address1="123 Main St" city="Edmonton" state="AB" postalCode="T5G 2S7" country="CA"/>
          <email>john_doe@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 a été réussi avec succès. Il affiche aussi l'identifiant du nouveau compte (68001) et un lien vers le service Web pour récupérer le compte.

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