/n software Fedex subscribe Component : subscribe OCX, subscribe .NET Component, subscribe Class, subscribe Bean, subscribe Object

Available in: FEDEX

Subscribe Component [IBiz FedEx Integrator V1]

Properties Methods Events Configuration Settings

Provides a unique Meter Number specific to the customer's FedEx Account Number.

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

This component allows a user to send a subscription request to FedEx. This is a one-time request, meaning that a customer needs to subscribe to the FedEx services only once. A unique meter number specific to the customer's FedEx account number will be returned to the client.

To use this component, you must have a FedEx account number (AccountNumber).

In order to submit either test or production transactions to the FedEx Gateway server (ServerURL), each transaction must contain both a FedEx Account Number (AccountNumber) and another unique identifier, a FedEx Meter Number (MeterNumber). You must send a Subscribe request transaction (containing your FedEx Account Number and contact information) by calling Register method. The response transaction will contain your assigned FedEx Meter Number (MeterNumber), and which Services are authorized (SubscribedService) for that particular FedEx Account.

You will need to submit this subscription request twice:

once after you are registered in the FedEx Test Environment. To register in the FedEx Ship Manager (FSM) Direct program, go to http://www.fedex.com/us/solutions/wis/.
and also once after you are certified to access the FedEx Production Environment.

You should record the MeterNumber and use it with each tracking, rates, shipping, etc. request sent to FedEx.

The restrictions on the allowed property values are listed separately under each control property description. If the user enters more than the allowed number of characters, an error will not be generated. The control will simply pass in the characters up to the maximum amount allowed and disregard the rest. This is important since the resulting value could prevent a correct response.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for complete descriptions.


AccountNumber	FedEx account number for the FedEx customer to which the unique MeterNumber will be assigned.
AddressLine1	Primary address line of the subscriber of account.
AddressLine2	Secondary address line of the subscriber of account.
City	City name of the subscriber of account.
CompanyName	Company name of the subscriber of account.
ContactName	Contact name of the subscriber of account.
Country	Country code of the subscriber of account.
EmailAddress	Email address of the subscriber of account.
FaxNumber	Fax number of the subscriber of account.
MeterNumber	Meter number to use for submitting requests to the FedEx ServerURL.
PhoneNumber	Phone number of the subscriber of account.
PostalCode	Postal code of the subscriber of account.
ServerURL	URL for the FedEx server where the requests are sent.
ServiceCount	Number of SubscribedService returned in the response.
ServiceIndex	Index of a SubscribedService.
State	State or province code of the subscriber of account.
SubscribedService	FedEx Services the customer with AccountNumber is eligible for.
Timeout	A timeout for the component.

Method List

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


Config	Sets or retrieves a component configuration setting.
Register	Subscribes the registered user to FedEx services retrieving the MeterNumber.
Reset	Reset the internal state of the component and all properties to their default values.

Event List

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


Error	Information about errors during data delivery.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Shows the progress of the secure connection.

Configuration Settings

The following is a list of configuration settings for the component with short descriptions. Click on the links for complete descriptions.


AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
CodePage	The system code page used for Unicode to Multibyte translations (Windows/COM only).
FirewallData	Used to send extra data to the firewall.
FirewallListener	If true, the component binds to a SOCKS firewall as a server (IPPort only).
FullRequest	Contains the full request sent to the FedEx server.
FullResponse	Contains the full response returned by the FedEx server.
HTTPVersion	The version of HTTP used by the component
IfModifiedSince	A date determining the maximum age of the desired document.
InBufferSize	The size in bytes of the incoming queue of the socket.
KeepAlive	Determines whether the HTTP connection is closed after the completion of the request.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferredData	The maximum number of incoming bytes to be stored by the component.
OpenSSLCADir	The path to a directory containing CA certificates.
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator(PRNG).
OutBufferSize	The size in bytes of the outgoing queue of the socket.
ProxyAuthorization	The authorization string to be sent to the proxy server.
ProxyPassword	A password if Basic authentication is to be used for the proxy.
ProxyPort	Port for the proxy server (default 80).
ProxyServer	Name or IP address of a proxy server (optional).
ProxyUser	A user name if Basic authentication is to be used for the proxy.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLProvider	The name of the security provider to use.
SSLSecurityFlags	Flags that control certificate verification
SocketHandle	The handle of the main socket used by the component.
UseWinInet	If set, the WinInet API is used for retrieving the URL
UseWinInetCookies	Controls whether to send and accept cookies when making http requests through WinInet
UserAgent	Information about the user agent (browser).
Warning	Information on a Soft Error (if applicable).
WinsockInfo	Identifying information about the loaded Winsock stack (Windows only)
WinsockLoaded	Loads and unloads Winsock on demand (Windows only)
WinsockMaxDatagramSize	Size in bytes of the largest UDP datagram that can be sent or received (Windows only)
WinsockMaxSockets	Maximum number of sockets available to a single process (Windows only)
WinsockPath	The path to the Winsock DLL used (Windows only)
WinsockStatus	The status of the Winsock stack (Windows only)
XPath	Used to retrieve data at any place within the response.