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

Modifier le client

Mise à jour le 25 août 2019

Description

Mets à jour un compte pour votre client avec lequel vous êtes déjà connecté. Seuls les champs suivants peuvent être mis à jour:
  • includeTestPropertiesInGraphics
  • billboardMetric
  • emailPreferenceCanadianAccount
  • languagePreference
Si l'élément optionnel « paramètre du tableau d'affichage » 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 du client indiqué.

Version

22.0

Méthode HTTP

PUT

URL de la ressource

/customer/(customerId)

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 customer.xsd
Réponse response.xsd

Exemples de demande

L'exemple suivant montre la mise à jour d'un compte client dont l'identifiant correspond à 23421.

PUT  /customer/23421

<?xml version="1.0" encoding="UTF-8"?> <customer> <includeTestPropertiesInGraphics>false</includeTestPropertiesInGraphics> <billboardMetric>score</billboardMetric> </customer>

Dans l’exemple suivant, les informations sont affichées pour le compte du client portant le numéro d’identification 23421.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).

PUT  /customer/23421

<?xml version="1.0" encoding="UTF-8"?> <customer> <includeTestPropertiesInGraphics>false</includeTestPropertiesInGraphics> <billboardMetric>score</billboardMetric> <emailPreferenceCanadianAccount>true</emailPreferenceCanadianAccount> </customer>

Exemple de réponse

Dans l’exemple suivant, le compte du client a été mis à jour 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