Knowledge Base
Categories: Sub-Reseller Management API
Search Sub-Resellers Using the API
When you want to search sub-reseller accounts using the API. This article explains search filters, pagination parameters, sub-reseller status options, receipt filters, and response details for matching sub-reseller records.
Description
Gets details of the Sub-Resellers that match the Search criteria.
Parameters
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| no-of-records | Integer | Required | Number of records to be fetched. This should be a value between 10 to 500. |
| page-no | Integer | Required | Page number for which details are to be fetched |
| reseller-id | Array of Integers | Optional | Reseller Id of Sub-Reseller(s) |
| username | String | Optional | Username of Sub-Reseller. Username should be an email address. |
| name | String | Optional | Name of Sub-Reseller |
| company | String | Optional | Company Name of Sub-Reseller |
| city | String | Optional | City |
| state | String | Optional | State |
| status | String | Optional | Status of Sub-Reseller. Values can be Active, Suspended and Deleted. |
| creation-date-start | String | Optional | UNIX TimeStamp for listing of Sub-Resellers whose Creation Date is greater than creation-date-start |
| creation-date-end | String | Optional | UNIX TimeStamp for listing of Sub-Resellers whose Creation Date is less than creation-date-end |
| total-receipt-start | Float | Optional | Total receipts of Sub-Resellers which is greater than total-receipt-start |
| total-receipt-end | Float | Optional | Total receipts of Sub-Resellers which is less than total-receipt-end |
HTTP Method
GET
Example Test URL Request
https://test.httpapi.com/api/resellers/search.json?auth-userid=0&api-key=key&no-of-records=10&page-no=1
Response
Returns a hash map containing the below details of the Sub-Resellers that match the search criteria:
-
Number of Sub-Resellers requested matching the search criteria (recsonpage)
Following details of each Sub-Resellers
-
Reseller Id (reseller.resellerid)
-
Username (reseller.username)
-
Name (reseller.name)
-
Company (reseller.company)
-
City (reseller.city)
-
State (reseller.state)
-
Country Code (reseller.country)
-
Current Status (reseller.resellerstatus)
-
Total Receipts (reseller.totalreceipts)
-
-
Number of Sub-Resellers in the System matching the search criteria (recsindb)
In case of any errors, a status key with value as ERROR alongwith an error message will be returned.
Did you find this article helpful?