FedExAddress Class

Properties   Methods   Events   Config Settings   Errors  

Allows you to validate or complete recipient addresses.

Class Name

DShippingSDK_FedExAddress

Procedural Interface

 dshippingsdk_fedexaddress_open();
 dshippingsdk_fedexaddress_close($res);
 dshippingsdk_fedexaddress_register_callback($res, $id, $function);
 dshippingsdk_fedexaddress_get_last_error($res);
 dshippingsdk_fedexaddress_get_last_error_code($res);
 dshippingsdk_fedexaddress_set($res, $id, $index, $value);
 dshippingsdk_fedexaddress_get($res, $id, $index);
 dshippingsdk_fedexaddress_do_config($res, $configurationstring);
 dshippingsdk_fedexaddress_do_findlocations($res);
 dshippingsdk_fedexaddress_do_reset($res);
 dshippingsdk_fedexaddress_do_validateaddress($res);

Remarks

Via this class you can perform the following:

• Complete incomplete recipient addresses.
• Correct invalid recipient addresses.
• Determine whether an address is business or residential to increase the accuracy of courtesy rate quotes. This applies to U.S. and Canada addresses only.
• Confirm the validity and completeness of addresses in many countries in these regions: U.S., Canada, Latin America, Europe, the Middle East, and Asia Pacific.
• Provide street level matches.
• Find information on the nearest FedEx location(s).

Having correct addresses on the shipping labels will eliminate delivery delays and additional service fees (occurring when a shipment is re-routed).

For address verification, use the ValidateAddress method. This provides street level matches, but it does not currently verify suite or apartment numbers. It checks if the street exists in the city and state/province or postal code entered, and if the street number is within a valid range for the street entered. Upon successful reply, it either provides an exact match or possible alternatives (multiple address results) when an exact match cannot be found based on the input values, or informs you if no possible alternatives can be found.

For U.S. addresses, the following information is the minimum required to check an address:

• Street Address
• City and State/Province or Postal Code

To search for the nearest FedEx location(s), use the FindLocations method. You can search by address, geographic coordinates, or phone number.

To narrow down the search, you can specify the type of locations you are looking for (such as Authorized Ship Center, FedEx Self-Service, FedEx Staffed and/or) and any special service those locations offer (such as Accepts Cash, Saturday service, Packaging supplies, Latest Express drop-off, etc.).

If the request completes successfully, FedEx server will return a set of matches that satisfies the search criteria. You will be able to retrieve FedEx location Ids, addresses, available services they offer, operations hours on weekdays and/or weekends.

The set of locations retrieved is limited to a maximum of ten locations returned within a 50-mile radius.

To use this class, you must have an FedExAuthorizationToken, which is used to authorize your application API requests with FedEx resources.

You can obtain the FedExAuthorizationToken using the OAuth component. You'll need to provide the Client ID and Client Secret, which you can get from FedEx when you create your Project on the FedEx Developer portal.

FedEx allows this service to be used in production environment only after passing the certification. Customers need to be certified first in order to have the Advanced (such as Address Validation) services activated. After the certification is granted, you will receive the production credentials. Once they move to production, Address Validation is a feature that has to be activated upon the customer's request.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

Address1 Property (DShippingSDK_FedExAddress Class)

Street name.

Object Oriented Interface

public function getAddress1();


public function setAddress1($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 1 );


dshippingsdk_fedexaddress_set($res, 1, $value );

Default Value

''

Remarks

Street name. In a ship request, this is required to be provided for both sender and recipient. In all other requests, it is required for a valid physical address. For UPS Address1 should not exceed 35 characters.

Data Type

String

Address2 Property (DShippingSDK_FedExAddress Class)

