ShipmentInfoRole Property

This indicates the role of the party is submitting the transaction for this freight shipment.

Syntax

 fedexfreightrates.getShipmentInfoRole([callback])
 fedexfreightrates.setShipmentInfoRole( shipmentInfoRole, [callback])

Possible Values

  0 (fsrShipper), 
  1 (fsrConsignee)

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 getShipmentInfoRole([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 setShipmentInfoRole([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 indicates the role of the party is submitting the transaction for this freight shipment.

Valid values are as follows:

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

Data Type

Integer