Address.fetchByVid

The fetchByVid method returns an Address object whose VID matches the input. To update a stored customer address, first load it into your application with this method. The VID you specify as an argument is usually the one you obtain from an Account object.

Input

srd: sparse response description, a SOAP string (which must be a JSON object), in which you specify the elements you want returned.This parameter enables the calling system to constrain a method call to return only components you specify. This gives you greater control over returned content, and improves response time within the Vindicia platform by reducing the processing needed for the call. Some fields are required, either practically or in the WSDL, and will be returned regardless of the srd. A null srd returns the complete response. vid: The Address object’s Vindicia identifier, which serves as the search criterion.

Output

return: an object of type Return that indicates the success or failure of the call. address: the Address object whose VID matches the input.

Returns

In addition to those listed in The Return Object, this call returns:

Return Code	Return String
`400`	One of the following: - `No addresses match VIDinput-vid.` - `Unable to load VID input-vid: error-description.` - `Missing required parameter vid.`

Example

$accountVid = 'MyVindiciaAccountVID';

// Create a SOAP caller object
$addr = new Address();
$addrVID = "14e1dce6f48e901464fce22145982a59642aa9f4";

// now load an address object by VID
$response = $addr->fetchByVid($addrVID);
if($response['returnCode'] == 200) {
$fetchedAddr = $response['data']->address;
}
else {
   // The call was unsuccessful 
   print "Return code: " . $response['returnCode'] . "\n";
   print "Return string: " . $response['returnString'] . "\n";
}

Parent topic:Address Methods

Home

Guides

APIs

Input

Output

Returns

Example

​Input

​Output

​Returns

​Example

Input

Output

Returns

Example