ServiceInsuranceComment Property

Explains why no InsuranceCost was returned in the response.

Syntax

 uspsrates.getServiceInsuranceComment(index, [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 getServiceInsuranceComment([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 setServiceInsuranceComment([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

Explains why no InsuranceCost was returned in the response.

This property is only applicable to USPS.

If the TotalValue was sent in the request (indicating you wish to receive the ServiceInsuranceCost in the response), but no ServiceInsuranceCost was returned, then ServiceInsuranceComment will contain text explaining why no value was returned for ServiceInsuranceCost. It may be one of three reasons:

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

This property is read-only and not available at design time.

Data Type

String