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

Modifier votre compte

Mise à jour le 24 juin 2019

Description

Ce service Web met à jour votre compte selon les renseignements fournis dans la demande XML. Il renvoie l'identificateur unique au compte mis à jour et un lien au service Web correspondant pour le récupérer. Si l'élément « paramètre du tableau d'affichage » optionnel est inclus, ce réglage effacera tous les paramètres métriques du tableau d'affichage au niveau des propriétés établis précédemment pour toutes les propriétés du compte de l'utilisateur authentifié.

Version

22.0

Méthode HTTP

PUT

URL de la ressource

/account

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 montre la mise à jour de votre information de compte.

PUT  /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>
     <includeTestPropertiesInGraphics>true</includeTestPropertiesInGraphics>
</account>

Dans l’exemple suivant, les renseignements de votre compte sont mis à jour. Si le compte appartient au Canada, un réglage pour la préférence des courriels (emailPreferenceCanadianAccount) peut aussi être inclus, qui indique que le compte peut recevoir des renseignements ENERGY STAR de la part de Ressources naturelles Canada (RNCan).

PUT  /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="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>
     <includeTestPropertiesInGraphics>true</includeTestPropertiesInGraphics>
     <emailPreferenceCanadianAccount>true</emailPreferenceCanadianAccount>
</account>

Exemple de réponse

Dans l’exemple suivant, votre compte a été mis à jour avec succès. L’identifiant unique est retourné à votre compte accompagné d’un lien au service Web correspondant pour le récupérer.

<?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