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

Available in: USPS

DomesticRates Component [IBiz USPS Integrator V2]

Properties Methods Events Configuration Settings

Determines domestic postage rates based on weight, size, class of mail, and origin/destination information.

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 implements the RateV3 API, and provides automated online access to domestic rate information. These rates are for Express Mail, First-Class Mail, and Priority Mail, as well as single-piece rates for all four Package Services: Parcel Post, Bound Printed Matter, Library Mail, and Media Mail.

To use this component to receive rate information, simply set the PackagePounds, PackageOunces, FromZipCode, ToZipCode, and PackageSize. Then simply call CalculatePostage. For example:

DomesticRates1.FromZipCode = "10022" DomesticRates1.ToZipCode = "20008" DomesticRates1.PackagePounds = 0 DomesticRates1.PackageOunces = 9 DomesticRates1.PackageSize = psRegular DomesticRates1.CalculatePostage()

You may also optionally supply dimensions of the package with PackageLength, PackageWidth, and PackageHeight, and filter the results returned by ServiceType and ShippingContainer.

In response to this request, the USPS Server will return a list of postage services available for mailing your package. You can access these services through the PostageRate and PostageService array properties. Indices for the postage services start at 0, and the total number of services returned is indicated by the PostageCount property. The number of PostalZones between the FromZipCode and ToZipCode will also be returned, along with any Restrictions for mailing to APO/FPO addresses.

This component is used to provide domestic rates for the US and her territories. To find International shipping rates, use the INTERNATIONALRATES component instead.

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.
FirstClassType	Indicates the type of first class mail.
FromZipCode	The ZIP Code the package is to be shipped from.
Machinable	Indicates if the package being shipped is classified as machinable.
PackageGirth	Measurement around the widest part of the package, perpendicular to the PackageLength.
PackageHeight	Height of the package
PackageLength	The length of the longest side of the package.
PackageOunces	Estimated weight of the package to be mailed - ounce portion.
PackagePounds	Estimated weight of the package to be mailed - pounds portion.
PackageSize	Size of the package being mailed.
PackageWidth	Width of the package.
Password	Password to use for logging in to the USPS Server.
PostageCount	Number of postage rates returned by USPS Server when shipping from FromZipCode to ToZipCode.
PostageRate	Postage rate for the associated PostageService.
PostageService	Mail service type for the associated PostageRate.
PostageServiceId	Integer representation of the PostageService description.
PostalZone	Indicates the number of postal rate zones between the origin and destination zip codes.
Restrictions	Restrictions for APO/FPI destination Zip Codes.
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.
ServiceType	Indicates the type of service to request shipping prices on.
ShippingContainer	The type of container the item is packaged in.
Timeout	A timeout for the component.
ToZipCode	Zip Code the package is to be shipped to.
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.


CalculatePostage	Calculates postage rates to ship a package via ServiceType from FromZipCode to ToZipCode
Config	Sets or retrieves a component configuration setting.
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.