A specific detail on the address (such as building, suite, apartment, floor number etc.

Object Oriented Interface

public function getAddress2();


public function setAddress2($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 2 );


dshippingsdk_fedexaddress_set($res, 2, $value );

Default Value

''

Remarks

A specific detail on the address (such as building, suite, apartment, floor number etc.). This is optional. For UPS Address2 should not exceed 35 characters.

Data Type

String

AddressFlags Property (DShippingSDK_FedExAddress Class)

Various flags that denote information about the address.

Object Oriented Interface

public function getAddressFlags();


public function setAddressFlags($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 3 );


dshippingsdk_fedexaddress_set($res, 3, $value );

Default Value

0

Remarks

Various flags that denote information about the address.

Data Type

Integer

City Property (DShippingSDK_FedExAddress Class)

Name of city, town, etc.

Object Oriented Interface

public function getCity();


public function setCity($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 4 );


dshippingsdk_fedexaddress_set($res, 4, $value );

Default Value

''

Remarks

Name of city, town, etc. In a ship request, this is required to be provided for both sender and recipient.

Data Type

String

CountryCode Property (DShippingSDK_FedExAddress Class)

Country code.

Object Oriented Interface

public function getCountryCode();


public function setCountryCode($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 5 );


dshippingsdk_fedexaddress_set($res, 5, $value );

Default Value

'US'

Remarks

Country code. This identifies a country. In a ship request, this is required to be provided for both sender and recipient. Maximum length: 2.

Here is a list of country names and their codes. Code is the value that has to be provided in all requests sent where country code is to be entered. Note that with USPS you can also specify the full country name here.

* Not supported by USPS

** Has multiple values, the values used for USPS are below

Data Type

String

State Property (DShippingSDK_FedExAddress Class)

State or province code.

Object Oriented Interface

public function getState();


public function setState($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 6 );


dshippingsdk_fedexaddress_set($res, 6, $value );

Default Value

''

Remarks

State or province code. This is the identifying abbreviation for US state, Canada province, etc. In a ship request, this is required to be provided for both sender and recipient (where applicable). Format and presence of this field will vary, depending on country.

Data Type

String

ZipCode Property (DShippingSDK_FedExAddress Class)

Postal code.

Object Oriented Interface

public function getZipCode();


public function setZipCode($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 7 );


dshippingsdk_fedexaddress_set($res, 7, $value );

Default Value

''

Remarks

Postal code. This is identification of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country.

In a ship request, this is required to be provided for both sender and recipient. In all other requests, this element is required if both City and State are not present.

Valid characters: A-Z; 0-9; a-z. Maximum length: 16.

Data Type

String

Company Property (DShippingSDK_FedExAddress Class)

Name of the company that resides at the address to be validated.

Object Oriented Interface

public function getCompany();


public function setCompany($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 8 );


dshippingsdk_fedexaddress_set($res, 8, $value );

Default Value

''

Remarks

To narrow down the search for address candidates, you can include the Company in the address validation request (when the ValidateAddress is called). Providing a company name may improve your results since some addresses have specific company names assigned to them.

Data Type

String

ConstraintFilters Property (DShippingSDK_FedExAddress Class)

The following flags are defined (specified in hexadecimal notation).

Object Oriented Interface

public function getConstraintFilters();


public function setConstraintFilters($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 10 );


dshippingsdk_fedexaddress_set($res, 10, $value );

Default Value

0

Remarks

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to include multiple filters:

Data Type

Integer

ConstraintLocationAttributes Property (DShippingSDK_FedExAddress Class)

This indicates the services you would like to search for at a particular location.

Object Oriented Interface

public function getConstraintLocationAttributes();


public function setConstraintLocationAttributes($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 11 );


dshippingsdk_fedexaddress_set($res, 11, $value );

Default Value

0

Remarks

This indicates the services you would like to search for at a particular location.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to include multiple attributes:

Data Type

Integer

ConstraintLocationContentOptions Property (DShippingSDK_FedExAddress Class)

This sets what content you would like to have returned with the location data.

Object Oriented Interface

public function getConstraintLocationContentOptions();


public function setConstraintLocationContentOptions($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 12 );


dshippingsdk_fedexaddress_set($res, 12, $value );

Default Value

0

Remarks

This sets what content you would like to have returned with the location data.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to include multiple attributes:

Data Type

Integer

ConstraintLocationTypeFlags Property (DShippingSDK_FedExAddress Class)

This indicates the type(s) of FedEx location you would like to search for.

Object Oriented Interface

public function getConstraintLocationTypeFlags();


public function setConstraintLocationTypeFlags($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 13 );


dshippingsdk_fedexaddress_set($res, 13, $value );

Default Value

0

Remarks

This indicates the type(s) of FedEx location you would like to search for.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to include multiple location types:

Data Type

Integer

ConstraintRedirectToHoldType Property (DShippingSDK_FedExAddress Class)

Specify the type of service supported by a FedEx location for redirect to hold.

Object Oriented Interface

public function getConstraintRedirectToHoldType();


public function setConstraintRedirectToHoldType($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 14 );


dshippingsdk_fedexaddress_set($res, 14, $value );

Default Value

0

Remarks

Specify the type of service supported by a FedEx location for redirect to hold.

Possible values are:

Data Type

Integer

ConstraintResultsRequested Property (DShippingSDK_FedExAddress Class)

The number of results requested.

Object Oriented Interface

public function getConstraintResultsRequested();


public function setConstraintResultsRequested($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 15 );


dshippingsdk_fedexaddress_set($res, 15, $value );

Default Value

1

Remarks

The number of results requested.

Data Type

Integer

ConstraintResultsToSkip Property (DShippingSDK_FedExAddress Class)

The number of results to skip.

Object Oriented Interface

public function getConstraintResultsToSkip();


public function setConstraintResultsToSkip($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 16 );


dshippingsdk_fedexaddress_set($res, 16, $value );

Default Value

0

Remarks

The number of results to skip.

Data Type

Integer

ConstraintSearchRadius Property (DShippingSDK_FedExAddress Class)

This contains the search radius to be used when FindLocations is called.

Object Oriented Interface

public function getConstraintSearchRadius();


public function setConstraintSearchRadius($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 17 );


dshippingsdk_fedexaddress_set($res, 17, $value );

Default Value

''

Remarks

This contains the search radius to be used when FindLocations is called.

Data Type

String

FedExAccountNumber Property (DShippingSDK_FedExAddress Class)

The account number associated with the shipment.

Object Oriented Interface

public function getFedExAccountNumber();


public function setFedExAccountNumber($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 18 );


dshippingsdk_fedexaddress_set($res, 18, $value );

Default Value

''

Remarks

The account number associated with the shipment.

The FedExAccountNumber is not to be shared with others outside your organization, nor is it to be packaged, distributed, or sold to any other person or entity.

Data Type

String

FedExAuthorizationToken Property (DShippingSDK_FedExAddress Class)

Authorization Token used to authenticate the request.

Object Oriented Interface

public function getFedExAuthorizationToken();


public function setFedExAuthorizationToken($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 19 );


dshippingsdk_fedexaddress_set($res, 19, $value );

Default Value

''

Remarks

Authorization Token used to authenticate the request.

This field should be set to the value of a bearer token obtained through OAuth 2.0. For more information on getting a bearer token, see the documentation for the OAuth component.

Data Type

String

FedExLanguageCode Property (DShippingSDK_FedExAddress Class)

Two-letter code for the language (e.

Object Oriented Interface

public function getFedExLanguageCode();


public function setFedExLanguageCode($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 20 );


dshippingsdk_fedexaddress_set($res, 20, $value );

Default Value

'en'

Remarks

Two-letter code for the language (e.g. en, fr, etc.).

This field allows you to assign the language code. Default value is en.

Data Type

String

FedExLocaleCode Property (DShippingSDK_FedExAddress Class)

Two-letter code for the region (e.

Object Oriented Interface

public function getFedExLocaleCode();


public function setFedExLocaleCode($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 21 );


dshippingsdk_fedexaddress_set($res, 21, $value );

Default Value

'US'

Remarks

Two-letter code for the region (e.g. US, CA, etc.).

Some languages require a locale code to further identify the language. Default value is US.

Data Type

String

FedExServer Property (DShippingSDK_FedExAddress Class)

URL for the FedEx Server where the requests are sent.

Object Oriented Interface

public function getFedExServer();


public function setFedExServer($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 22 );


dshippingsdk_fedexaddress_set($res, 22, $value );

Default Value

''

Remarks

URL for the FedEx Server where the requests are sent. This will overwrite the internal values that the component uses.

Normally, you do not need to set this property. By default, the component will send the request to the preset production end-point. In order to send request to the test environment, you must set the TESTMODE config to true like: component.Config("TESTMODE=true").

Data Type

String

FirewallAutoDetect Property (DShippingSDK_FedExAddress Class)

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Object Oriented Interface

public function getFirewallAutoDetect();


public function setFirewallAutoDetect($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 23 );


dshippingsdk_fedexaddress_set($res, 23, $value );

Default Value

false

Remarks

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (DShippingSDK_FedExAddress Class)

This property determines the type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();


public function setFirewallType($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 24 );


dshippingsdk_fedexaddress_set($res, 24, $value );

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (DShippingSDK_FedExAddress Class)

This property contains the name or IP address of firewall (optional).

Object Oriented Interface

public function getFirewallHost();


public function setFirewallHost($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 25 );


dshippingsdk_fedexaddress_set($res, 25, $value );

Default Value

''

Remarks

This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

Data Type

String

FirewallPassword Property (DShippingSDK_FedExAddress Class)

This property contains a password if authentication is to be used when connecting through the firewall.

Object Oriented Interface

public function getFirewallPassword();


public function setFirewallPassword($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 26 );


dshippingsdk_fedexaddress_set($res, 26, $value );

Default Value

''

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirewallPort Property (DShippingSDK_FedExAddress Class)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Object Oriented Interface

public function getFirewallPort();


public function setFirewallPort($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 27 );


dshippingsdk_fedexaddress_set($res, 27, $value );

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (DShippingSDK_FedExAddress Class)

This property contains a user name if authentication is to be used connecting through a firewall.

Object Oriented Interface

public function getFirewallUser();


public function setFirewallUser($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 28 );


dshippingsdk_fedexaddress_set($res, 28, $value );

Default Value

''

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

GeographicCoordinates Property (DShippingSDK_FedExAddress Class)

Specifies the geographic coordinates by which nearby FedEx locations are to be found.

Object Oriented Interface

public function getGeographicCoordinates();


public function setGeographicCoordinates($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 29 );


dshippingsdk_fedexaddress_set($res, 29, $value );

Default Value

''

Remarks

This property is optional, unless SearchCriteria is set to sctGeographicCoordinates.

The latitude and longitude should be specified in decimal format and separated by a comma. For example 35.912366,-78.939459

Data Type

String

LocationCount Property (DShippingSDK_FedExAddress Class)

The number of records in the Location arrays.

Object Oriented Interface

public function getLocationCount();


public function setLocationCount($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 30 );


dshippingsdk_fedexaddress_set($res, 30, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• LocationAcceptedCurrency
• LocationAttributes
• LocationCarrierCount
• LocationCarrierIndex
• LocationCarrierLatestDropoffCount
• LocationCarrierLatestDropoffDayOfWeek
• LocationCarrierLatestDropoffIndex
• LocationCarrierLatestDropoffOperationTime
• LocationCarrierType
• LocationCity
• LocationCompanyName
• LocationCountryCode
• LocationDistance
• LocationEmail
• LocationEntityId
• LocationFax
• LocationGeographicCoordinates
• LocationHolidayCount
• LocationHolidayDate
• LocationHolidayIndex
• LocationHolidayName
• LocationId
• LocationMapURL
• LocationPersonName
• LocationPhone
• LocationSpecialInstructions
• LocationState
• LocationStoreHoursCount
• LocationStoreHoursDayOfWeek
• LocationStoreHoursExceptionalHours
• LocationStoreHoursExceptionalHoursType
• LocationStoreHoursIndex
• LocationStoreHoursOperationalHours
• LocationStoreHoursOperationalHoursType
• LocationStoreNumber
• LocationStreetAddress
• LocationType
• LocationZipCode

The array indices start at 0 and end at LocationCount - 1.

This property is not available at design time.

Data Type

Integer

LocationAcceptedCurrency Property (DShippingSDK_FedExAddress Class)

The currency that is accepted at this FedEx location.

Object Oriented Interface

public function getLocationAcceptedCurrency($locationindex);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 31 , $locationindex);

Default Value

''

Remarks

The currency that is accepted at this FedEx location. This is populated when FindLocations is called.

The $locationindex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

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

Data Type

String

LocationAttributes Property (DShippingSDK_FedExAddress Class)

This specifies what type of services this FedEx location provides.

Object Oriented Interface

public function getLocationAttributes($locationindex);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 32 , $locationindex);

Default Value

0

Remarks

This specifies what type of services this FedEx location provides. This is populated when FindLocations is called.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to include multiple attributes:

The $locationindex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

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

Data Type

Integer

LocationCarrierCount Property (DShippingSDK_FedExAddress Class)

This contains the number of Carriers returned for the current location.

Object Oriented Interface

public function getLocationCarrierCount($locationindex);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 33 , $locationindex);

Default Value

0

Remarks

This contains the number of Carriers returned for the current location. This is populated after a call to FindLocations.

The $locationindex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

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

Data Type

Integer

LocationCarrierIndex Property (DShippingSDK_FedExAddress Class)

This contains the current index for the array of carriers that were returned for the current location.

Object Oriented Interface

public function getLocationCarrierIndex($locationindex);


public function setLocationCarrierIndex($locationindex, $value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 34 , $locationindex);


dshippingsdk_fedexaddress_set($res, 34, $value , $locationindex);

Default Value

0

Remarks

This contains the current index for the array of carriers that were returned for the current location.

The $locationindex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

This property is not available at design time.

Data Type

Integer

LocationCarrierLatestDropoffCount Property (DShippingSDK_FedExAddress Class)

This contains the total number of normal latest dropoff times that were returned for the carrier specified by CarrierIndex .

Object Oriented Interface

public function getLocationCarrierLatestDropoffCount($locationindex);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 35 , $locationindex);

