{"_id":"5632a5ea49e16d0d00122484","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"},"githubsync":"","__v":0,"category":{"_id":"5632a5e749e16d0d0012244d","__v":1,"pages":["5632a5ea49e16d0d00122481","5632a5ea49e16d0d00122482","5632a5ea49e16d0d00122483","5632a5ea49e16d0d00122484","5632a5ea49e16d0d00122485","5632a5ea49e16d0d00122486","5632a5ea49e16d0d00122487","5632a5ea49e16d0d00122488","5632a5ea49e16d0d00122489","5632a5ea49e16d0d0012248a","5632a5ea49e16d0d0012248b","5632a5ea49e16d0d0012248c","5632a5ea49e16d0d0012248d","5632a5ea49e16d0d0012248e","5632a5ea49e16d0d0012248f","5632a5ea49e16d0d00122490","5632a5ea49e16d0d00122491","5632a5ea49e16d0d00122492","5632a5ea49e16d0d00122493","5632a5ea49e16d0d00122494","5632a5ea49e16d0d00122495","5632a5ea49e16d0d00122496","5632a5ea49e16d0d00122497","5632a5ea49e16d0d00122498","5632a5ea49e16d0d00122499","5632a5ea49e16d0d0012249a","5632a5ea49e16d0d0012249b","5632a5ea49e16d0d0012249c","5632a5ea49e16d0d0012249d","5632a5ea49e16d0d0012249e","5632a5ea49e16d0d0012249f","5632a5ea49e16d0d001224a0","5632a5ea49e16d0d001224a1","5632a5ea49e16d0d001224a2","5632a5ea49e16d0d001224a3","5632a5ea49e16d0d001224a4","5632a5ea49e16d0d001224a5","5632a5ea49e16d0d001224a6","5632a5ea49e16d0d001224a7"],"project":"55b933b3146ef121002158d3","version":"5632a5e549e16d0d00122443","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-04T17:34:02.800Z","from_sync":false,"order":12,"slug":"objects","title":"Objects"},"project":"55b933b3146ef121002158d3","user":"55b932ba8fd1a02b00f496c8","parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-04T17:50:23.282Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":3,"body":"Contains results of a batch search.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Description\"\n}\n[/block]\nThis object is returned by the [searchBatches](/docs/searchbatches) method. It describes the result of the search, including the total number of batches matched, the number being returned, and an array of BatchStatus objects.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Properties\"\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\": \"integer\",\n    \"0-1\": \"BatchesMatched\",\n    \"0-2\": \"Total number of batches matched\",\n    \"1-0\": \"integer\",\n    \"1-1\": \"BatchesReturned\",\n    \"1-2\": \"Number of batches returned in this result set\",\n    \"2-0\": \"integer\",\n    \"2-1\": \"StartIndex\",\n    \"2-2\": \"The starting index used (defaults to 0)\",\n    \"3-0\": \"integer\",\n    \"3-1\": \"Limit\",\n    \"3-2\": \"The max number batches to return in each result set.\",\n    \"4-0\": \"[BatchStatus](/docs/batchstatus)\",\n    \"4-1\": \"Batches\",\n    \"4-2\": \"An array [BatchStatus](/docs/batchstatus) objects for the matched batches\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Places Used\"\n}\n[/block]\n  * [searchBatches](/docs/searchbatches)\n  * searchBatchesCount\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Examples\"\n}\n[/block]\n## Visual Basic (.Net) \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Dim result As eBizCharge.BatchSearchResult = New eBizCharge.BatchSearchResult\\n       result = client.searchBatches(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\": \"eBizCharge.BatchSearchResult result = new eBizCharge.BatchSearchResult();\\n           try\\n           {\\n               result = client.searchBatches(token, search, matchAll, start, limit, sort);\\n               MessageBox.Show(string.Concat(result.BatchesMatched));\\n           }\",\n      \"language\": \"csharp\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"batchsearchresult","type":"basic","title":"BatchSearchResult"}
Contains results of a batch search. [block:api-header] { "type": "basic", "title": "Description" } [/block] This object is returned by the [searchBatches](/docs/searchbatches) method. It describes the result of the search, including the total number of batches matched, the number being returned, and an array of BatchStatus objects. [block:api-header] { "type": "basic", "title": "Properties" } [/block] [block:parameters] { "data": { "h-0": "Type", "h-1": "Name", "h-2": "Description", "0-0": "integer", "0-1": "BatchesMatched", "0-2": "Total number of batches matched", "1-0": "integer", "1-1": "BatchesReturned", "1-2": "Number of batches returned in this result set", "2-0": "integer", "2-1": "StartIndex", "2-2": "The starting index used (defaults to 0)", "3-0": "integer", "3-1": "Limit", "3-2": "The max number batches to return in each result set.", "4-0": "[BatchStatus](/docs/batchstatus)", "4-1": "Batches", "4-2": "An array [BatchStatus](/docs/batchstatus) objects for the matched batches" }, "cols": 3, "rows": 5 } [/block] [block:api-header] { "type": "basic", "title": "Places Used" } [/block] * [searchBatches](/docs/searchbatches) * searchBatchesCount [block:api-header] { "type": "basic", "title": "Examples" } [/block] ## Visual Basic (.Net) [block:code] { "codes": [ { "code": "Dim result As eBizCharge.BatchSearchResult = New eBizCharge.BatchSearchResult\n result = client.searchBatches(token, search, matchAll, start, limit, sort)\n MsgBox(result.BatchesMatched)", "language": "c" } ] } [/block] ## C Sharp (.Net) [block:code] { "codes": [ { "code": "eBizCharge.BatchSearchResult result = new eBizCharge.BatchSearchResult();\n try\n {\n result = client.searchBatches(token, search, matchAll, start, limit, sort);\n MessageBox.Show(string.Concat(result.BatchesMatched));\n }", "language": "csharp" } ] } [/block]