Portfolio Manager will be unavailable due to system upgrades beginning Saturday, November 16, 12:00 AM EST through Monday, November 18, 11:59 PM EST.
Web Service Documentation / Categories / Basic Account Services / Get Customer
Updated on February 22, 2021
This web service retrieves account information for a specific customer that you are connected to.
23.0
GET
/customer/(customerId)
Field Name | Value | Comments |
---|---|---|
Authorization | Basic credentials |
Yes
Parameter Name | Description |
---|---|
customerId | Id to the customer |
Request/Response | Schema Name |
---|---|
Request | None |
Response | customer.xsd |
The following example retrieves the account information for the customer with the id of 23421.
GET /customer/23421
The following example returns the account information for the customer with the id of 23421.
<?xml version="1.0" encoding="UTF-8"?>
<customer>
<username>acme_customer</username>
<billboardMetric>score</billboardMetric>
<includeTestPropertiesInGraphics>true</includeTestPropertiesInGraphics>
<accountInfo>
<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>
<organization>ACME Corporation</organization>
<jobTitle>Building Administrator Data Exchange User</jobTitle>
</accountInfo>
</customer>
The following example returns the account information for the customer with the id of 23421. If the customer 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"?>
<customer>
<username>acme_customer</username>
<billboardMetric>score</billboardMetric>
<includeTestPropertiesInGraphics>true</includeTestPropertiesInGraphics>
<accountInfo>
<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>
<organization>ACME Corporation</organization>
<jobTitle>Building Administrator Data Exchange User</jobTitle>
</accountInfo>
<emailPreferenceCanadianAccount>true</emailPreferenceCanadianAccount>
</customer>