Default Value

0

Remarks

This contains the total number of normal latest dropoff times that were returned for the carrier specified by LocationCarrierIndex.

The $locationindex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

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

Data Type

Integer

LocationCarrierLatestDropoffDayOfWeek Property (DShippingSDK_FedExAddress Class)

This contains the day of the week for the current normal latest dropoff.

Object Oriented Interface

public function getLocationCarrierLatestDropoffDayOfWeek($locationindex);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 36 , $locationindex);

Default Value

''

Remarks

This contains the day of the week for the current normal latest dropoff. This is populated when LocationCarrierLatestDropoffIndex is set.

The $locationindex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

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

Data Type

String

LocationCarrierLatestDropoffIndex Property (DShippingSDK_FedExAddress Class)

This specifies the index for the normal latest dropoff time for the carrier specified by CarrierIndex .

Object Oriented Interface

public function getLocationCarrierLatestDropoffIndex($locationindex);


public function setLocationCarrierLatestDropoffIndex($locationindex, $value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 37 , $locationindex);


dshippingsdk_fedexaddress_set($res, 37, $value , $locationindex);

Default Value

0

Remarks

This specifies the index for the normal latest dropoff time for the carrier specified by LocationCarrierIndex. When LocationCarrierIndex is set, this gets set to 0.

