{"_id":"5632a5e849e16d0d00122479","version":{"_id":"5632a5e549e16d0d00122443","__v":6,"project":"55b933b3146ef121002158d3","createdAt":"2015-10-29T23:04:05.701Z","releaseDate":"2015-10-29T23:04:05.701Z","categories":["5632a5e749e16d0d00122444","5632a5e749e16d0d00122445","5632a5e749e16d0d00122446","5632a5e749e16d0d00122447","5632a5e749e16d0d00122448","5632a5e749e16d0d00122449","5632a5e749e16d0d0012244a","5632a5e749e16d0d0012244b","5632a5e749e16d0d0012244c","5632a5e749e16d0d0012244d","5632a5e749e16d0d0012244e","5632a5e749e16d0d0012244f","5632a5e749e16d0d00122450","5632b179df556c0d00cd095b","564e13053b2b4a19000cd69b","59caa9df65accc001a489c95","59cab50965accc001a489d28","59cadd464ab7b70024378e74"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.1.0","version":"1.1"},"__v":0,"user":"55b932ba8fd1a02b00f496c8","category":{"_id":"5632a5e749e16d0d00122448","version":"5632a5e549e16d0d00122443","__v":1,"pages":["5632a5e849e16d0d00122478","5632a5e849e16d0d00122479","5632a5e849e16d0d0012247a","5632a5e849e16d0d0012247b","5632a5e849e16d0d0012247c"],"project":"55b933b3146ef121002158d3","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-03T18:10:18.431Z","from_sync":false,"order":6,"slug":"credit-card-batches","title":"Credit Card Batches"},"githubsync":"","project":"55b933b3146ef121002158d3","parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-03T18:10:50.515Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"Search previously settled batches, return only counts\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Description\"\n}\n[/block]\nIdentical to the [searchBatches](/docs/searchbatches) method except only the batch counts are returned. Like searchBatches, this method returns [BatchSearchResult](/docs/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.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Syntax\"\n}\n[/block]\n[BatchSearchResult](/docs/batchsearchresult) **searchBatchesCount** ( [ueSecurityToken](/docs/uesecuritytoken) Token, SearchParam Search, boolean MatchAll, integer Start, integer Limit, string Sort)\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Arguments\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Type\",\n    \"h-1\": \"Name\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"[ueSecurityToken](/docs/uesecuritytoken)\",\n    \"0-1\": \"Token\",\n    \"0-2\": \"Merchant security token: used to identify merchant and validate transaction.\",\n    \"1-0\": \"[SearchParam](/docs/searchparam)\",\n    \"1-1\": \"Search\",\n    \"1-2\": \"Array of search parameters\",\n    \"2-0\": \"boolean\",\n    \"2-1\": \"MatchAll\",\n    \"2-2\": \"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.\",\n    \"3-0\": \"integer\",\n    \"3-1\": \"Start\",\n    \"3-2\": \"Index to start returning batches from.\",\n    \"4-0\": \"integer\",\n    \"4-1\": \"Limit\",\n    \"4-2\": \"Max number of batches to return in result set.\",\n    \"5-0\": \"string\",\n    \"5-1\": \"Sort\",\n    \"5-2\": \"Field name to sort the results by\"\n  },\n  \"cols\": 3,\n  \"rows\": 6\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Return Value\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-1\": \"Returns the result of the batch search based on the search parameters set.\",\n    \"0-0\": \"[BatchSearchResult](/docs/batchsearchresult)\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Examples\"\n}\n[/block]\n## PHP \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?php\\ntry {\\n// make sure you have prepared data to search on\\n $search=array(\\n   array(\\n     'Field'=>'closed',\\n     'Type'=>'gt',\\n     'Value'=>'2007-04-01'),\\n   );\\n $start=0;\\n $limit=100;\\n $matchall=true;\\n $sort='closed';\\n $res=$client->searchBatchesCount($token,$search,$matchall,$start,$limit,$sort);\\n print_r($res);\\n}\\ncatch (SoapFault $e) {\\n echo $client->__getLastRequest();\\n echo $client->__getLastResponse();\\n die(\\\"Search batches failed failed :\\\" .$e->getMessage());\\n}\\n?>\",\n      \"language\": \"php\"\n    }\n  ]\n}\n[/block]\n## Java \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"try {\\nSearchParamArray searchParams = new SearchParamArray();\\nsearchParams.add(new SearchParam(\\\"Sequence\\\",\\\"eq\\\", \\\"123456\\\"));\\nBigInteger start = new BigInteger(\\\"0\\\");\\nBigInteger limit = new BigInteger(\\\"9999999\\\");\\nBatchSearchResult BatchResult = new BatchSearchResult();\\nBatchResult = client.searchBatchesCount(token, searchParams, true, start, limit, \\\"Sequence\\\");\\n System.out.println(BatchResult.getBatchesMatched());\\n} catch (Exception e) {\\n   System.out.println(\\\"Soap Exception: \\\" + e.getMessage());\\n}\",\n      \"language\": \"java\"\n    }\n  ]\n}\n[/block]\n## Visual Basic (.Net)\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Dim client As eBizCharge.eBizChargeService = New eBizCharge.eBizChargeService\\n       Dim token As eBizCharge.ueSecurityToken\\n       token = Me.CreateToken(\\\"O79erw1433ZBIE0O4Pv25aVDnw3qDVc8\\\", \\\"1234\\\")\\n       Dim matchAll As Boolean\\n       matchAll = True\\n       Dim start As String\\n       Dim limit As String\\n       Dim sort As String\\n       start = \\\"0\\\"\\n       limit = \\\"10\\\"\\n       sort = \\\"closed\\\"\\n       Dim search(0 To 1) As eBizCharge.SearchParam\\n       search(0) = New eBizCharge.SearchParam\\n       search(0).Field = \\\"closed\\\"\\n       search(0).Type = \\\"gt\\\"\\n       search(0).Value = \\\"2010-08-05\\\"\\n       Dim result As eBizCharge.BatchSearchResult = New eBizCharge.BatchSearchResult\\n       result = client.searchBatchesCount(token, search, matchAll, start, limit, sort)\\n       MsgBox(result.BatchesMatched)\",\n      \"language\": \"c\"\n    }\n  ]\n}\n[/block]\n## C Sharp (.Net)\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Boolean matchAll;\\n           matchAll = true;\\n           string start = \\\"0\\\";\\n           string limit = \\\"10\\\";\\n           string sort = \\\"closed\\\";\\n           string[] fields = new string[3];\\n           eBizCharge.SearchParam[] search = new eBizCharge.SearchParam[2];\\n           search[0] = new eBizCharge.SearchParam();\\n           search[0].Field = \\\"Closed\\\";\\n           search[0].Type = \\\"gt\\\";\\n           search[0].Value = \\\"2010-08-05\\\";\\n           eBizCharge.BatchSearchResult result = new eBizCharge.BatchSearchResult();\\n           try\\n           {\\n               result = client.searchBatchesCount(token, search, matchAll, start, limit, sort);\\n               MessageBox.Show(string.Concat(result.BatchesMatched));\\n           }\\n           catch (Exception err)\\n           {\\n               MessageBox.Show(err.Message);\\n           }\\n       }\",\n      \"language\": \"csharp\"\n    }\n  ]\n}\n[/block]\n## XML \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n<SOAP-ENV:Envelope xmlns:SOAP-ENV=\\\"http://schemas.xmlsoap.org/soap/envelope/\\\"\\nxmlns:ns1=\\\"urn:eBizCharge\\\" xmlns:xsd=\\\"http://www.w3.org/2001/XMLSchema\\\"\\nxmlns:xsi=\\\"http://www.w3.org/2001/XMLSchema-instance\\\"\\nxmlns:SOAP-ENC=\\\"http://schemas.xmlsoap.org/soap/encoding/\\\"\\nSOAP-ENV:encodingStyle=\\\"http://schemas.xmlsoap.org/soap/encoding/\\\">\\n<SOAP-ENV:Body>\\n<ns1:searchBatchesCount>\\n<Token xsi:type=\\\"ns1:ueSecurityToken\\\">\\n<ClientIP xsi:type=\\\"xsd:string\\\">192.168.0.1</ClientIP>\\n<PinHash xsi:type=\\\"ns1:ueHash\\\">\\n<HashValue xsi:type=\\\"xsd:string\\\">11ac55b0a0b59f8f028dbf85bc32266fa973dd0e</HashValue>\\n<Seed xsi:type=\\\"xsd:string\\\">12678150211876663375</Seed>\\n<Type xsi:type=\\\"xsd:string\\\">sha1</Type>\\n</PinHash>\\n<SourceKey xsi:type=\\\"xsd:string\\\">HB4P7C4K2w2ZCQQQXRqrxDj6agrS2NIT</SourceKey>\\n</Token>\\n<Search SOAP-ENC:arrayType=\\\"ns1:SearchParam[1]\\\" xsi:type=\\\"ns1:SearchParamArray\\\">\\n<item xsi:type=\\\"ns1:SearchParam\\\">\\n<Field xsi:type=\\\"xsd:string\\\">closed</Field>\\n<Type xsi:type=\\\"xsd:string\\\">gt</Type>\\n<Value xsi:type=\\\"xsd:string\\\">2007-04-01</Value>\\n</item>\\n</Search>\\n<MatchAll xsi:type=\\\"xsd:boolean\\\">true</MatchAll>\\n<Start xsi:type=\\\"xsd:integer\\\">0</Start>\\n<Limit xsi:type=\\\"xsd:integer\\\">5</Limit>\\n<Sort xsi:type=\\\"xsd:string\\\">closed</Sort>\\n</ns1:searchBatchesCount>\\n</SOAP-ENV:Body>\\n</SOAP-ENV:Envelope>\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"searchbatchescount","type":"basic","title":"searchBatchesCount"}

searchBatchesCount


Search previously settled batches, return only counts [block:api-header] { "type": "basic", "title": "Description" } [/block] Identical to the [searchBatches](/docs/searchbatches) method except only the batch counts are returned. Like searchBatches, this method returns [BatchSearchResult](/docs/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. [block:api-header] { "type": "basic", "title": "Syntax" } [/block] [BatchSearchResult](/docs/batchsearchresult) **searchBatchesCount** ( [ueSecurityToken](/docs/uesecuritytoken) Token, SearchParam Search, boolean MatchAll, integer Start, integer Limit, string Sort) [block:api-header] { "type": "basic", "title": "Arguments" } [/block] [block:parameters] { "data": { "h-0": "Type", "h-1": "Name", "h-2": "Description", "0-0": "[ueSecurityToken](/docs/uesecuritytoken)", "0-1": "Token", "0-2": "Merchant security token: used to identify merchant and validate transaction.", "1-0": "[SearchParam](/docs/searchparam)", "1-1": "Search", "1-2": "Array of search parameters", "2-0": "boolean", "2-1": "MatchAll", "2-2": "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.", "3-0": "integer", "3-1": "Start", "3-2": "Index to start returning batches from.", "4-0": "integer", "4-1": "Limit", "4-2": "Max number of batches to return in result set.", "5-0": "string", "5-1": "Sort", "5-2": "Field name to sort the results by" }, "cols": 3, "rows": 6 } [/block] [block:api-header] { "type": "basic", "title": "Return Value" } [/block] [block:parameters] { "data": { "0-1": "Returns the result of the batch search based on the search parameters set.", "0-0": "[BatchSearchResult](/docs/batchsearchresult)" }, "cols": 2, "rows": 1 } [/block] [block:api-header] { "type": "basic", "title": "Examples" } [/block] ## PHP [block:code] { "codes": [ { "code": "<?php\ntry {\n// make sure you have prepared data to search on\n $search=array(\n array(\n 'Field'=>'closed',\n 'Type'=>'gt',\n 'Value'=>'2007-04-01'),\n );\n $start=0;\n $limit=100;\n $matchall=true;\n $sort='closed';\n $res=$client->searchBatchesCount($token,$search,$matchall,$start,$limit,$sort);\n print_r($res);\n}\ncatch (SoapFault $e) {\n echo $client->__getLastRequest();\n echo $client->__getLastResponse();\n die(\"Search batches failed failed :\" .$e->getMessage());\n}\n?>", "language": "php" } ] } [/block] ## Java [block:code] { "codes": [ { "code": "try {\nSearchParamArray searchParams = new SearchParamArray();\nsearchParams.add(new SearchParam(\"Sequence\",\"eq\", \"123456\"));\nBigInteger start = new BigInteger(\"0\");\nBigInteger limit = new BigInteger(\"9999999\");\nBatchSearchResult BatchResult = new BatchSearchResult();\nBatchResult = client.searchBatchesCount(token, searchParams, true, start, limit, \"Sequence\");\n System.out.println(BatchResult.getBatchesMatched());\n} catch (Exception e) {\n System.out.println(\"Soap Exception: \" + e.getMessage());\n}", "language": "java" } ] } [/block] ## Visual Basic (.Net) [block:code] { "codes": [ { "code": "Dim client As eBizCharge.eBizChargeService = New eBizCharge.eBizChargeService\n Dim token As eBizCharge.ueSecurityToken\n token = Me.CreateToken(\"O79erw1433ZBIE0O4Pv25aVDnw3qDVc8\", \"1234\")\n Dim matchAll As Boolean\n matchAll = True\n Dim start As String\n Dim limit As String\n Dim sort As String\n start = \"0\"\n limit = \"10\"\n sort = \"closed\"\n Dim search(0 To 1) As eBizCharge.SearchParam\n search(0) = New eBizCharge.SearchParam\n search(0).Field = \"closed\"\n search(0).Type = \"gt\"\n search(0).Value = \"2010-08-05\"\n Dim result As eBizCharge.BatchSearchResult = New eBizCharge.BatchSearchResult\n result = client.searchBatchesCount(token, search, matchAll, start, limit, sort)\n MsgBox(result.BatchesMatched)", "language": "c" } ] } [/block] ## C Sharp (.Net) [block:code] { "codes": [ { "code": "Boolean matchAll;\n matchAll = true;\n string start = \"0\";\n string limit = \"10\";\n string sort = \"closed\";\n string[] fields = new string[3];\n eBizCharge.SearchParam[] search = new eBizCharge.SearchParam[2];\n search[0] = new eBizCharge.SearchParam();\n search[0].Field = \"Closed\";\n search[0].Type = \"gt\";\n search[0].Value = \"2010-08-05\";\n eBizCharge.BatchSearchResult result = new eBizCharge.BatchSearchResult();\n try\n {\n result = client.searchBatchesCount(token, search, matchAll, start, limit, sort);\n MessageBox.Show(string.Concat(result.BatchesMatched));\n }\n catch (Exception err)\n {\n MessageBox.Show(err.Message);\n }\n }", "language": "csharp" } ] } [/block] ## XML [block:code] { "codes": [ { "code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<SOAP-ENV:Envelope xmlns:SOAP-ENV=\"http://schemas.xmlsoap.org/soap/envelope/\"\nxmlns:ns1=\"urn:eBizCharge\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"\nxmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\nxmlns:SOAP-ENC=\"http://schemas.xmlsoap.org/soap/encoding/\"\nSOAP-ENV:encodingStyle=\"http://schemas.xmlsoap.org/soap/encoding/\">\n<SOAP-ENV:Body>\n<ns1:searchBatchesCount>\n<Token xsi:type=\"ns1:ueSecurityToken\">\n<ClientIP xsi:type=\"xsd:string\">192.168.0.1</ClientIP>\n<PinHash xsi:type=\"ns1:ueHash\">\n<HashValue xsi:type=\"xsd:string\">11ac55b0a0b59f8f028dbf85bc32266fa973dd0e</HashValue>\n<Seed xsi:type=\"xsd:string\">12678150211876663375</Seed>\n<Type xsi:type=\"xsd:string\">sha1</Type>\n</PinHash>\n<SourceKey xsi:type=\"xsd:string\">HB4P7C4K2w2ZCQQQXRqrxDj6agrS2NIT</SourceKey>\n</Token>\n<Search SOAP-ENC:arrayType=\"ns1:SearchParam[1]\" xsi:type=\"ns1:SearchParamArray\">\n<item xsi:type=\"ns1:SearchParam\">\n<Field xsi:type=\"xsd:string\">closed</Field>\n<Type xsi:type=\"xsd:string\">gt</Type>\n<Value xsi:type=\"xsd:string\">2007-04-01</Value>\n</item>\n</Search>\n<MatchAll xsi:type=\"xsd:boolean\">true</MatchAll>\n<Start xsi:type=\"xsd:integer\">0</Start>\n<Limit xsi:type=\"xsd:integer\">5</Limit>\n<Sort xsi:type=\"xsd:string\">closed</Sort>\n</ns1:searchBatchesCount>\n</SOAP-ENV:Body>\n</SOAP-ENV:Envelope>", "language": "xml" } ] } [/block]