Search: 
Available in: USPS
CarrierPickup Component [IBiz USPS Integrator V2]

Properties   Methods   Events   Configuration Settings  

Submits a request for your carrier to pick up packages from your current location.

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 submit an online request to have your mail carrier pick up your packages when he or she arrives with your regular mail delivery. You can schedule multiple pickups and edit or cancel previously submitted pickups, and even electronically determine if carrier pickup is available at your current address.

The following methods are available for scheduling carrier pickups:

PickupAvailabilityChecks the availability of a Carrier Pickup service for the given address.
SchedulePickupSchedules a Carrier Pickup.
PickupInquiryReturns all the data submitted in your original SchedulePickup request.
ChangePickupChanges your original scheduled pickup with updated information (number of packages, change the date, etc).
CancelPickupCancels a scheduled Carrier Pickup request.

After a successful transaction the USPS server will update the To/From address information with a standardized address. Depending on the method called, the following properties may also be returned:

ConfirmationNumber Used to retrieve and modify a scheduled pickup.
DateDate carrier will pick up your packages
DayOfWeek Day of the week on which the carrier will pick up your packages.
CarrierRouteThe route number for the carrier that will pick up your packages.

Property List

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

Address The street address where the pickup service is requested.
CarrierRoute The carrier route.
City The city where the pickup service is requested.
ConfirmationNumber The confirmation number for pickup returned by the USPS Server.
CountExpress The number of Express Mail packages to be picked up.
CountInternational The number of International Mail packages to be picked up.
CountOther The number of packages to be picked up for a service type other than Priority/Express/International Mail.
CountPriority The number of Priority Mail packages to be picked up.
Date Scheduled date for pickup.
DayOfWeek Day of the week for pickup.
EstimatedWeight The estimated weight for the package to be picked up.
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.
FirmName The name of the Firm/Company that is requesting pickup service.
FirstName The first name of the person requesting the pickup service.
LastName The last name of the person requesting the pickup service.
PackageLocation The location of pickup.
Password Password to use for logging in to the USPS Server.
PhoneExtension The extension for the sender's phone number.
PhoneNumber Phone number of sender.
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.
SpecialInstructions Special instructions for pickup location.
State The state where the pickup service is requested.
Status Status of the pickup request to cancel or change.
SuiteOrApartment The apartment or suite number where the pickup service is requested.
Timeout A timeout for the component.
UserId User ID for logging in to the USPS Server.
Zip4 The 4 digits part of the Zip Code.
ZipCode The Zip Code where the pickup is requested.

Method List

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

CancelPickup Cancels a scheduled Carrier Pickup request.
ChangePickup Changes requested data in your original Pickup Schedule request and schedules a new pickup.
Config Sets or retrieves a component configuration setting.
PickupAvailability Checks the availability of a Carrier Pickup service for the given address.
PickupInquiry Retrieves the data submitted in your original SchedulePickup request.
Reset Reset the internal state of the component and all properties to their default values.
SchedulePickup Schedules a Carrier Pickup and provides the user a confirmation number for the scheduled pickup.

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.

| About | Privacy Policy | Terms of Use |
© Copyright 2010 /n software inc.