Package DE_EPAGES::USPS::API::WebServices::PackagePickupCancel
It collects (XML) information required to generate USPS Package Pickup Cancel requests and processes responses
Functions
- callWebService
- feedRequest
- getAddress2OrError
- getCityOrError
- getConfirmationNumberOrEmpty
- getFirmNameOrEmpty
- getStateOrError
- getStatusOrEmpty
- getSuiteOrAptOrEmpty
- getUrbanizationOrEmpty
- getZipcode4OrEmpty
- getZipcode5OrError
- isValidResponseOrError
- new
- setAddress
- setConfirmationNumber
- setCredentials
callWebService
It arranges the log filter and calls the web service through the common interface.
Syntax |
$self->callWebService(); |
feedRequest
It feeds USPS PackagePickupCancel object, ready to use the web service call.
Syntax |
$self->feedRequest($ShippingLabel); |
Input |
|
getAddress2OrError
It checks that the label node exists for the response and returns the content. It throws an error if no label can be found.
Syntax |
getAddress2OrError( ); |
Return |
|
getCityOrError
It checks that the label node exists for the response and returns the content. It throws an error if no label can be found.
Syntax |
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 |
getConfirmationNumberOrEmpty( ); |
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 |
getFirmNameOrEmpty( ); |
Return |
|
getStateOrError
It checks that the label node exists for the response and returns the content. It throws an error if no label can be found.
Syntax |
getStateOrError( ); |
Return |
|
getStatusOrEmpty
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 |
getStatusOrEmpty( ); |
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 |
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 |
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 |
getZipcode4OrEmpty( ); |
Return |
|
getZipcode5OrError
It checks that the label node exists for the response and returns the content. It throws an error if no label can be found.
Syntax |
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 Cancel object.
Syntax |
$PackagePickupCancel = DE_EPAGES::USPS::API::WebServices::PackagePickupCancel->new(); |
Input |
|
Return |
|
setAddress
It sets origin address into the request XML structure inside the PackagePickupCancel object.
Syntax |
$self->setAddress($OriginAddress); |
Input |
|
setConfirmationNumber
It sets USPS Confirmation Number for Package Pickup Cancel web services into XML root node as required by USPS.
Syntax |
$self->setConfirmationNumber(); |
Input |
|
setCredentials
It sets USPS access credentials for Package Pickup Cancel web services into XML root node as required by USPS.
Syntax |
$self->setCredentials($Username, $Password); |
Input |
|