Empower Help

Search:

Display Legacy Contents

IndexBookmarkPrint

Home > Factory Productivity and Scheduling > Advanced Topics > Import Export Data > Empower API > Using The API To Retrieve Data > Customer Details

Customer Details


Customer details can be retrieved through the API using the function call



 GetCustomerDetails(CustomerName As String)


This function takes a single argument of data type String and returns the Customer Data if it exists.

Calling a function with a particular argument will only be allowed once in any 15 minute period.  More frequent calls for that function/argument will result in error number 7623 being returned.


The following data types are used

CustomerData

CustomerName As String
CustomerPhone As String
CustomerEmail As String
CustomerWebsite As String
CustomerStatus As String
CustomerAddressLine1 As String
CustomerAddressLine2 As String
CustomerCity As String
CustomerState As String
CustomerPostalCode As String
CustomerCountry As String
CustomerDlyAddressLine1 As String
CustomerDlyAddressLine2 As String
CustomerDlyCity As String
CustomerDlyState As String
CustomerDlyPostalCode As String
CustomerDlyCountry As String
CustomerNotes As String
CustomerCode as String

As a result the request body should be based on the following

<soapenv:Body>
      <web:GetCustomerDetails>
              <web:CustomerName>CUSTOMER NAME</web:CustomerName>
       </web:GetCustomerDetails>
   </soapenv:Body>


Response XML Format,

    <soap:Body>
      <GetCustomerDetailsResponse xmlns="http://empowersoftware.co.nz/WebService">
         <GetCustomerDetailsResult>
            <CustomerName>CUSTOMER NAME</CustomerName>
            <CustomerPhone>CUSTOMER PHONE</CustomerPhone>
            <CustomerEmail>CUSTOMER EMAIL</CustomerEmail>
            <CustomerWebsite>CUSTOMER WEBSITE</CustomerWebsite>
            <CustomerStatus>CUSTOMER STATUS</CustomerStatus>
            <CustomerAddressLine1>Address Line 1</CustomerAddressLine1>
            <CustomerAddressLine2>Address Line 2</CustomerAddressLine2>
            <CustomerCity>City</CustomerCity>
            <CustomerState>State</CustomerState>
            <CustomerPostalCode>Postal Code</CustomerPostalCode>
            <CustomerCountry>Country</CustomerCountry>
            <CustomerDlyAddressLine1>Delivery Address Line 1</CustomerDlyAddressLine1>
            <CustomerDlyAddressLine2>Delivery Address Line 2</CustomerDlyAddressLine2>
            <CustomerDlyCity>Delivery City</CustomerDlyCity>
            <CustomerDlyState>Delivery Address State</CustomerDlyState>
            <CustomerDlyPostalCode>Delivery Address Postal Code</CustomerDlyPostalCode>
            <CustomerDlyCountry>Delivery Address Country</CustomerDlyCountry>
            <CustomerNotes>Notes</CustomerNotes>
            <CustomerCode>Customer Code</CustomerCode>
         </GetCustomerDetailsResult>
      </GetCustomerDetailsResponse>
   </soap:Body>




 

For more information see
Example Code
WDSL Schema



 

See also
Setting Up Customers  

 



 



See also