searchCustomersCount

Parent Previous Next

searchCustomersCount

Search for customers, only return customer counts

 

Description

Identical to the searchCustomers method except only the customer counts are returned. Like searchCustomers, this method returns CustomerSearchResult. The only difference is that CustomerSearchResult.Customers 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.

See also searchCustomers, searchCustomersCustom

 

Syntax

 

CustomerSearchResult searchCustomersCount ( 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

Start position, defaults to 0 (first customer found).

integer

Limit

Maximum number of customers to return in result.

string

Sort

Field name to sort the results by

 

Return Value

 

CustomerSearchResult

Returns results of customer search based on parameters set.

 

Examples

PHP

 

<?php

try {

 $search=array(

   array(

     'Field'=>'amount',  

     'Type'=>'gt',

     'Value'=>'8.00'),

   array(

     'Field'=>'failures',  

     'Type'=>'gt',  

     'Value'=>'0')

   );

 $start=0;

 $limit=10;

 $matchall=true;

 $RefNum=1009411;

 $Sort = "fname";

 $res=$client->searchCustomersCount($token,$search,$matchall,$start,$limit,$Sort);

 print_r($res);              

}

catch (SoapFault $e) {

 die("Search Customers failed :" .$e->getMessage());

}

?>

 

 

.NET VB

 

Dim matchAll As Boolean

       matchAll = True

       Dim search(0) As eBizCharge.SearchParam

       search(0) = New eBizCharge.SearchParam()

       search(0).Field = "Created"

       search(0).Type = "Contains"

       search(0).Value = "2010-09-09"

       Dim response As eBizCharge.CustomerSearchResult = New eBizCharge.CustomerSearchResult

       response = client.searchCustomersCount(token, search, matchAll, "0", "10", "fname")

       MsgBox(response.CustomersMatched)

 

 

.NET C#

 

           Boolean matchAll;

           matchAll = true;

           string[] fields = new string[3];

           eBizCharge.SearchParam[] search = new eBizCharge.SearchParam[2];

           search[0] = new eBizCharge.SearchParam();

           search[0].Field = "Created";

           search[0].Type = "Contains";

           search[0].Value = "2010-08-10";

           eBizCharge.CustomerSearchResult response = new eBizCharge.CustomerSearchResult();

           try

           {

               response = client.searchCustomersCount(token, search, matchAll, "0", "10", "fname");

               MessageBox.Show(response.CustomersMatched);

           }

           catch (Exception err)

           {

               MessageBox.Show(err.Message);

           }

: