Shipping Integrator V5 - Online Help
Shipping Integrator V5
Questions / Feedback?

RequestType Property

The type of tracking request.

Syntax

 uspstrack.getRequestType([callback])
 uspstrack.setRequestType( requestType, [callback])

Possible Values

  0 (rtDetail), 
  1 (rtSummary)

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 getRequestType([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 setRequestType([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

By default, the TrackShipment method will return a detailed summary of each time the shipment was scanned during transit in the TrackEvents property. However, when set to rtSummary, a summary of each status that is returned will be populated in the TrackEventStatus property.

Data Type

Integer

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 5.0.6240.0