API: Uploads

Make sure to read the API Overview before reading this document.

Retrieving a List of Uploads

Required Variables

Variable Description
section Must be set to uploads.
action Must be set to retrieve.
api_key Must be set to your unique API key.

Optional Variables

Variable Description
service_id An integer or series of integers which specifies the particular services you'd like to search for scans within. You can specify a single integer or a comma-separated list of integers (Examples: 1005 or 1005, 1010, 1254). You can also use the keyword all to include all services. This parameter is set to all by default.
device_id An integer or series of integers which will return only scans conducted by the specified devices. You can specify a single integer or a comma-separated list of integers (Examples: 1005 or 1005, 1010, 1254). You can also use the keyword all to include all services. This parameter is set to all by default.
user_id An integer or series of integers which will return only scans conducted by the specified users. You can specify a single integer or a comma-separated list of integers (Examples: 1005 or 1005, 1010, 1254). You can also use the keyword all to include all services. This parameter is set to all by default.
limit An integer which limits the maximum number of results displayed within the list.
offset An integer which offsets the results shown. Only valid if limit is provided. (Example: a limit of 20 and an offset of 5 will display a list of 20 scans that begins with the 5th scan).

Response

After we receive these variables, we will respond with raw XML containing status and scan data.

Example:

<?xml version="1.0" encoding="UTF-8"?>
    <xml>
        <status>1</status>
        <count>3</count>
        <upload id="13193" device_id="123" service_id="456" user_id="7800" status="1" count="5" timestamp="2011-09-06 16:17:29">
        <upload id="13194" device_id="123" service_id="885" user_id="7800" status="1" count="3" timestamp="2011-09-06 16:20:10">
        <upload id="13195" device_id="1260" service_id="4560" user_id="77" status="1" count="400" timestamp="2011-09-06 16:35:09">
</xml>

Back to Top