Web Service Documentation / Categories / Basic Account Services / Get Account

Get Account

Updated on February 22, 2021

Description

This web service retrieves your account information that includes your username, password, and contact information.

Version

23.0

HTTP Method

GET

Resource URL

/account

Header

Field Name Value Comments
Authorization Basic credentials

Authorization Required

Yes

Parameters

None

XML Schemas

Request/Response Schema Name
Request None
Response account.xsd

Example Request

The following example retrieves your account.

GET  /account

Example Responses

The following example returns your account information.

<?xml version="1.0" encoding="UTF-8"?>
<account>
     <id>68001</id>
     <username>acme_dx_user</username>
     <password>********</password>
     <webserviceUser>true</webserviceUser>
     <searchable>true</searchable>
     <billboardMetric>score</billboardMetric>
     <languagePreference>en_US</languagePreference>
     <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>

The following example returns your account information. If the account belongs to Canada, an email preference setting (emailPreferenceCanadianAccount) is also included which indicates whether the account can receive ENERGY STAR information from the Natural Resources of Canada (NRCAN).

<?xml version="1.0" encoding="UTF-8"?>
<account>
     <id>68001</id>
     <username>acme_dx_user</username>
     <password>********</password>
     <webserviceUser>true</webserviceUser>
     <searchable>true</searchable>
     <billboardMetric>score</billboardMetric>
     <languagePreference>fr_CA</languagePreference>
     <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>
LIVE