PackageInsuredValue Property

Amount of insurance requested for this package.

Syntax

 canadapostshipintl.getPackageInsuredValue(index, [callback])
 canadapostshipintl.setPackageInsuredValue(index,  packageInsuredValue, [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 getPackageInsuredValue([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 setPackageInsuredValue([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

Amount of insurance requested for this package. The value has 2 explicit decimal position and has a maximum of 11 characters including the decimal.

The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

String