The $locationindex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

This property is not available at design time.

Data Type

Integer

LocationCarrierLatestDropoffOperationTime Property (DShippingSDK_FedExAddress Class)

This contains the current carrier's normal dropoff time for the specified day.

Object Oriented Interface

public function getLocationCarrierLatestDropoffOperationTime($locationindex);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 38 , $locationindex);

Default Value

''

Remarks

This contains the current carrier's normal dropoff time for the specified day. This is populated when LocationCarrierLatestDropoffIndex is set.

The $locationindex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

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

Data Type

String

LocationCarrierType Property (DShippingSDK_FedExAddress Class)

This contains the type of carrier the current carrier is.

Object Oriented Interface

public function getLocationCarrierType($locationindex);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 39 , $locationindex);

Default Value

0

Remarks

This contains the type of carrier the current carrier is. This is populated when LocationCarrierIndex is set.

The possible values are as follows:

The $locationindex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

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

Data Type

Integer

LocationCity Property (DShippingSDK_FedExAddress Class)

Name of the city that the current location is in.

Object Oriented Interface

public function getLocationCity($locationindex);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 40 , $locationindex);

Default Value

''

Remarks

Name of the city that the current location is in.

The $locationindex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

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

Data Type

String

LocationCompanyName Property (DShippingSDK_FedExAddress Class)

The name of the business at this FedEx location.

Object Oriented Interface

public function getLocationCompanyName($locationindex);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 41 , $locationindex);

Default Value

''

Remarks

The name of the business at this FedEx location. This is populated when FindLocations is called.

The $locationindex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

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

Data Type

String

LocationCountryCode Property (DShippingSDK_FedExAddress Class)

This contains the country code for the current location.

Object Oriented Interface

public function getLocationCountryCode($locationindex);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 42 , $locationindex);

Default Value

''

Remarks

This contains the country code for the current location. This is populated when FindLocations is called.

The $locationindex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

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

Data Type

String

LocationDistance Property (DShippingSDK_FedExAddress Class)

Specifies the distance between the FedEx locations and the address specified.

Object Oriented Interface

public function getLocationDistance($locationindex);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 43 , $locationindex);

Default Value

''

Remarks

Specifies the distance between the FedEx locations and the address specified. For example: 1.7 MI. This is populated when FindLocations is called.

The $locationindex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

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

Data Type

String

LocationEmail Property (DShippingSDK_FedExAddress Class)

The email address provided for the current location.

Object Oriented Interface

public function getLocationEmail($locationindex);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 44 , $locationindex);

Default Value

''

Remarks

The email address provided for the current location. This is populated when FindLocations is called.

The $locationindex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

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

Data Type

String

LocationEntityId Property (DShippingSDK_FedExAddress Class)

The entity ID for the current location.

Object Oriented Interface

public function getLocationEntityId($locationindex);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 45 , $locationindex);

Default Value

''

Remarks

The entity ID for the current location. This is populated when FindLocations is called.

The $locationindex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

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

Data Type

String

LocationFax Property (DShippingSDK_FedExAddress Class)

This contains the fax number for the current location.

Object Oriented Interface

public function getLocationFax($locationindex);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 46 , $locationindex);

Default Value

''

Remarks

This contains the fax number for the current location. This is populated when FindLocations is called.

The $locationindex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

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

Data Type

String

LocationGeographicCoordinates Property (DShippingSDK_FedExAddress Class)

This contains the geographic coordinates of the current location.

Object Oriented Interface

public function getLocationGeographicCoordinates($locationindex);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 47 , $locationindex);

Default Value

''

Remarks

This contains the geographic coordinates of the current location. This is populated when FindLocations is called.

The latitude and longitude will be specified in decimal format and separated by a comma. For example 35.912366,-78.939459

The $locationindex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

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

Data Type

String

LocationHolidayCount Property (DShippingSDK_FedExAddress Class)

This contains the number of holidays that the current FedEx location observes.

Object Oriented Interface

public function getLocationHolidayCount($locationindex);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 48 , $locationindex);

Default Value

0

Remarks

This contains the number of holidays that the current FedEx location observes.

The $locationindex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

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

Data Type

Integer

LocationHolidayDate Property (DShippingSDK_FedExAddress Class)

This is the date of the holiday specified by HolidayIndex .

Object Oriented Interface

public function getLocationHolidayDate($locationindex);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 49 , $locationindex);

Default Value

''

Remarks

This is the date of the holiday specified by LocationHolidayIndex.

The $locationindex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

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

Data Type

String

LocationHolidayIndex Property (DShippingSDK_FedExAddress Class)

This contains the index of the current holiday the FedEx location observes.

Object Oriented Interface

public function getLocationHolidayIndex($locationindex);


public function setLocationHolidayIndex($locationindex, $value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 50 , $locationindex);


