searchBatchesCount

Search previously settled batches, return only counts

Description

Identical to the searchBatches method except only the batch counts are returned. Like searchBatches, this method returns BatchSearchResult. The only difference is that BatchSearchResult.Batches is left empty. This method provides a quicker way to determine the size of the result set before starting to retrieve the full search results.

Syntax

BatchSearchResult searchBatchesCount ( ueSecurityToken Token, SearchParam Search, boolean MatchAll, integer Start, integer Limit, string Sort)

Arguments

Type	Name	Description
ueSecurityToken	Token	Merchant security token: used to identify merchant and validate transaction.
SearchParam	Search	Array of search parameters
boolean	MatchAll	If set to “true,” only results matching all search criteria will be returned, if set to “false,” results matching any of the search criteria will be returned.
integer	Start	Index to start returning batches from.
integer	Limit	Max number of batches to return in result set.
string	Sort	Field name to sort the results by

Return Value

BatchSearchResult

Returns the result of the batch search based on the search parameters set.

Examples

PHP

For directions on how to set up the WSDL link, create “$token” and “$client”, go to PHP Soap How-to.

<?php
 
try {
 
// make sure you have prepared data to search on
 
  $search=array(
    array(
      'Field'=>'closed', 
      'Type'=>'gt',
      'Value'=>'2007-04-01'),
    );
  $start=0;
  $limit=100;
  $matchall=true;
  $sort='closed';
 
  $res=$client->searchBatchesCount($token,$search,$matchall,$start,$limit,$sort);
 
  print_r($res);
} 
 
catch (SoapFault $e) {
 
  echo $client->__getLastRequest();
  echo $client->__getLastResponse();
  die("Search batches failed failed :" .$e->getMessage());
 
}
 
?>

Java

This example uses the USAePay Java library. For directions on how to install the library and create the token/client objects, go to either the Java JAX-RPC Howto or the Java JAX-WS Howto.

try {
 
SearchParamArray searchParams = new SearchParamArray();
searchParams.add(new SearchParam("Sequence","eq", "123456"));
BigInteger start = new BigInteger("0");
BigInteger limit = new BigInteger("9999999");
 
 
BatchSearchResult BatchResult = new BatchSearchResult();
BatchResult = client.searchBatchesCount(token, searchParams, true, start, limit, "Sequence");
 
 
  System.out.println(BatchResult.getBatchesMatched());
} catch (Exception e) {
    System.out.println("Soap Exception: " + e.getMessage());
}

XML

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:ns1="urn:usaepay" xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" 
SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<SOAP-ENV:Body>
<ns1:searchBatchesCount>
<Token xsi:type="ns1:ueSecurityToken">
<ClientIP xsi:type="xsd:string">192.168.0.1</ClientIP>
<PinHash xsi:type="ns1:ueHash">
<HashValue xsi:type="xsd:string">3b129d9b5229387ad6b5e2e6af0abbab441b1153</HashValue>
<Seed xsi:type="xsd:string">11937833911067914168</Seed>
<Type xsi:type="xsd:string">sha1</Type>
</PinHash>
<SourceKey xsi:type="xsd:string">HB4P7C4K2w2ZCQQQXRqrxDj6agrS2NIT</SourceKey>
</Token>
<Search SOAP-ENC:arrayType="ns1:SearchParam[1]" xsi:type="ns1:SearchParamArray">
<item xsi:type="ns1:SearchParam">
<Field xsi:type="xsd:string">closed</Field>
<Type xsi:type="xsd:string">gt</Type>
<Value xsi:type="xsd:string">2007-04-01</Value>
</item>
</Search>
<MatchAll xsi:type="xsd:boolean">true</MatchAll>
<Start xsi:type="xsd:integer">0</Start>
<Limit xsi:type="xsd:integer">5</Limit>
<Sort xsi:type="xsd:string">closed</Sort>
</ns1:searchBatchesCount>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Change History

Version	Change
1.2	Method added in soap 1.2 release

Table of Contents