api/BundleManager/GetList
This method returns a list of bundles from the user who is connected with a given storageAccessKey. The list contains basic information on every bundle.
Parameters
Name | Description | Type | Required |
---|---|---|---|
storageAccessKey | A key that allows an access to an application user’s storage. | string | True |
top | Limiting the number of the returned results. | integer | False |
module | Limiting the number of searching results to the bundles with filled modules. In the case of many modules we separate the names with a comma, e. g., module=Photo, Video, Audio. | string | False |
deviceID | Limiting to the ID of the devices that bundles are from. In the case of many tools we separate them with a comma, e. g., device ID=d4b9b40a-fb31-4487-bb35-6213e657417e,f0c88e7d-5459-4624-a461-11820e36b82 | string | False |
configurationID | Limiting to the ID of configurations the bundles refer to. In the case of many IDs of configurations we separate them with a comma, e. g., configurationID=f373347b-652f-4d52-998a-888555471dfe,29ee48c4-e5db-4e39-889b-e901c7b6509e | string | False |
formID | Limiting to the ID of forms the bundles refer to. In the case of many IDs of forms we separate them with a comma, e.g.,ID=7daca124-cba8-4875-a96e-b01c1996b849,89d28902-f220-4746-af81-9361b0ec429d | string | False |
userInfo | Limiting to the users who introduced the bundles. In the case of many users we separate the names with a comma, e.g., userInfo=Mark,Andrew,Jacob | string | False |
status | Limiting to the status of a bundle. Possible statuses are: 100 – a bundle directed to proccessing, 110- a bundle with generated miniatures, 200- a bundle that has been fully proccessed, 300- a bundle proccessed incorectly. In the case of limiting to many statuses we separate them with a comma, e.g., status=100,200. Default value: status=200 | string | False |
downloaded | Limiting to the bundles that has already been downloaded. When the parameter is set on true it will return all the bundles, when set on false it will return all the bundles that has not been downloaded yet. | string | False |
inputDateFrom | Bottom limits on data of addig the bundle to the system.Time is in UTC, e.g., inputDateFrom=2016-08-04T06:30:43.353. | string | False |
inputDateTo | Top limits on data of adding the bundle to the system. Time is in UTC, e.g., inputDateFrom=2017-12-03T07:23:41.333. | string | False |
bundleIDFrom | Bottom limits on bundle ID. | int | False |
bundleIDTo | Top limits on bundle ID. | int | False |
Responses
Status | Description | |
---|---|---|
Bundle list. | ||
The bundle of the required parameters has not been found. | ||
Parameters are incorrect. | ||
StorageAccesskey does not exist. | ||
Internal server error |
Sample of using
using (WebClient client = new WebClient()) { var url = "https://scanandpaste.com/api/BundleManager/GetList?storageAccessKey=f676c533-b1f8-41dc-a060-0a2830150245&status=100,110,200&top=10"; string response = client.DownloadString(url); Console.WriteLine(response); }
import urllib2 url = 'https://scanandpaste.com/api/BundleManager/GetList?storageAccessKey=f676c533-b1f8-41dc-a060-0a2830150245&status=100,110,200&top=10' response = urllib2.urlopen(url).read() print response
URL url = new URL("https://scanandpaste.com/api/BundleManager/GetList?storageAccessKey=f676c533-b1f8-41dc-a060-0a2830150245&status=100,110,200&top=10"); HttpURLConnection conn = (HttpURLConnection) url.openConnection(); BufferedReader br = new BufferedReader(new InputStreamReader( (conn.getInputStream()))); String output; while ((output = br.readLine()) != null) { System.out.println(output); } conn.disconnect();