FedExAddress Component

Properties   Methods   Events   Config Settings   Errors  

Allows you to validate or complete recipient addresses.

Syntax

TibxFedExAddress

Remarks

Via this component 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 component, 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 component with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

Address1 Property (FedExAddress Component)

Street name.

Syntax

__property String Address1 = { read=FAddress1, write=FSetAddress1 };

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 (FedExAddress Component)

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

Syntax

__property String Address2 = { read=FAddress2, write=FSetAddress2 };

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 (FedExAddress Component)

Various flags that denote information about the address.

Syntax

__property int AddressFlags = { read=FAddressFlags, write=FSetAddressFlags };

Default Value

0

Remarks

Various flags that denote information about the address.

Data Type

Integer

City Property (FedExAddress Component)

Name of city, town, etc.

Syntax

__property String City = { read=FCity, write=FSetCity };

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 (FedExAddress Component)

Country code.

Syntax

__property String CountryCode = { read=FCountryCode, write=FSetCountryCode };

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 (FedExAddress Component)

State or province code.

Syntax

__property String State = { read=FState, write=FSetState };

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 (FedExAddress Component)

Postal code.

Syntax

__property String ZipCode = { read=FZipCode, write=FSetZipCode };

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 (FedExAddress Component)

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

Syntax

__property String Company = { read=FCompany, write=FSetCompany };

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 (FedExAddress Component)

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

Syntax

__property int ConstraintFilters = { read=FConstraintFilters, write=FSetConstraintFilters };

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 (FedExAddress Component)

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

Syntax

__property int ConstraintLocationAttributes = { read=FConstraintLocationAttributes, write=FSetConstraintLocationAttributes };

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 (FedExAddress Component)

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

Syntax

__property int ConstraintLocationContentOptions = { read=FConstraintLocationContentOptions, write=FSetConstraintLocationContentOptions };

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 (FedExAddress Component)

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

Syntax

__property int ConstraintLocationTypeFlags = { read=FConstraintLocationTypeFlags, write=FSetConstraintLocationTypeFlags };

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 (FedExAddress Component)

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

Syntax

__property int ConstraintRedirectToHoldType = { read=FConstraintRedirectToHoldType, write=FSetConstraintRedirectToHoldType };

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 (FedExAddress Component)

The number of results requested.

Syntax

__property int ConstraintResultsRequested = { read=FConstraintResultsRequested, write=FSetConstraintResultsRequested };

Default Value

1

Remarks

The number of results requested.

Data Type

Integer

ConstraintResultsToSkip Property (FedExAddress Component)

The number of results to skip.

Syntax

__property int ConstraintResultsToSkip = { read=FConstraintResultsToSkip, write=FSetConstraintResultsToSkip };

Default Value

0

Remarks

The number of results to skip.

Data Type

Integer

ConstraintSearchRadius Property (FedExAddress Component)

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

Syntax

__property String ConstraintSearchRadius = { read=FConstraintSearchRadius, write=FSetConstraintSearchRadius };

Default Value

""

Remarks

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

Data Type

String

FedExAccountNumber Property (FedExAddress Component)

The account number associated with the shipment.

Syntax

__property String FedExAccountNumber = { read=FFedExAccountNumber, write=FSetFedExAccountNumber };

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 (FedExAddress Component)

Authorization Token used to authenticate the request.

Syntax

__property String FedExAuthorizationToken = { read=FFedExAuthorizationToken, write=FSetFedExAuthorizationToken };

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 (FedExAddress Component)

