PackageServiceIndex Property

The service index in the list of available services returned.

Syntax

 upsrates.getPackageServiceIndex([callback])
 upsrates.setPackageServiceIndex( packageServiceIndex, [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 getPackageServiceIndex([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 setPackageServiceIndex([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

To retrieve all rating attributes on package level (PackageBaseCharge, PackageTotalSurcharges, PackageNetCharge, and PackageRatingAggregate) you must set the PackageServiceIndex from 0 to ServiceCount - 1 for each PackageIndex from 0 to PackageCount - 1.

Data Type

Integer