dshippingsdk_fedexaddress_set($res, 50, $value , $locationindex);

Default Value

0

Remarks

This contains the index of the current holiday the FedEx location observes.

The $locationindex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

This property is not available at design time.

Data Type

Integer

LocationHolidayName Property (DShippingSDK_FedExAddress Class)

This contains the name of the holiday specified by HolidayIndex .

Object Oriented Interface

public function getLocationHolidayName($locationindex);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 51 , $locationindex);

Default Value

''

Remarks

This contains the name of the holiday specified by LocationHolidayIndex.

The $locationindex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

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

Data Type

String

LocationId Property (DShippingSDK_FedExAddress Class)

Business identifier that can be used by IRV attendant to look directions to this FedEx location.

Object Oriented Interface

public function getLocationId($locationindex);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 52 , $locationindex);

Default Value

''

Remarks

Business identifier that can be used by IRV attendant to look directions to this FedEx location. This is populated when FindLocations is called.

The $locationindex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

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

Data Type

String

LocationMapURL Property (DShippingSDK_FedExAddress Class)

This contains the URL to the google map showing the location.

Object Oriented Interface

public function getLocationMapURL($locationindex);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 53 , $locationindex);

Default Value

''

Remarks

This contains the URL to the google map showing the location.

The $locationindex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

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

Data Type

String

LocationPersonName Property (DShippingSDK_FedExAddress Class)

The name of the person listed as the contact for the current location.

Object Oriented Interface

public function getLocationPersonName($locationindex);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 54 , $locationindex);

Default Value

''

Remarks

The name of the person listed as the contact for the current location. This is populated after a call to FindLocations.

The $locationindex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

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

Data Type

String

LocationPhone Property (DShippingSDK_FedExAddress Class)

The phone number for the current location.

Object Oriented Interface

public function getLocationPhone($locationindex);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 55 , $locationindex);

Default Value

''

Remarks

The phone number for the current location. This is populated after a call to FindLocations.

The $locationindex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

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

Data Type

String

LocationSpecialInstructions Property (DShippingSDK_FedExAddress Class)

This contains any special instructions provided for the current location.

Object Oriented Interface

public function getLocationSpecialInstructions($locationindex);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 56 , $locationindex);

Default Value

''

Remarks

This contains any special instructions provided for the current location. This is populated after a call to FindLocations.

The $locationindex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

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

Data Type

String

LocationState Property (DShippingSDK_FedExAddress Class)

State or province code of the current location.

Object Oriented Interface

public function getLocationState($locationindex);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 57 , $locationindex);

Default Value

''

Remarks

State or province code of the current location. This is populated after a call to FindLocations.

The $locationindex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

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

Data Type

String

LocationStoreHoursCount Property (DShippingSDK_FedExAddress Class)

This contains the number of store hours that were returned for the current location.

Object Oriented Interface

public function getLocationStoreHoursCount($locationindex);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 58 , $locationindex);

Default Value

0

Remarks

This contains the number of store hours that were returned for the current location. This is populated after a call to FindLocations.

The $locationindex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

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

Data Type

Integer

LocationStoreHoursDayOfWeek Property (DShippingSDK_FedExAddress Class)

This contains the day of the week for which the store hours are being specified.

Object Oriented Interface

public function getLocationStoreHoursDayOfWeek($locationindex);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 59 , $locationindex);

Default Value

''

Remarks

This contains the day of the week for which the store hours are being specified. This is populated when LocationStoreHoursIndex is set.

The $locationindex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

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

Data Type

String

LocationStoreHoursExceptionalHours Property (DShippingSDK_FedExAddress Class)

This contains the list of operating hours for the location that are an exception from the normal hours of operation.

Object Oriented Interface

public function getLocationStoreHoursExceptionalHours($locationindex);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 60 , $locationindex);

Default Value

''

Remarks

This contains the list of operating hours for the location that are an exception from the normal hours of operation. This is populated when LocationStoreHoursIndex is set.

The format will be a 24 hour time format "HH:mm-HH:mm". For instance "09:00-16:00". If the location closes during the middle of the day so that it opens and closes twice in one day the sets will be separated by a comma. For instance "09:00-16:00,19:00-23:00" means the location is open from 9 a.m. to 4 p.m. and open again from 7 p.m. to 11 p.m.

The $locationindex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

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

Data Type

String

LocationStoreHoursExceptionalHoursType Property (DShippingSDK_FedExAddress Class)

Indicates the type of exceptional hours.

Object Oriented Interface

public function getLocationStoreHoursExceptionalHoursType($locationindex);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 61 , $locationindex);

Default Value

''

Remarks

Indicates the type of exceptional hours. Possible returned values are: "CLOSED_ALL_DAY", "OPEN_ALL_DAY", "OPEN_BY_HOURS". This is populated when LocationStoreHoursIndex is set.

The $locationindex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

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

Data Type

String

LocationStoreHoursIndex Property (DShippingSDK_FedExAddress Class)

This specifies the current index for the array containing the current location's store hours.

Object Oriented Interface

public function getLocationStoreHoursIndex($locationindex);


public function setLocationStoreHoursIndex($locationindex, $value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 62 , $locationindex);


dshippingsdk_fedexaddress_set($res, 62, $value , $locationindex);

Default Value

0

Remarks

This specifies the current index for the array containing the current location's store hours.

The $locationindex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

This property is not available at design time.

Data Type

Integer

LocationStoreHoursOperationalHours Property (DShippingSDK_FedExAddress Class)

This contains the list of normal operating hours for the location.

Object Oriented Interface

public function getLocationStoreHoursOperationalHours($locationindex);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 63 , $locationindex);

Default Value

''

Remarks

This contains the list of normal operating hours for the location. This is populated when LocationStoreHoursIndex is set.

The format will be a 24 hour time format "HH:mm-HH:mm". For instance "09:00-16:00". If the location closes during the middle of the day so that it opens and closes twice in one day the sets will be separated by a comma. For instance "09:00-16:00,19:00-23:00" means the location is open from 9 a.m. to 4 p.m. and open again from 7 p.m. to 11 p.m.

