developer:soap:methods:searchmerchantscustom

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
developer:soap:methods:searchmerchantscustom [2009/07/24 00:00]
tem
developer:soap:methods:searchmerchantscustom [2009/07/27 08:24] (current)
tem
Line 1: Line 1:
-<embed ..:contents />====== searchMerchantsCustom ======+<embed ..:​contents/>​
  
 +====== searchMerchantsCustom ======
  
 **Reseller only method.** **Reseller only method.**
Line 11: Line 12:
  
 See also [[getMerchant]],​ [[updateMerchant]],​ [[getMerchantSummary]],​ [[searchMerchantsCount]] See also [[getMerchant]],​ [[updateMerchant]],​ [[getMerchantSummary]],​ [[searchMerchantsCount]]
 +
 ===== Search Fields ===== ===== Search Fields =====
  
Line 19: Line 21:
   * Company ​   * Company ​
   * Street ​   * Street ​
-  * Street 2 +  * Street2 ​
   * City    * City 
   * State    * State 
Line 25: Line 27:
   * Email    * Email 
   * Fax    * Fax 
-  * Phone Number ​+  * Phone 
  
  
 ===== Syntax ===== ===== Syntax =====
  
-string **searchMerchantsCustom** (  +string **searchMerchants** ( [[..:​objects:​ueSecurityToken]] Token, [[..:​objects:​SearchParam]] Search, boolean MatchAll, integer Start, integer Limit, string FieldList, string Format, string Sort) 
-[[..:​objects:​ueSecurityToken]] Token, ​ +
-[[..:​objects:​SearchParam]] Search, ​ +
-boolean MatchAll, ​ +
-integer Start, integer Limit, string FieldList, string Format, string Sort)  +
  
 ===== Arguments ===== ===== Arguments =====
  
 ^Type   ​^Name ​  ​^Description ​  ^ ^Type   ​^Name ​  ​^Description ​  ^
-| [[..:​objects:​ueSecurityToken]] | Token  |Merchant ​security tokenused to identify ​merchant ​and validate ​transaction. | +|[[..:​objects:​ueSecurityToken]] |Token |Reseller ​security tokenused to identify ​reseller ​and validate ​request.| 
-| [[..:​objects:​SearchParam]] ​ | Search ​ | Array of search parameters ​(SearchParam objects) available. | +|[[..:​objects:​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. | +|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 | Sequence number ​to start returning on. | +|integer |Start |Start position, defaults ​to 0 (first merchant found).| 
-| integer | Limit | Maximum number of transactions ​to return in result ​set. | +|integer |Limit |Maximum number of merchants ​to return in result. | 
-| string ​ | FieldList | String Array of fields to return in search. | +|string ​ |FieldList | String Array of fields to return in search. | 
-| string ​ | Format | Specify format of return data. Possible formats include: csv, tab, xml. | +|string ​ |Format | Specify format of return data. Possible formats include: csv, tab, xml. | 
-| string ​ | Sort | Field name to sort results by |+|string |Sort |Field name to sort the results by | 
  
  
 ===== Return Value ===== ===== Return Value =====
  
-| string | Base64 encode result set. Returns all of the fields from any transactions ​matching your search parameters. | +| string | Base64 encode result set. Returns all of the fields from any merchants ​matching your search parameters. | 
  
  
 ===== Examples ===== ===== Examples =====
  
- 
-==== PHP ==== 
- 
-For directions on how to set up the WSDL link, create "​$token"​ and "​$client",​ go to [[developer:​soap:​howto:​php|PHP Soap How-to]]. 
- 
-<code php> 
-<?​php ​ 
- 
-try {  
-  $search=array( 
-    array('​Field'​=>'​Activated',​ '​Type'​=>'​gt','​Value'​=>'​2001-09-01 00:​00:​00'​),​ 
-  ); 
-  $start=0; 
-  $limit=2; 
-  $matchall=true;​ 
-  $fieldList=array('​MerchID','​Activated'​);​ 
-  $format ='​csv';​ //​Specify format of return data: csv, tab, xml  
-  $sortby='​merchid';​ 
- 
-  $res=$client->​searchMerchantsCustom($restoken,​$search,​$matchall,​$start,​$limit,​ $fieldList, $format, $sortby); 
-  print_r($res);​ 
-  
- 
- 
-catch(SoapFault $e) {  
-  echo $client->​__getLastResponse(); ​ 
-  die("​Search Merchants Failed :"​.$e->​getMessage()); ​ 
- 
- 
-?>  
-</​code>​ 
  
  
developer/soap/methods/searchmerchantscustom.txt · Last modified: 2009/07/27 08:24 by tem

Page Tools