GetTestList

Retrieve one or more matching EOA TEST IDs based on previously supplied X-HEADERS and/or date filters to search against. If multiple X-HEADER name/values are supplied, all of them must be a match to return results. Add 'xml' as the last segment in the url request to return XML format. Add 'json' as the last segment in the url request to return JSON format.

URLs:

Sandbox:

https://sandbox.emailonacid.com/v4/getTestList - Default (XML) Request
https://sandbox.emailonacid.com/v4/getTestList/xml - XML Request
https://sandbox.emailonacid.com/v4/getTestList/json - JSON Request

Production:

https://api.emailonacid.com/v4/getTestList - Default (XML) Request
https://api.emailonacid.com/v4/getTestList/xml - XML Request
https://api.emailonacid.com/v4/getTestList/json - JSON Request

Request:

XML

<?xml version="1.0" encoding="utf-8"?>
     <get_test_list>
         <headers>
            <header>
                <name>X-Value1</name>
                <value>Test Value1</value>
            </header>
            <header>
                <name>X-Value2</name>
                <value>Test Value2</value>
            </header>
         </headers>
         <start_date>2014-02-06T00:00:00Z</start_date>
         <end_date>2014-02-07T00:00:00Z</end_date>
    </get_test_list>

JSON

{
    "headers": [
        {
            "name": "X-Value1",
            "value": "Test Value1"
        },
        {
            "name": "X-Value2",
            "value": "Test Value2"
        }
    ],
    "start_date": "2014-02-06T00:00:00Z",
    "end_date": "2014-02-07T00:00:00Z"
}

JSON Validation Schema:

Click here to download.

Request Details

Element Description Data Type Required
headers A list of one or header objects, containing a name and a value. Integer N
name The name of the X-HEADER to filter by. String Y (If header element is present)
value The contents of the X-HEADER to match against. String Y (If header element is present)
start_date The start of the time range to filter test submissions by. Date N
end_date The end of the time range to filter test submissions by. Date N

Response:

XML

<?xml version="1.0" encoding="utf-8"?>
<xml>
    <test_list>
        <eoa_test_id>UNIQUE EMAIL TEST ID</eoa_test_id>
        <eoa_test_id>UNIQUE EMAIL TEST ID</eoa_test_id>
    </test_list>
</xml>

JSON

[{
    "test_list"   : [
        {
            "eoa_test_id"   :   UNIQUE EMAIL TEST ID
        },
        {
            "eoa_test_id"   :   UNIQUE EMAIL TEST ID
        }
    ]
 }]

Response Details

Element Description Data Type Required
test_list The list of eoa_test_ids that match the search criteria. Array Y
eoa_test_id The reference id for the test to retrieve Integer Y