The $locationindex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

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

Data Type

String

LocationStoreHoursOperationalHoursType Property (DShippingSDK_FedExAddress Class)

Indicates the type of operational hours.

Object Oriented Interface

public function getLocationStoreHoursOperationalHoursType($locationindex);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 64 , $locationindex);

Default Value

''

Remarks

Indicates the type of operational hours. Possible returned values are: "CLOSED_ALL_DAY", "OPEN_ALL_DAY", "OPEN_BY_HOURS". This is populated when LocationStoreHoursIndex is set.

The $locationindex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

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

Data Type

String

LocationStoreNumber Property (DShippingSDK_FedExAddress Class)

The store number for the current location.

Object Oriented Interface

public function getLocationStoreNumber($locationindex);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 65 , $locationindex);

Default Value

0

Remarks

The store number for the current location. This is populated after a call to FindLocations.

The $locationindex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

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

Data Type

Integer

LocationStreetAddress Property (DShippingSDK_FedExAddress Class)

Street address or intersection of this FedEx location.

Object Oriented Interface

public function getLocationStreetAddress($locationindex);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 66 , $locationindex);

Default Value

''

Remarks

Street address or intersection of this FedEx location. This is populated after a call to FindLocations.

The $locationindex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

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

Data Type

String

LocationType Property (DShippingSDK_FedExAddress Class)

The type of this FedEx location.

Object Oriented Interface

public function getLocationType($locationindex);


public function setLocationType($locationindex, $value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 67 , $locationindex);


dshippingsdk_fedexaddress_set($res, 67, $value , $locationindex);

Default Value

0

Remarks

The type of this FedEx location. This is populated after a call to FindLocations.

Possible values are as follows:

The $locationindex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

This property is not available at design time.

Data Type

Integer

LocationZipCode Property (DShippingSDK_FedExAddress Class)

The postal code for the current location.

Object Oriented Interface

public function getLocationZipCode($locationindex);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 68 , $locationindex);

Default Value

''

Remarks

The postal code for the current location. This is populated after a call to FindLocations.

The $locationindex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

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

Data Type

String

MatchCount Property (DShippingSDK_FedExAddress Class)

The number of records in the Match arrays.

Object Oriented Interface

public function getMatchCount();

Procedural Interface

dshippingsdk_fedexaddress_get($res, 69 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• MatchAddress1
• MatchAddress2
• MatchChangeType
• MatchCity
• MatchCompany
• MatchCountryCode
• MatchCustomerMessage
• MatchQuality
• MatchResidentialStatus
• MatchState
• MatchZipCode

The array indices start at 0 and end at MatchCount - 1.

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

Data Type

Integer

MatchAddress1 Property (DShippingSDK_FedExAddress Class)

Address line 1 of an address candidate in the list of matches (if any).

Object Oriented Interface

public function getMatchAddress1($matchidx);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 70 , $matchidx);

Default Value

''

Remarks

Address line 1 of an address candidate in the list of matches (if any).

This may be returned in the server response when the ValidateAddress method is called and if the connection to the server is successful (no errors returned).

The $matchidx parameter specifies the index of the item in the array. The size of the array is controlled by the MatchCount property.

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

Data Type

String

MatchAddress2 Property (DShippingSDK_FedExAddress Class)

Address line 2 of an address candidate in the list of matches (if any).

Object Oriented Interface

public function getMatchAddress2($matchidx);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 71 , $matchidx);

Default Value

''

Remarks

Address line 2 of an address candidate in the list of matches (if any).

This may be returned in the server response when the ValidateAddress method is called and if the connection to the server is successful (no errors returned).

The $matchidx parameter specifies the index of the item in the array. The size of the array is controlled by the MatchCount property.

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

Data Type

String

MatchChangeType Property (DShippingSDK_FedExAddress Class)

Changes made to the Address (during validation process) compared to this address candidate.

Object Oriented Interface

public function getMatchChangeType($matchidx);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 72 , $matchidx);

Default Value

''

Remarks

Changes made to the Address (during validation process) compared to this address candidate. This is a comma-separated string collection. Possible returned values are

• APARTMENT_NUMBER_NOT_FOUND
• APARTMENT_NUMBER_REQUIRED
• NORMALIZED
• REMOVED_DATA
• BOX_NUMBER_REQUIRED
• NO_CHANGES
• MODIFIED_TO_ACHIEVE_MATCH
• STREET_RANGE_MATCH
• BOX_NUMBER_MATCH
• RR_OR_HC_MATCH
• CITY_MATCH
• POSTAL_CODE_MATCH
• RR_OR_HC_BOX_NUMBER_NEEDED
• FORMATTED_FOR_COUNTRY
• APO_OR_FPO_MATCH
• GENERAL_DELIVERY_MATCH
• FIELD_TRUNCATED
• UNABLE_TO_APPEND_NON_ADDRESS_DATA
• INSUFFICIENT_DATA
• HOUSE_OR_BOX_NUMBER_NOT_FOUND
• POSTAL_CODE_NOT_FOUND
• INVALID_COUNTRY
• SERVICE_UNAVAILABLE_FOR_ADDRESS

This is only valid for FedEx.

This may be returned in the server response when the ValidateAddress method is called and if the connection to the server is successful (no errors returned).

The $matchidx parameter specifies the index of the item in the array. The size of the array is controlled by the MatchCount property.

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

Data Type

String

MatchCity Property (DShippingSDK_FedExAddress Class)

City name of an address candidate in the list of matches (if any).

Object Oriented Interface

public function getMatchCity($matchidx);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 73 , $matchidx);

Default Value

''

Remarks

City name of an address candidate in the list of matches (if any).

This may be returned in the server response when the ValidateAddress method is called and if the connection to the server is successful (no errors returned).

The $matchidx parameter specifies the index of the item in the array. The size of the array is controlled by the MatchCount property.

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

Data Type

String

MatchCompany Property (DShippingSDK_FedExAddress Class)

