Package DE_EPAGES::USPS::API::WebServices::PackagePickupSchedule
It collects (XML) information required to generate USPS Package Pickup Schedule requests and processed correct responses
Functions
- callWebService
- feedRequest
- getAddress2OrError
- getCarrierRouteOrEmpty
- getCityOrError
- getConfirmationNumberOrEmpty
- getCountTypeOrEmpty
- getDateOrEmpty
- getDayOfWeekOrEmpty
- getEmailAddressOrEmpty
- getEstimatedWeightOrEmpty
- getExtensionOrEmpty
- getFirmNameOrEmpty
- getFirstNameOrEmpty
- getLastNameOrEmpty
- getPackageLocationOrEmpty
- getPackageOrEmpty
- getPhoneOrEmpty
- getServiceTypeOrEmpty
- getSpecialInstructionsOrEmpty
- getStateOrError
- getSuiteOrAptOrEmpty
- getUrbanizationOrEmpty
- getZipcode4OrEmpty
- getZipcode5OrError
- isValidResponseOrError
- new
- setAddress
- setCredentials
- setPackageLocationOrError
- setPickupSettings
- setServiceTypeOrError
- setWeightInOunces
callWebService
It arranges the log filter and calls the web service through the common interface.
Syntax |
$self->callWebService(); |
feedRequest
It feeds USPS PackagePickupSchedule object, ready to use the web service call.
Syntax |
$self->feedRequest($ShippingLabel); |
Input |
|
getAddress2OrError
It checks that the response is of APItag type, that the node name exists for the response and returns the content. It returns an empty string if no node can be found.
Syntax |
self->getAddress2OrError( ); |
Return |
|
getCarrierRouteOrEmpty
It checks that the response is of APItag type, that the node name exists for the response and returns the content. It returns an empty string if no node can be found.
Syntax |
getCarrierRouteOrEmpty( ); |
Return |
|
getCityOrError
It checks that the response is of APItag type, that the node name exists for the response and returns the content. It returns an empty string if no node can be found.
Syntax |
self->getCityOrError( ); |
Return |
|
getConfirmationNumberOrEmpty
It checks that the response is of APItag type, that the node name exists for the response and returns the content. It returns an empty string if no node can be found.
Syntax |
self->getConfirmationNumberOrEmpty( ); |
Return |
|
getCountTypeOrEmpty
It checks that the response is of APItag type, that the node name exists for the response and returns the content. It returns an empty string if no node can be found.
Syntax |
self->getCountTypeOrEmpty( ); |
Return |
|
getDateOrEmpty
It checks that the response is of APItag type, that the node name exists for the response and returns the content. It returns an empty string if no node can be found.
Syntax |
self->getDateOrEmpty( ); |
Return |
|
getDayOfWeekOrEmpty
It checks that the response is of APItag type, that the node name exists for the response and returns the content. It returns an empty string if no node can be found.
Syntax |
self->getDayOfWeekOrEmpty( ); |
Return |
|
getEmailAddressOrEmpty
It checks that the response is of APItag type, that the node name exists for the response and returns the content. It returns an empty string if no node can be found.
Syntax |
self->getEmailAddressOrEmpty( ); |
Return |
|
getEstimatedWeightOrEmpty
It checks that the response is of APItag type, that the node name exists for the response and returns the content. It returns an empty string if no node can be found.
Syntax |
self->getEstimatedWeightOrEmpty( ); |
Return |
|
getExtensionOrEmpty
It checks that the response is of APItag type, that the node name exists for the response and returns the content. It returns an empty string if no node can be found.
Syntax |
self->getExtensionOrEmpty( ); |
Return |
|
getFirmNameOrEmpty
It checks that the response is of APItag type, that the node name exists for the response and returns the content. It returns an empty string if no node can be found.
Syntax |
$self->getFirmNameOrEmpty( ); |
Return |
|
getFirstNameOrEmpty
It checks that the response is of APItag type, that the node name exists for the response and returns the content. It returns an empty string if no node can be found.
Syntax |
$self->getFirstNameOrEmpty( ); |
Return |
|
getLastNameOrEmpty
It checks that the response is of APItag type, that the node name exists for the response and returns the content. It returns an empty string if no node can be found.
Syntax |
$self->getLastNameOrEmpty( ); |
Return |
|
getPackageLocationOrEmpty
It checks that the response is of APItag type, that the node name exists for the response and returns the content. It returns an empty string if no node can be found.
Syntax |
self->getPackageLocationOrEmpty( ); |
Return |
|
getPackageOrEmpty
It checks that the response is of APItag type, that the node name exists for the response and returns the content. It returns an empty string if no node can be found.
Syntax |
self->getPackageOrEmpty( ); |
Return |
|
getPhoneOrEmpty
It checks that the response is of APItag type, that the node name exists for the response and returns the content. It returns an empty string if no node can be found.
Syntax |
self->getPhoneOrEmpty( ); |
Return |
|
getServiceTypeOrEmpty
It checks that the response is of APItag type, that the node name exists for the response and returns the content. It returns an empty string if no node can be found.
Syntax |
self->getServiceTypeOrEmpty( ); |
Return |
|
getSpecialInstructionsOrEmpty
It checks that the response is of APItag type, that the node name exists for the response and returns the content. It returns an empty string if no node can be found.
Syntax |
self->getSpecialInstructionsOrEmpty( ); |
Return |
|
getStateOrError
It checks that the response is of APItag type, that the node name exists for the response and returns the content. It returns an empty string if no node can be found.
Syntax |
self->getStateOrError( ); |
Return |
|
getSuiteOrAptOrEmpty
It checks that the response is of APItag type, that the node name exists for the response and returns the content. It returns an empty string if no node can be found.
Syntax |
self->getSuiteOrAptOrEmpty( ); |
Return |
|
getUrbanizationOrEmpty
It checks that the response is of APItag type, that the node name exists for the response and returns the content. It returns an empty string if no node can be found.
Syntax |
self->getUrbanizationOrEmpty( ); |
Return |
|
getZipcode4OrEmpty
It checks that the response is of APItag type, that the node name exists for the response and returns the content. It returns an empty string if no node can be found.
Syntax |
self->getZipcode4OrEmpty( ); |
Return |
|
getZipcode5OrError
It checks that the response is of APItag type, that the node name exists for the response and returns the content. It returns an empty string if no node can be found.
Syntax |
self->getZipcode5OrError( ); |
Return |
|
isValidResponseOrError
It checks that the response is of Address Informattion API web service type. If it's not, it throws an error.
Syntax |
$isValid = $self->isValidResponseOrError(); |
Return |
|
new
Creates a new Package Pickup Schedule object .
Syntax |
$PackagePickupSchedule = DE_EPAGES::USPS::API::WebServices::PackagePickupSchedule->new(); |
Input |
|
Return |
|
setAddress
It sets origin address into the request XML structure inside the PackagePickupSchedule object.
Syntax |
$self->setAddress($OriginAddress); |
Input |
|
setCredentials
It sets USPS access credentials for Package Pickup Schedule web services into XML root node as required by USPS.
Syntax |
$self->setCredentials(); |
Input |
|
setPackageLocationOrError
It sets the PAckage location into the request XML structure inside the PackagePickupSchedule object.
Syntax |
$self->setPackageLocationOrError($PackageLocation); |
Input |
|
setPickupSettings
It sets the pickup settings into the request XML structure inside the PackagePickupSchedule object.
Syntax |
$self->setPickupSettings($ShippingLabel); |
Input |
|
setServiceTypeOrError
It sets the service type into the request XML structure inside the PackagePickupSchedule object.
Syntax |
$self->setServiceTypeOrError($ShippingFulfillmentProduct); |
Input |
|
setWeightInOunces
It sets package weight in pounds into the request XML structure inside the PackagePickupSchedule object.
Syntax |
$self->setWeightInOunces($weight, $Unit); |
Input |
|