developer:soap-1.6:objects:customersearchresult

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

developer:soap-1.6:objects:customersearchresult [2012/08/04 11:38] (current)
tem created
Line 1: Line 1:
 +<embed ..:​contents/>​====== CustomerSearchResult ======
 +
 +Contains customer search data.
 +
 +===== Description =====
 +
 +This object is returned by the [[..:​methods:​searchCustomers]] method. It describes the result of the search, including the total number of customers matched, the number being returned, and an array of CustomerObjects.
 +
 +
 +===== Properties =====
 +
 +^Type    ^Name    ^Description ​      ^
 +|integer |CustomersMatched |Total number of customers matched by search criteria.|
 +|integer |CustomersReturned |Total number of customers contained in search result.|
 +|integer |StartIndex |The index where this result set begins (default is 0).|
 +|integer |Limit |The maximum number of customers to be returned in the search.|
 +|[[..:​objects:​customerobject|CustomerObject]] |Customers |An array of CustomerObjects matched by search criteria.|
 +
 +
 +===== Places Used =====
 +
 +[[..:​methods:​searchCustomers]] ​
 +
 +===== Examples =====
 +
 +==== .NET VB ====
 +<code vb>
 +Dim response As usaepay.CustomerSearchResult = New usaepay.CustomerSearchResult
 + 
 +        response = client.searchCustomers(token,​ search, matchAll, "​0",​ "​10",​ "​fname"​)
 +        MsgBox(response.CustomersMatched)
 +</​code>​
 +
 +==== .NET C# ====
 +<code c>
 +usaepay.CustomerSearchResult response = new usaepay.CustomerSearchResult();​
 + 
 +            try
 +            {
 +                response = client.searchCustomers(token,​ search, matchAll, "​0",​ "​10",​ "​fname"​);​
 + 
 +                MessageBox.Show(response.CustomersMatched);​
 + 
 +            }
 +
 +</​code>​
 +
 +===== Change History =====
 +
 +^ Version ^ Change ^
 +| [[developer:​soap-1.1:​objects:​customersearchresult|1.1]] | Method added prior to soap-1.1 |
  
developer/soap-1.6/objects/customersearchresult.txt ยท Last modified: 2012/08/04 11:38 by tem

Page Tools