Name of the company that resides at an address candidate in the list of matches (if any).

Object Oriented Interface

public function getMatchCompany($matchidx);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 74 , $matchidx);

Default Value

''

Remarks

Name of the company that resides at an address candidate in the list of matches (if any).

This may be returned in the server response when the ValidateAddress method is called and if the connection to the server is successful (no errors returned).

The $matchidx parameter specifies the index of the item in the array. The size of the array is controlled by the MatchCount property.

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

Data Type

String

MatchCountryCode Property (DShippingSDK_FedExAddress Class)

Country code of an address candidate in the list of matches (if any).

Object Oriented Interface

public function getMatchCountryCode($matchidx);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 75 , $matchidx);

Default Value

''

Remarks

Country code of an address candidate in the list of matches (if any).

This may be returned in the server response when the ValidateAddress method is called and if the connection to the server is successful (no errors returned).

The $matchidx parameter specifies the index of the item in the array. The size of the array is controlled by the MatchCount property.

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

Data Type

String

MatchCustomerMessage Property (DShippingSDK_FedExAddress Class)

Messages pertaining to the resolved address indicating if any additional information is required.

Object Oriented Interface

public function getMatchCustomerMessage($matchidx);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 76 , $matchidx);

Default Value

''

Remarks

Messages pertaining to the resolved address indicating if any additional information is required. This is a comma-separated string collection. Possible returned values are

This is only valid for FedEx.

This may be returned in the server response when the ValidateAddress method is called and if the connection to the server is successful (no errors returned).

The $matchidx parameter specifies the index of the item in the array. The size of the array is controlled by the MatchCount property.

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

Data Type

String

MatchQuality Property (DShippingSDK_FedExAddress Class)

Quality factor an address candidate in the list of matches (if any).

Object Oriented Interface

public function getMatchQuality($matchidx);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 77 , $matchidx);

Default Value

''

Remarks

Quality factor an address candidate in the list of matches (if any).

Each address is returned with an assigned quality value that indicates how closely the address candidate matches the search criteria. This is used to rate the submitted address. If the MatchQuality is too low, the class returns the "Address Not Validated" message.

In FedEx, possible values range from 0 to 100, with 100 being the highest and zero indicating failure.

In UPS, this is applicable for a non street-level address validation and/or classification (i.e., when the Address1 is not set in the request). Possible values are:

This may be returned in the server response when the ValidateAddress method is called and if the connection to the server is successful (no errors returned).

The $matchidx parameter specifies the index of the item in the array. The size of the array is controlled by the MatchCount property.

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

Data Type

String

MatchResidentialStatus Property (DShippingSDK_FedExAddress Class)

Residential status of an address candidate in the list of matches (if any).

Object Oriented Interface

public function getMatchResidentialStatus($matchidx);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 78 , $matchidx);

Default Value

''

Remarks

Residential status of an address candidate in the list of matches (if any). Possible returned values are:

• MIXED
• UNKNOWN
• BUSINESS
• RESIDENTIAL

This may be returned in the server response when the ValidateAddress method is called and if the connection to the server is successful (no errors returned).

The $matchidx parameter specifies the index of the item in the array. The size of the array is controlled by the MatchCount property.

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

Data Type

String

MatchState Property (DShippingSDK_FedExAddress Class)

State or province code of an address candidate in the list of matches (if any).

Object Oriented Interface

public function getMatchState($matchidx);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 79 , $matchidx);

Default Value

''

Remarks

State or province code of an address candidate in the list of matches (if any).

This may be returned in the server response when the ValidateAddress method is called and if the connection to the server is successful (no errors returned).

The $matchidx parameter specifies the index of the item in the array. The size of the array is controlled by the MatchCount property.

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

Data Type

String

MatchZipCode Property (DShippingSDK_FedExAddress Class)

Postal Code of an address candidate in the list of matches (if any).

Object Oriented Interface

public function getMatchZipCode($matchidx);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 80 , $matchidx);

Default Value

''

Remarks

Postal Code of an address candidate in the list of matches (if any).

This may be returned in the server response when the ValidateAddress method is called and if the connection to the server is successful (no errors returned).

The $matchidx parameter specifies the index of the item in the array. The size of the array is controlled by the MatchCount property.

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

Data Type

String

MaxResults Property (DShippingSDK_FedExAddress Class)

The maximum number of results to be returned.

Object Oriented Interface

public function getMaxResults();


public function setMaxResults($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 81 );


dshippingsdk_fedexaddress_set($res, 81, $value );

Default Value

10

Remarks

This specifies the maximum number of results to be returned. The default value is 10.

The maximum value for this property is 50.

Data Type

Integer

Phone Property (DShippingSDK_FedExAddress Class)

Phone number for which nearby FedEx locations are to be found.

Object Oriented Interface

public function getPhone();


public function setPhone($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 82 );


dshippingsdk_fedexaddress_set($res, 82, $value );

Default Value

''

Remarks

This property is optional, unless SearchCriteria is set to sctPhoneNumber.

Data Type

String

ProxyAuthScheme Property (DShippingSDK_FedExAddress Class)

This property is used to tell the class which type of authorization to perform when connecting to the proxy.

Object Oriented Interface

public function getProxyAuthScheme();


public function setProxyAuthScheme($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 83 );


dshippingsdk_fedexaddress_set($res, 83, $value );

Default Value

0

Remarks

This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (DShippingSDK_FedExAddress Class)

This property tells the class whether or not to automatically detect and use proxy system settings, if available.

Object Oriented Interface

public function getProxyAutoDetect();


public function setProxyAutoDetect($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 84 );


dshippingsdk_fedexaddress_set($res, 84, $value );

Default Value

false

Remarks

This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (DShippingSDK_FedExAddress Class)

This property contains a password if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyPassword();


public function setProxyPassword($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 85 );


dshippingsdk_fedexaddress_set($res, 85, $value );

Default Value

''

Remarks

This property contains a password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (DShippingSDK_FedExAddress Class)

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Object Oriented Interface

public function getProxyPort();


public function setProxyPort($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 86 );


