/n software USPS trackandconfirm Component : trackandconfirm OCX, trackandconfirm .NET Component, trackandconfirm Class, trackandconfirm Bean, trackandconfirm Object

Available in: USPS

TrackAndConfirm Component [IBiz USPS Integrator V2]

Properties Methods Events Configuration Settings

Retrieves tracking data any package shipped with Delivery or Signature confirmation.

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 is used to check the delivery status of any package without having to go to the USPS web site to make any queries about the status of your shipment. This component can retrieve tracking information for any Express Mail package, any package sent to a US address utilizing the Delivery or Signature confirmation option, as well as all International shipments.

To retrieve tracking information, simply provide your tracking number as a parameter into one of the two methods listed below.


GetTrackingInfo	Returns an overview of the current package's status in the TrackSummary and TrackDetail properties.
GetDetailedTrackingInfo	Returns a detailed account of the package status at every step along the way.

For the GetDetailedTrackingInfo method, information will be provided for each time the barcode on the label was scanned. There may be many such tracking events as a package travels to its destination, and information on each hop is contained in the Track- properties, from index 0 (the first event), to TrackCount - 1 (the latest event). Information is returned in the following properties:


TrackDate	The date this tracking event occurred.
TrackTime	The time at which this tracking event occurred.
TrackCity	The city where the tracking event occurred.
TrackState	The state (or province) where the tracking event occurred.
TrackZipCode	The zip code where the tracking event occurred.
TrackCountry	The country where the tracking event occurred.
TrackEvent	Description of the tracking event (enroute, delivered, etc)
TrackDetail	More detailed information about the tracking event.
TrackFirmName	Name of the firm the package was delivered to.
TrackSigner	Name of the person who signed for the package.

The following example will return sample data from a special USPS test server:

TrackAndConfirm1.UserId = "YOURIDHERE" TrackAndConfirm1.Server = "http://testing.shippingapis.com/ShippingAPITest.dll" TrackAndConfirm1.GetTrackingInfo("EJ958083578US") ' Only works with above URL

Property List

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


FirewallHost	Name or IP address of firewall (optional).
FirewallPassword	A password if authentication is to be used when connecting through the firewall.
FirewallPort	Port of the firewall to connect to.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
Password	Password to use for logging in to the USPS Server.
SSLAcceptServerCert	Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertEncoded	The SSL certificate (PEM/base64 encoded).
SSLCertStore	The name of the certificate store for the client certificate.
SSLCertStorePassword	The password for the certificate store (if any).
SSLCertStoreType	The type of certificate store for the client certificate.
SSLCertSubject	The subject of the certificate used for client authentication.
SSLServerCert	The server certificate for the last established connection.
SSLServerCertStatus	The verification status of the server certificate for the last established connection.
Server	URL for the USPS server where the requests are sent.
Timeout	A timeout for the component.
TrackAuthorizedAgent	Indicates whether the TrackSigner is an authorized agent.
TrackCity	The city where the tracking event occurred.
TrackCount	The number of tracking events returned for a given TrackingNumber.
TrackCountry	The country where the tracking event occurred for a given TrackingNumber.
TrackDate	Date of the tracking event for a given TrackingNumber.
TrackDetail	Tracking detail information for requested TrackingNumber(s).
TrackEvent	The Event Type of each tracking event for a given TrackingNumber.
TrackFirmName	Company name if delivered to a company for a given TrackingNumber.
TrackSigner	Name of the person signing for delivery (if applicable) for a given TrackingNumber.
TrackState	State where the package was scanned for this tracking event.
TrackSummary	Tracking summary information for requested TrackingNumber.
TrackTime	Time of the tracking event.
TrackZipCode	The 5-digit zip code where the tracking event occurred.
UserId	User ID for logging in to the USPS Server.

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.
GetDetailedTrackingInfo	Returns detailed tracking and/or delivery confirmation information for requested TrackingNumber.
GetTrackingInfo	Returns tracking data for requested TrackingNumber.
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).
FullResponse	Contains the full response returned by the USPS 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).
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.