{"_id":"5632a5ea49e16d0d0012248e","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"},"githubsync":"","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,"project":"55b933b3146ef121002158d3","user":"55b932ba8fd1a02b00f496c8","parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-04T17:53:16.500Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":12,"body":"Contains customer search data.\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Description\"\n}\n[/block]\nThis object is returned by the [searchCustomers](/docs/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.\n\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\": \"CustomersMatched\",\n    \"0-2\": \"Total number of customers matched by search criteria.\",\n    \"1-0\": \"integer\",\n    \"1-1\": \"CustomersReturned\",\n    \"1-2\": \"Total number of customers contained in search result.\",\n    \"2-0\": \"integer\",\n    \"2-1\": \"StartIndex\",\n    \"2-2\": \"The index where this result set begins (default is 0).\",\n    \"3-0\": \"integer\",\n    \"3-1\": \"Limit\",\n    \"3-2\": \"The maximum number of customers to be returned in the search.\",\n    \"4-0\": \"[CustomerObject](/docs/customerobject)\",\n    \"4-1\": \"Customers\",\n    \"4-2\": \"An array of CustomerObjects matched by search criteria.\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]\n\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 response As eBizCharge.CustomerSearchResult = New eBizCharge.CustomerSearchResult\\n       response = client.searchCustomers(token, search, matchAll, \\\"0\\\", \\\"10\\\", \\\"fname\\\")\\n       MsgBox(response.CustomersMatched)\",\n      \"language\": \"asp\"\n    }\n  ]\n}\n[/block]\n## C Sharp (.Net)\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"eBizCharge.CustomerSearchResult response = new eBizCharge.CustomerSearchResult();\\n           try\\n           {\\n               response = client.searchCustomers(token, search, matchAll, \\\"0\\\", \\\"10\\\", \\\"fname\\\");\\n               MessageBox.Show(response.CustomersMatched);\\n           }\",\n      \"language\": \"csharp\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"customersearchresult","type":"basic","title":"CustomerSearchResult"}

CustomerSearchResult


Contains customer search data. [block:api-header] { "type": "basic", "title": "Description" } [/block] This object is returned by the [searchCustomers](/docs/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. [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": "CustomersMatched", "0-2": "Total number of customers matched by search criteria.", "1-0": "integer", "1-1": "CustomersReturned", "1-2": "Total number of customers contained in search result.", "2-0": "integer", "2-1": "StartIndex", "2-2": "The index where this result set begins (default is 0).", "3-0": "integer", "3-1": "Limit", "3-2": "The maximum number of customers to be returned in the search.", "4-0": "[CustomerObject](/docs/customerobject)", "4-1": "Customers", "4-2": "An array of CustomerObjects matched by search criteria." }, "cols": 3, "rows": 5 } [/block] [block:api-header] { "type": "basic", "title": "Examples" } [/block] ## Visual Basic (.Net) [block:code] { "codes": [ { "code": "Dim response As eBizCharge.CustomerSearchResult = New eBizCharge.CustomerSearchResult\n response = client.searchCustomers(token, search, matchAll, \"0\", \"10\", \"fname\")\n MsgBox(response.CustomersMatched)", "language": "asp" } ] } [/block] ## C Sharp (.Net) [block:code] { "codes": [ { "code": "eBizCharge.CustomerSearchResult response = new eBizCharge.CustomerSearchResult();\n try\n {\n response = client.searchCustomers(token, search, matchAll, \"0\", \"10\", \"fname\");\n MessageBox.Show(response.CustomersMatched);\n }", "language": "csharp" } ] } [/block]