SearchCriteria Property

The criteria to be used to find FedEx Locations.

Syntax

 fedexaddress.getSearchCriteria([callback])
 fedexaddress.setSearchCriteria( searchCriteria, [callback])

Possible Values

  0 (sctAddress), 
  1 (sctGeographicCoordinates), 
  2 (sctPhoneNumber)

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 getSearchCriteria([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 setSearchCriteria([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 is to be used to search for FedEx locations when FindLocations is called.

If sctAddress is specified, the Address, must be set. Likewise, if sctGeographicCoordinates is specified, GeographicCoordinates must be set and if sctPhoneNumber is specified PhoneNumber must be set.

Data Type

Integer