dshippingsdk_fedexaddress_set($res, 86, $value );

Default Value

80

Remarks

This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (DShippingSDK_FedExAddress Class)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Object Oriented Interface

public function getProxyServer();


public function setProxyServer($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 87 );


dshippingsdk_fedexaddress_set($res, 87, $value );

Default Value

''

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (DShippingSDK_FedExAddress Class)

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Object Oriented Interface

public function getProxySSL();


public function setProxySSL($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 88 );


dshippingsdk_fedexaddress_set($res, 88, $value );

Default Value

0

Remarks

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (DShippingSDK_FedExAddress Class)

This property contains a username if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyUser();


public function setProxyUser($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 89 );


dshippingsdk_fedexaddress_set($res, 89, $value );

Default Value

''

Remarks

This property contains a username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

SearchCriteria Property (DShippingSDK_FedExAddress Class)

The criteria to be used to find FedEx Locations.

Object Oriented Interface

public function getSearchCriteria();


public function setSearchCriteria($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 90 );


dshippingsdk_fedexaddress_set($res, 90, $value );

Default Value

0

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

SortCriteria Property (DShippingSDK_FedExAddress Class)

The criteria to be used to sort the results.

Object Oriented Interface

public function getSortCriteria();


public function setSortCriteria($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 91 );


dshippingsdk_fedexaddress_set($res, 91, $value );

Default Value

0

Remarks

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

Data Type

Integer

SSLAcceptServerCertEncoded Property (DShippingSDK_FedExAddress Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 93 );


dshippingsdk_fedexaddress_set($res, 93, $value );

Default Value

''

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (DShippingSDK_FedExAddress Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 121 );


dshippingsdk_fedexaddress_set($res, 121, $value );

Default Value

''

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (DShippingSDK_FedExAddress Class)

This is the name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();


public function setSSLCertStore($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 137 );


dshippingsdk_fedexaddress_set($res, 137, $value );

Default Value

'MY'

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (DShippingSDK_FedExAddress Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSLCertStorePassword();


public function setSSLCertStorePassword($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 138 );


dshippingsdk_fedexaddress_set($res, 138, $value );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (DShippingSDK_FedExAddress Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 139 );


dshippingsdk_fedexaddress_set($res, 139, $value );

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (DShippingSDK_FedExAddress Class)

This is the subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();


public function setSSLCertSubject($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 140 );


dshippingsdk_fedexaddress_set($res, 140, $value );

Default Value

''

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLProvider Property (DShippingSDK_FedExAddress Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface

public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 148 );


dshippingsdk_fedexaddress_set($res, 148, $value );

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCertEncoded Property (DShippingSDK_FedExAddress Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

dshippingsdk_fedexaddress_get($res, 150 );

Default Value

''

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

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

Data Type

Binary String

Timeout Property (DShippingSDK_FedExAddress Class)

A timeout for the class.

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 177 );


dshippingsdk_fedexaddress_set($res, 177, $value );

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the class fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

TotalLocationsFound Property (DShippingSDK_FedExAddress Class)

Specifies the total number of locations found.

Object Oriented Interface

public function getTotalLocationsFound();


public function setTotalLocationsFound($value);

Procedural Interface

dshippingsdk_fedexaddress_get($res, 178 );


dshippingsdk_fedexaddress_set($res, 178, $value );

Default Value

0

Remarks

This specifies the total number of locations found based on the criteria provided when FindLocations is called.

Data Type

Integer

Config Method (DShippingSDK_FedExAddress Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

dshippingsdk_fedexaddress_do_config($res, $configurationstring);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

FindLocations Method (DShippingSDK_FedExAddress Class)

Finds FedEx location(s) based on the input data.

Object Oriented Interface

public function doFindLocations();

Procedural Interface

dshippingsdk_fedexaddress_do_findlocations($res);

Remarks

FedEx drop-off locations can be searched by phone number or address. On each request, the following properties can be passed in the request (the optional ones are used to narrow down the search and the conditional ones depend on other property values):

• FedExServer (optional)
• FedExAccountNumber (optional)
• Phone (required if searched by phone number)
• Address (required if searched by address)
• ConstraintLocationTypeFlags (optional)

If there are any locations returned, the following properties will be filled:

• Location*

Reset Method (DShippingSDK_FedExAddress Class)

Resets the internal state of the class and all properties to their default values.

Object Oriented Interface

public function doReset();

Procedural Interface

dshippingsdk_fedexaddress_do_reset($res);

Remarks

The Reset method does not have any parameters and does not return any value.

ValidateAddress Method (DShippingSDK_FedExAddress Class)

Returns the corrected and standardized address information or a list of candidates.

Object Oriented Interface

public function doValidateAddress();

Procedural Interface

dshippingsdk_fedexaddress_do_validateaddress($res);

Remarks

This method is used to verify and correct the address specified by the Address.

Any of the following input combinations are valid:

• City, State and ZipCode
• City
• ZipCode
• City and State
• City and ZipCode
• State and ZipCode

Error Event (DShippingSDK_FedExAddress Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

dshippingsdk_fedexaddress_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

The Error event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Notification Event (DShippingSDK_FedExAddress Class)

Notification returned by the server upon successful request (if applicable).

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

dshippingsdk_fedexaddress_register_callback($res, 2, array($this, 'fireNotification'));

Parameter List

 'message'

Remarks

When sending a request, the server may return with a successful reply or an error. However, even when a transaction is successful, a warning or a note might still be returned by the server. In such cases, the Notification event is fired.

Notifications returned through this event are non-fatal and shipments will still be processes, labels will still be printable, rates are still returned, etc. These notifications should be treated as informational only.

SSLServerAuthentication Event (DShippingSDK_FedExAddress Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

dshippingsdk_fedexaddress_register_callback($res, 3, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (DShippingSDK_FedExAddress Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

dshippingsdk_fedexaddress_register_callback($res, 4, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

Config Settings (FedExAddress Class)

FedExAddress Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

Trappable Errors (FedExAddress Class)

FedExAddress Errors

The class may also return one of the following error codes, which are inherited from other classes.