LimeLM
wyBuild
Support forum
Wyatt Says...
wyDay Home

limelm.trial.advancedSearch

Find all the verified trials based on search parameters.

Arguments

api_key (Required)
Your API application key. Your api key is available on your settings page.
num (Optional)
The number of verified trials to return per page. If this parameter is missing (or invalid) then it will default to 20.
page (Optional)
The page you're currently on. If this parameter is missing (or invalid) then it will default to 1.
product_id (Optional)
The id of the product to search for the verified trial. You can get the product ID by examining the URL in your browser. For instance, from the URL https://wyday.com/limelm/product/view/101/ you can see the product ID is 101.

If the product_id parameter is not present then this function will search all products in your LimeLM account (unless a version_id parameter is specified).
version_id (Optional)
The id of the version to search for the verified trial. You can get the version ID by examining the URL in your browser. For instance, from the URL http://wyday.com/limelm/version/100/ you can see the version ID is 100. (Note: The Version ID is not the Version GUID).

If the version_id parameter is not present then this function will search all versions in your LimeLM account (unless a product_id parameter is specified).
extra_data (Optional)
The extra data associated with the verified trial(s). If you don't specify this parameter then this function will ignore the extra_data field. You can also use the asterisk wildcard character "*" to do partial matches of extra data.
create_start (Optional)
The start of the date range in the form YYYY-MM-DD (e.g. 2010-06-25) or YYYY-MM-DD hh:mm:ss. If this value is not present it finds all verified trials created since the beginning of time.
create_end (Optional)
The end of the date range in the form YYYY-MM-DD (e.g. 2011-06-25) or YYYY-MM-DD hh:mm:ss. If this value is not present it finds all verified trials created up until the present time.
expired_start (Optional)
The start of the date range in the form YYYY-MM-DD (e.g. 2010-06-25) or YYYY-MM-DD hh:mm:ss. If this value is not present it finds all verified trials expired since the beginning of time.
expired_end (Optional)
The end of the date range in the form YYYY-MM-DD (e.g. 2011-06-25) or YYYY-MM-DD hh:mm:ss. If this value is not present it finds all verified trials expiring at any time.

Example Response

The method returns a list of verified trials, the total number of pages, and the total number of matching verified trials.

<trials pages="1" total="3">
    <trial trial_id="32" version_id="2" length="2" created="2017-02-07 04:16:44-05:00" expires="2017-02-09 04:16:44-05:00" ip_addr="91.189.94.40" platform="linux" os_version="Ubuntu 16.04.1 LTS (Xenial Xerus) (Linux kernel 4.4.0-62-generic, 64-bit)" is_vm="true"/>
    <trial trial_id="8" version_id="2" length="3" created="2016-10-06 13:17:48-04:00" expires="2016-10-14 02:24:49-04:00" ip_addr="104.43.195.251" platform="windows" os_version="Windows 10, build 14393 (64-bit)"/>
    <trial trial_id="7" version_id="2" length="16" created="2016-09-03 00:34:18-04:00" expires="2016-09-19 00:34:18-04:00" ip_addr="17.172.224.47" platform="mac" os_version="Mac OS X 10.6.8 (Snow Leopard)" is_vm="true"/>
</trials>

Error Codes

100: Invalid API Key
The API key passed was not valid or has expired.
101: Method "xxx" not found
The requested method was not found.
118: Your account is in dormant mode. Re-enable your account.
You cannot use verified trials when your account is in dormant mode. Re-enable your account and you will no longer get this error.
142: Service currently unavailable
The requested service is temporarily unavailable.
162: Verified trials not found.
No verified trials found for the specified search parameters.
163: The date/time parameters must be in the format Y-m-d H:i:s
One of the parameters that accepts timestamps ("create_start", "create_end", "expired_start", or "expired_end") aren't in the correct format.