Skip to main content
Vindicia Knowledge Center

NameValuePair.fetchNameValueNames

NameValuePair.fetchNameValueNames

NameValuePair.fetchNameValueNames

fetchNameValueNames accepts one parameter consisting of a type name, which must be one of the strings that fetchNameValueTypes returns. The fetchNameValueNames method returns an array of strings consisting of a list of distinct names from among the name/value pairs that the calling merchant has associated with objects of the given type.

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.

type: the type of object for which the Names should be returned. This may be any of the CashBox objects that reference the NameValuePair object, and includes: Account, AutoBill, BillingPlan,CurrencyAmount, PaymentMethod, Product, TimeInterval, Transaction, or WebSession.

Output

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

names: an array of distinct names from the NameValuePair object associated with the input object.

Returns

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

Return Code

Return String

400

One of the following:

  • Invalid Type.
  • Failed to retrieve name/value names.

Example

$nvp = new NameValuePair();
$response = $nvp->fetchNameValueNames('Account');

if ($response['returnCode'] == 200) {

$names = $response['names];
foreach ($names as $name) {

print "$name\n";

}

}

else {

print "Error: " . $response['returnString'] . "\n";

}

For Users

Learn More
For Users

Cashbox Features

Learn More
Cashbox Features
Back to Top