CustomerAggregate Property

This property allows you to get or set an XML aggregate built from all of the Customer properties.

Syntax

 icharge.getCustomerAggregate([callback])
 icharge.setCustomerAggregate( customerAggregate, [callback])

Default Value

""

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getCustomerAggregate([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setCustomerAggregate([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This property allows you to get or set an XML aggregate built from all of the Customer properties. "EPCustomer" is the root element. The Customer properties make up the tags under the root, but without the beginning "Customer". For instance:

<EPCustomer>
  <Address>123 Nowhere Ln.</Address>
	<Address2>Apt 3B.</Address2>
	<City>Beverly Hills</City>	
	...	
</EPCustomer>

This property is not available at design time.

Data Type

String