ServiceTypeDescription Property

Indicates the textual description of a service type in the list of available services returned.

Syntax

 upsrates.getServiceTypeDescription(index, [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 getServiceTypeDescription([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 setServiceTypeDescription([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

Indicates the textual description of a service type in the list of available services returned.

Possible returned values for FedEx are:


Service Type	Service Type Description
10	PRIORITY_OVERNIGHT
11	STANDARD_OVERNIGHT
12	FIRST_OVERNIGHT
13	FEDEX_2_DAY
14	FEDEX_EXPRESS_SAVER
15	FEDEX_GROUND
16	GROUND_HOME_DELIVERY
17	FEDEX_1_DAY_FREIGHT
18	FEDEX_2_DAY_FREIGHT
19	FEDEX_3_DAY_FREIGHT
20	INTERNATIONAL_PRIORITY
21	INTERNATIONAL_ECONOMY
22	INTERNATIONAL_FIRST
23	INTERNATIONAL_PRIORITY_FREIGHT
24	INTERNATIONAL_ECONOMY_FREIGHT
25	EUROPE_FIRST_INTERNATIONAL_PRIORITY
26	FEDEX_SMART_POST
27	FEDEX_2_DAY_AM
28	FEDEX_FIRST_FREIGHT
29	FEDEX_FREIGHT_ECONOMY
30	FEDEX_FREIGHT_PRIORITY
120	FEDEX_DISTANCE_DEFERRED
121	FEDEX_NEXT_DAY_AFTERNOON
122	FEDEX_NEXT_DAY_EARLY_MORNING
123	FEDEX_NEXT_DAY_END_OF_DAY
124	FEDEX_NEXT_DAY_FREIGHT
125	FEDEX_NEXT_DAY_MID_MORNING

The size of the array is controlled by the ServiceCount property.

This property is read-only and not available at design time.

Data Type

String