SortCriteria Property

The criteria to be used to sort the results.

Syntax

 fedexaddress.getSortCriteria([callback])
 fedexaddress.setSortCriteria( sortCriteria, [callback])

Possible Values

  0 (scDistance), 
  1 (scLatestExpressDropoffTime), 
  2 (scLatestGroundDropofftime), 
  3 (scLocationType)

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 getSortCriteria([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 setSortCriteria([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

This specifies what criteria will be used to sort the results that are returned from FedEx when FindLocations is called.

Data Type

Integer