FedExCSPUserKey Property

CSP end user key.

Syntax

 fedexmgr.getFedExCSPUserKey([callback])
 fedexmgr.setFedExCSPUserKey( fedExCSPUserKey, [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 getFedExCSPUserKey([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 setFedExCSPUserKey([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

CSP end user key.

This is applicable to CSP developers only. When registering a CSP user, FedEx provides a unique FedExCSPUserKey and FedExCSPUserPassword that identifies that user.

This end user key and password inherits the services enabled for the CSP credentials and must be passed in all subsequent requests sent to FedEx Web Services as the part of the user authentication along with the provider's (CSP) key and password (FedExDeveloperKey and FedExPassword respectively).

Data Type

String