ReferenceType Property

The type of the reference number.

Syntax

 upsfreightship.getReferenceType(index, [callback])

Possible Values

  0 (frtBillOfLadingNumber), 
  1 (frtPurchaseOrderNumber), 
  2 (frtOTHER), 
  3 (frtPM), 
  4 (frtPROJ), 
  5 (frtQUOTE), 
  6 (frtSID), 
  7 (frtTASK), 
  8 (frtVPRC)

Default Value

0

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 getReferenceType([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 setReferenceType([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

The type of the reference number. Possible values are:

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

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

Data Type

Integer