AddressServiceSoap Class Reference

Inheritance diagram for AddressServiceSoap:

Collaboration diagram for AddressServiceSoap:

Public Member Functions
	__construct ($configurationName= 'Default')
	isAuthorized ($operations)
	ping ($message= '')
	validate ($validateRequest)
Public Member Functions inherited from AvalaraSoapClient
	__getLastRequest ()
	__getLastResponse ()
	__getLastRequestHeaders ()
	__getLastResponseHeaders ()

Static Protected Attributes
static	$classmap

Static Private Attributes
static	$servicePath = '/Address/AddressSvc.asmx'

Additional Inherited Members
Protected Attributes inherited from AvalaraSoapClient
	$client

Constructor & Destructor Documentation

AddressServiceSoap::__construct

(

$configurationName = 'Default'

)

Construct a proxy for Avalara's Address Web Service using the default URL as coded in the class or programatically set.

Example:

 $port = new AddressServiceSoap();
 $port->ping();

See also

AvalaraSoapClient

TaxServiceSoap

Member Function Documentation

AddressServiceSoap::isAuthorized

(

$operations

)

Checks authentication of and authorization to one or more operations on the service.

This operation allows pre-authorization checking of any or all operations. It will return a comma delimited set of operation names which will be all or a subset of the requested operation names. For security, it will never return operation names other than those requested (no phishing allowed).

Example:
isAuthorized("GetTax,PostTax")

Parameters

string

$operations

a comma-delimited list of operation names

Returns

IsAuthorizedResult

Exceptions

SoapFault

AddressServiceSoap::ping

(

$message = ''

)

Verifies connectivity to the web service and returns version information about the service.

NOTE:This replaces TestConnection and is available on every service.

Parameters

string

$message

for future use

Returns

PingResult

Exceptions

SoapFault

AddressServiceSoap::validate

(

$validateRequest

)

Validates an address and returns a normalized address or error. ValidAddress objects in a ValidateResult object.

Takes an Address, an optional TextCase property that determines the casing applied to a validated address. It defaults to TextCase::$Default. Example:

$port = new AddressServiceSoap();

$address = new Address();
$address->setLine1("900 Winslow Way");
$address->setLine2("Suite 130");
$address->setCity("Bainbridge Is");
$address->setRegion("WA");
$address->setPostalCode("98110-2450");

$result = $port->validate(new ValidateRequest($address,TextCase::$Upper));

Parameters

ValidateRequest

Returns

ValidateResult

Exceptions

SoapFault

Member Data Documentation

AddressServiceSoap::$classmap

staticprotected

Initial value:

= array(
                                    'Validate' => 'Validate',
                                    'BaseRequest' => 'BaseRequest',
                                    'ValidateRequest' => 'ValidateRequest',
                                    'BaseAddress' => 'BaseAddress',
                                    'ValidAddress' => 'ValidAddress',
                                    'TextCase' => 'TextCase',                                    
                                    'ValidateResult' => 'ValidateResult',                                    
                                    'BaseResult' => 'BaseResult',
                                    'SeverityLevel' => 'SeverityLevel',
                                    'Message' => 'Message',
                                    'Profile' => 'Profile',
                                    'Ping' => 'Ping',                                    
                                    'PingResult' => 'PingResult',
                                    'IsAuthorized' => 'IsAuthorized',                                    
                                    'IsAuthorizedResult' => 'IsAuthorizedResult')

AddressServiceSoap::$servicePath = '/Address/AddressSvc.asmx'

staticprivate

---

The documentation for this class was generated from the following file:

• plugins/vmcalculation/avalara/classes/AddressServiceSoap.class.php