Two-letter code for the language (e.

Syntax

__property String FedExLanguageCode = { read=FFedExLanguageCode, write=FSetFedExLanguageCode };

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 (FedExAddress Component)

Two-letter code for the region (e.

Syntax

__property String FedExLocaleCode = { read=FFedExLocaleCode, write=FSetFedExLocaleCode };

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 (FedExAddress Component)

URL for the FedEx Server where the requests are sent.

Syntax

__property String FedExServer = { read=FFedExServer, write=FSetFedExServer };

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 (FedExAddress Component)

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

Syntax

__property bool FirewallAutoDetect = { read=FFirewallAutoDetect, write=FSetFirewallAutoDetect };

Default Value

False

Remarks

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

Data Type

Boolean

FirewallType Property (FedExAddress Component)

This property determines the type of firewall to connect through.

Syntax

__property TibxFedExAddressFirewallTypes FirewallType = { read=FFirewallType, write=FSetFirewallType };

enum TibxFedExAddressFirewallTypes {
  fwNone=0,
  fwTunnel=1,
  fwSOCKS4=2,
  fwSOCKS5=3,
  fwSOCKS4A=10
};

Default Value

fwNone

Remarks

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

Data Type

Integer

FirewallHost Property (FedExAddress Component)

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

Syntax

__property String FirewallHost = { read=FFirewallHost, write=FSetFirewallHost };

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 component raises an exception.

Data Type

String

FirewallPassword Property (FedExAddress Component)

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

Syntax

__property String FirewallPassword = { read=FFirewallPassword, write=FSetFirewallPassword };

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 component raises an exception.

Data Type

String

FirewallPort Property (FedExAddress Component)

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

Syntax

__property int FirewallPort = { read=FFirewallPort, write=FSetFirewallPort };

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 (FedExAddress Component)

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

Syntax

__property String FirewallUser = { read=FFirewallUser, write=FSetFirewallUser };

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 component raises an exception.

Data Type

String

GeographicCoordinates Property (FedExAddress Component)

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

Syntax

__property String GeographicCoordinates = { read=FGeographicCoordinates, write=FSetGeographicCoordinates };

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 (FedExAddress Component)

The number of records in the Location arrays.

Syntax

__property int LocationCount = { read=FLocationCount, write=FSetLocationCount };

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 (FedExAddress Component)

The currency that is accepted at this FedEx location.

Syntax

__property String LocationAcceptedCurrency[int LocationIndex] = { read=FLocationAcceptedCurrency };

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 (FedExAddress Component)

This specifies what type of services this FedEx location provides.

Syntax

__property int LocationAttributes[int LocationIndex] = { read=FLocationAttributes };

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 (FedExAddress Component)

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

Syntax

__property int LocationCarrierCount[int LocationIndex] = { read=FLocationCarrierCount };

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 (FedExAddress Component)

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

Syntax

__property int LocationCarrierIndex[int LocationIndex] = { read=FLocationCarrierIndex, write=FSetLocationCarrierIndex };

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 (FedExAddress Component)

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

Syntax

__property int LocationCarrierLatestDropoffCount[int LocationIndex] = { read=FLocationCarrierLatestDropoffCount };

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 (FedExAddress Component)

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

Syntax

__property String LocationCarrierLatestDropoffDayOfWeek[int LocationIndex] = { read=FLocationCarrierLatestDropoffDayOfWeek };

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 (FedExAddress Component)

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

Syntax

__property int LocationCarrierLatestDropoffIndex[int LocationIndex] = { read=FLocationCarrierLatestDropoffIndex, write=FSetLocationCarrierLatestDropoffIndex };

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 (FedExAddress Component)

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

Syntax

__property String LocationCarrierLatestDropoffOperationTime[int LocationIndex] = { read=FLocationCarrierLatestDropoffOperationTime };

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 (FedExAddress Component)

This contains the type of carrier the current carrier is.

Syntax

__property TibxFedExAddressLocationCarrierTypes LocationCarrierType[int LocationIndex] = { read=FLocationCarrierType };

enum TibxFedExAddressLocationCarrierTypes {
  lctFDXC=0,
  lctFDXE=1,
  lctFDXG=2,
  lctFXCC=3,
  lctFXFR=4,
  lctFXSP=5
};

Default Value

lctFDXC

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 (FedExAddress Component)

Name of the city that the current location is in.

Syntax

__property String LocationCity[int LocationIndex] = { read=FLocationCity };

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 (FedExAddress Component)

The name of the business at this FedEx location.

Syntax

__property String LocationCompanyName[int LocationIndex] = { read=FLocationCompanyName };

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 (FedExAddress Component)

This contains the country code for the current location.

Syntax

__property String LocationCountryCode[int LocationIndex] = { read=FLocationCountryCode };

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 (FedExAddress Component)

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

Syntax

__property String LocationDistance[int LocationIndex] = { read=FLocationDistance };

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 (FedExAddress Component)

The email address provided for the current location.

Syntax

__property String LocationEmail[int LocationIndex] = { read=FLocationEmail };

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 (FedExAddress Component)

The entity ID for the current location.

Syntax

__property String LocationEntityId[int LocationIndex] = { read=FLocationEntityId };

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 (FedExAddress Component)

This contains the fax number for the current location.

Syntax

__property String LocationFax[int LocationIndex] = { read=FLocationFax };

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 (FedExAddress Component)

This contains the geographic coordinates of the current location.

Syntax

__property String LocationGeographicCoordinates[int LocationIndex] = { read=FLocationGeographicCoordinates };

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 (FedExAddress Component)

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

Syntax

__property int LocationHolidayCount[int LocationIndex] = { read=FLocationHolidayCount };

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 (FedExAddress Component)

This is the date of the holiday specified by HolidayIndex .

Syntax

__property String LocationHolidayDate[int LocationIndex] = { read=FLocationHolidayDate };

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 (FedExAddress Component)

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

Syntax

__property int LocationHolidayIndex[int LocationIndex] = { read=FLocationHolidayIndex, write=FSetLocationHolidayIndex };

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 (FedExAddress Component)

This contains the name of the holiday specified by HolidayIndex .

Syntax

__property String LocationHolidayName[int LocationIndex] = { read=FLocationHolidayName };

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 (FedExAddress Component)

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

Syntax

__property String LocationId[int LocationIndex] = { read=FLocationId };

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 (FedExAddress Component)

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

Syntax

__property String LocationMapURL[int LocationIndex] = { read=FLocationMapURL };

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 (FedExAddress Component)

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

Syntax

__property String LocationPersonName[int LocationIndex] = { read=FLocationPersonName };

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 (FedExAddress Component)

The phone number for the current location.

Syntax

__property String LocationPhone[int LocationIndex] = { read=FLocationPhone };

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 (FedExAddress Component)

This contains any special instructions provided for the current location.

Syntax

__property String LocationSpecialInstructions[int LocationIndex] = { read=FLocationSpecialInstructions };

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 (FedExAddress Component)

State or province code of the current location.

Syntax

__property String LocationState[int LocationIndex] = { read=FLocationState };

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 (FedExAddress Component)

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

Syntax

__property int LocationStoreHoursCount[int LocationIndex] = { read=FLocationStoreHoursCount };

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 (FedExAddress Component)

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

Syntax

__property String LocationStoreHoursDayOfWeek[int LocationIndex] = { read=FLocationStoreHoursDayOfWeek };

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 (FedExAddress Component)

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

Syntax

__property String LocationStoreHoursExceptionalHours[int LocationIndex] = { read=FLocationStoreHoursExceptionalHours };

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 (FedExAddress Component)

Indicates the type of exceptional hours.

Syntax

__property String LocationStoreHoursExceptionalHoursType[int LocationIndex] = { read=FLocationStoreHoursExceptionalHoursType };

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 (FedExAddress Component)

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

Syntax

__property int LocationStoreHoursIndex[int LocationIndex] = { read=FLocationStoreHoursIndex, write=FSetLocationStoreHoursIndex };

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 (FedExAddress Component)

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

Syntax

__property String LocationStoreHoursOperationalHours[int LocationIndex] = { read=FLocationStoreHoursOperationalHours };

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 (FedExAddress Component)

Indicates the type of operational hours.

Syntax

__property String LocationStoreHoursOperationalHoursType[int LocationIndex] = { read=FLocationStoreHoursOperationalHoursType };

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 (FedExAddress Component)

The store number for the current location.

Syntax

__property int LocationStoreNumber[int LocationIndex] = { read=FLocationStoreNumber };

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 (FedExAddress Component)

Street address or intersection of this FedEx location.

Syntax

__property String LocationStreetAddress[int LocationIndex] = { read=FLocationStreetAddress };

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 (FedExAddress Component)

The type of this FedEx location.

Syntax

__property TibxFedExAddressLocationTypes LocationType[int LocationIndex] = { read=FLocationType, write=FSetLocationType };

enum TibxFedExAddressLocationTypes {
  fltAuthorizedShipCenter=0,
  fltExpressStation=1,
  fltFreightServiceCenter=2,
  fltGroundTerminal=3,
  fltHomeDeliveryStation=4,
  fltFedExOffice=5,
  fltSelfServiceStation=6,
  fltSmartPostHub=7,
  fltFedExFacility=8,
  fltFedExOnsite=9,
  fltFedExShipSite=10
};

Default Value

fltAuthorizedShipCenter

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 (FedExAddress Component)

The postal code for the current location.

Syntax

__property String LocationZipCode[int LocationIndex] = { read=FLocationZipCode };

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 (FedExAddress Component)

The number of records in the Match arrays.

Syntax

__property int MatchCount = { read=FMatchCount };

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 (FedExAddress Component)

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

Syntax

__property String MatchAddress1[int MatchIdx] = { read=FMatchAddress1 };

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 (FedExAddress Component)

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

Syntax

__property String MatchAddress2[int MatchIdx] = { read=FMatchAddress2 };

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 (FedExAddress Component)

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

Syntax

__property String MatchChangeType[int MatchIdx] = { read=FMatchChangeType };

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 (FedExAddress Component)

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

Syntax

__property String MatchCity[int MatchIdx] = { read=FMatchCity };

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 (FedExAddress Component)

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

Syntax

__property String MatchCompany[int MatchIdx] = { read=FMatchCompany };

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 (FedExAddress Component)

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

Syntax

__property String MatchCountryCode[int MatchIdx] = { read=FMatchCountryCode };

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 (FedExAddress Component)

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

Syntax

__property String MatchCustomerMessage[int MatchIdx] = { read=FMatchCustomerMessage };

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 (FedExAddress Component)

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

Syntax

__property String MatchQuality[int MatchIdx] = { read=FMatchQuality };

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 component 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 (FedExAddress Component)

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

Syntax

__property String MatchResidentialStatus[int MatchIdx] = { read=FMatchResidentialStatus };

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 (FedExAddress Component)

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

Syntax

__property String MatchState[int MatchIdx] = { read=FMatchState };

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 (FedExAddress Component)

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

Syntax

__property String MatchZipCode[int MatchIdx] = { read=FMatchZipCode };

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 (FedExAddress Component)

The maximum number of results to be returned.

Syntax

__property int MaxResults = { read=FMaxResults, write=FSetMaxResults };

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 (FedExAddress Component)

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

Syntax

__property String Phone = { read=FPhone, write=FSetPhone };

Default Value

""

Remarks

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

Data Type

String

ProxyAuthScheme Property (FedExAddress Component)

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

Syntax

__property TibxFedExAddressProxyAuthSchemes ProxyAuthScheme = { read=FProxyAuthScheme, write=FSetProxyAuthScheme };

enum TibxFedExAddressProxyAuthSchemes {
  authBasic=0,
  authDigest=1,
  authProprietary=2,
  authNone=3,
  authNtlm=4,
  authNegotiate=5
};

Default Value

authBasic

Remarks

This property is used to tell the component 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 component. Look at the configuration file for the component 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 (FedExAddress Component)

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

Syntax

__property bool ProxyAutoDetect = { read=FProxyAutoDetect, write=FSetProxyAutoDetect };

Default Value

False

Remarks

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

Data Type

Boolean

ProxyPassword Property (FedExAddress Component)

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

Syntax

__property String ProxyPassword = { read=FProxyPassword, write=FSetProxyPassword };

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 (FedExAddress Component)

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

Syntax

__property int ProxyPort = { read=FProxyPort, write=FSetProxyPort };

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 (FedExAddress Component)

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

Syntax

__property String ProxyServer = { read=FProxyServer, write=FSetProxyServer };

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 (FedExAddress Component)

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

Syntax

__property TibxFedExAddressProxySSLs ProxySSL = { read=FProxySSL, write=FSetProxySSL };

enum TibxFedExAddressProxySSLs {
  psAutomatic=0,
  psAlways=1,
  psNever=2,
  psTunnel=3
};

Default Value

psAutomatic

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 (FedExAddress Component)

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

Syntax

__property String ProxyUser = { read=FProxyUser, write=FSetProxyUser };

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 (FedExAddress Component)

The criteria to be used to find FedEx Locations.

Syntax

__property TibxFedExAddressSearchCriterias SearchCriteria = { read=FSearchCriteria, write=FSetSearchCriteria };

enum TibxFedExAddressSearchCriterias {
  sctAddress=0,
  sctGeographicCoordinates=1,
  sctPhoneNumber=2
};

Default Value

sctAddress

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 (FedExAddress Component)

The criteria to be used to sort the results.

Syntax

__property TibxFedExAddressSortCriterias SortCriteria = { read=FSortCriteria, write=FSetSortCriteria };

enum TibxFedExAddressSortCriterias {
  scDistance=0,
  scLatestExpressDropoffTime=1,
  scLatestGroundDropoffTime=2,
  scLocationType=3
};

Default Value

scDistance

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 (FedExAddress Component)

This is the certificate (PEM/Base64 encoded).

Syntax

__property String SSLAcceptServerCertEncoded = { read=FSSLAcceptServerCertEncoded, write=FSetSSLAcceptServerCertEncoded };
__property DynamicArray<Byte> SSLAcceptServerCertEncodedB = { read=FSSLAcceptServerCertEncodedB, write=FSetSSLAcceptServerCertEncodedB };

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

Byte Array

SSLCertEncoded Property (FedExAddress Component)

This is the certificate (PEM/Base64 encoded).

Syntax

__property String SSLCertEncoded = { read=FSSLCertEncoded, write=FSetSSLCertEncoded };
__property DynamicArray<Byte> SSLCertEncodedB = { read=FSSLCertEncodedB, write=FSetSSLCertEncodedB };

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

Byte Array

SSLCertStore Property (FedExAddress Component)

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

Syntax

__property String SSLCertStore = { read=FSSLCertStore, write=FSetSSLCertStore };
__property DynamicArray<Byte> SSLCertStoreB = { read=FSSLCertStoreB, write=FSetSSLCertStoreB };

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

Byte Array

SSLCertStorePassword Property (FedExAddress Component)

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

Syntax

__property String SSLCertStorePassword = { read=FSSLCertStorePassword, write=FSetSSLCertStorePassword };

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 (FedExAddress Component)

This is the type of certificate store for this certificate.

Syntax

__property TibxFedExAddressSSLCertStoreTypes SSLCertStoreType = { read=FSSLCertStoreType, write=FSetSSLCertStoreType };

enum TibxFedExAddressSSLCertStoreTypes {
  cstUser=0,
  cstMachine=1,
  cstPFXFile=2,
  cstPFXBlob=3,
  cstJKSFile=4,
  cstJKSBlob=5,
  cstPEMKeyFile=6,
  cstPEMKeyBlob=7,
  cstPublicKeyFile=8,
  cstPublicKeyBlob=9,
  cstSSHPublicKeyBlob=10,
  cstP7BFile=11,
  cstP7BBlob=12,
  cstSSHPublicKeyFile=13,
  cstPPKFile=14,
  cstPPKBlob=15,
  cstXMLFile=16,
  cstXMLBlob=17,
  cstJWKFile=18,
  cstJWKBlob=19,
  cstSecurityKey=20,
  cstBCFKSFile=21,
  cstBCFKSBlob=22,
  cstPKCS11=23,
  cstAuto=99
};

Default Value

cstUser

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubject Property (FedExAddress Component)

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

Syntax

__property String SSLCertSubject = { read=FSSLCertSubject, write=FSetSSLCertSubject };

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 (FedExAddress Component)

This specifies the SSL/TLS implementation to use.

Syntax

__property TibxFedExAddressSSLProviders SSLProvider = { read=FSSLProvider, write=FSetSSLProvider };

enum TibxFedExAddressSSLProviders {
  sslpAutomatic=0,
  sslpPlatform=1,
  sslpInternal=2
};

Default Value

sslpAutomatic

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 component 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 component will select a provider depending on the current platform.

When Automatic is selected the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used.

Data Type

Integer

SSLServerCertEncoded Property (FedExAddress Component)

This is the certificate (PEM/Base64 encoded).

Syntax

__property String SSLServerCertEncoded = { read=FSSLServerCertEncoded };
__property DynamicArray<Byte> SSLServerCertEncodedB = { read=FSSLServerCertEncodedB };

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

Byte Array

Timeout Property (FedExAddress Component)

A timeout for the component.

Syntax

__property int Timeout = { read=FTimeout, write=FSetTimeout };

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 component will wait for the operation to complete before returning control.

The component 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 component raises an exception.

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 (FedExAddress Component)

Specifies the total number of locations found.

Syntax

__property int TotalLocationsFound = { read=FTotalLocationsFound, write=FSetTotalLocationsFound };

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 (FedExAddress Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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 (FedExAddress Component)

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

Syntax

void __fastcall FindLocations();

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 (FedExAddress Component)

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

Syntax

void __fastcall Reset();

Remarks

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

ValidateAddress Method (FedExAddress Component)

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

Syntax

void __fastcall ValidateAddress();

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 (FedExAddress Component)

Information about errors during data delivery.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TibxFedExAddressErrorEventParams;
typedef void __fastcall (__closure *TibxFedExAddressErrorEvent)(System::TObject* Sender, TibxFedExAddressErrorEventParams *e);
__property TibxFedExAddressErrorEvent OnError = { read=FOnError, write=FOnError };

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 (FedExAddress Component)

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

Syntax

typedef struct {
  String Message;
} TibxFedExAddressNotificationEventParams;
typedef void __fastcall (__closure *TibxFedExAddressNotificationEvent)(System::TObject* Sender, TibxFedExAddressNotificationEventParams *e);
__property TibxFedExAddressNotificationEvent OnNotification = { read=FOnNotification, write=FOnNotification };

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 (FedExAddress Component)

Fired after the server presents its certificate to the client.

Syntax

typedef struct {
  String CertEncoded;
  DynamicArray<Byte> CertEncodedB;
  String CertSubject;
  String CertIssuer;
  String Status;
  bool Accept;
} TibxFedExAddressSSLServerAuthenticationEventParams;
typedef void __fastcall (__closure *TibxFedExAddressSSLServerAuthenticationEvent)(System::TObject* Sender, TibxFedExAddressSSLServerAuthenticationEventParams *e);
__property TibxFedExAddressSSLServerAuthenticationEvent OnSSLServerAuthentication = { read=FOnSSLServerAuthentication, write=FOnSSLServerAuthentication };

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 (FedExAddress Component)

Fired when secure connection progress messages are available.

Syntax

typedef struct {
  String Message;
} TibxFedExAddressSSLStatusEventParams;
typedef void __fastcall (__closure *TibxFedExAddressSSLStatusEvent)(System::TObject* Sender, TibxFedExAddressSSLStatusEventParams *e);
__property TibxFedExAddressSSLStatusEvent OnSSLStatus = { read=FOnSSLStatus, write=FOnSSLStatus };

Remarks

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

Config Settings (FedExAddress Component)

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 Component)

FedExAddress Errors

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