Skip to main content
Vindicia Knowledge Center

Account.fetchByEmail

Account.fetchByEmail

Account.fetchByEmail

The fetchByEmail method returns an Account object whose email address matches the input. If you use an email address as an identifier for your customers, you may call this method to retrieve 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.

emailAddress: the Account object’s email address, which serves as the search criterion.

Output

return: an object of type Return that indicates the success or failure of the call.

accounts: the most recently modified Account object whose email address matches the input.

Returns

In addition to those listed in Standard Return Codes, this call returns:

Return Code

Return String

400

Must specify email address to load by!

404

One of the following:

  • Unable to load account by emailAddress input-emailAddress: No match.
  • No AutoBills found for email address input-emailAddress: No match.
  • Unable to load account by email address input-emailAddress: No match.

Example

// Create an account object to make the SOAP call

$account = new Account();

// now load a customer account into the account object

$response = $account->fetchByEmail('somebody@yahoo.com');
if($response['returnCode'] == 200) {

$fetchedAccount = $response['data']->account;

foreach $fetchedAcct ($fetchedAccount) {

// process a fetched account

}

}

else {

// The call was unsuccessful

print "Return code: " . $response['returnCode'] . "\n";
print "Return string: " . $response['returnString'] . "\n";

}

For Users

Learn More
For Users

Cashbox Features

Learn More
Cashbox Features
Back to Top