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

Get Customer

Updated on August 27, 2018

Description

This web service retrieves account information for a specific customer that you are connected to.

Version

11.0

HTTP Method

GET

Resource URL

/customer/(customerId)

Header

Field Name Value Comments
Authorization Basic credentials

Authorization Required

Yes

Parameters

Parameter Name Description
customerId Id to the customer

XML Schemas

Request/Response Schema Name
Request None
Response customer.xsd

Example Request

The following example retrieves the account information for the customer with the id of 23421.

GET  /customer/23421

Example Responses

The following example returns the account information for the customer with the id of 23421.

<customer>
    <username>acme_customer</username>
    <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).

<customer>
    <username>acme_customer</username>
    <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>
TEST