GetClientList

Retrieve the list of email clients available through our API service. 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/getClientList - Default (XML) Request
https://sandbox.emailonacid.com/v4/getClientList/xml - XML Request
https://sandbox.emailonacid.com/v4/getClientList/json - JSON Request

Production:

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

Request:

No content is necessary for this request, other than having the content-type properly set for the response type.

Response:

XML

<?xml version="1.0" encoding="utf-8"?>
<xml>
    <email_client>
        <client_code>8</client_code>
        <client_name><![CDATA[AOL Web]]></client_name>
        <screen_shot>FALSE</screen_shot>
        <screenshot_orientation></screenshot_orientation>
        <code_preview>TRUE</code_preview>
        <included_in_free>TRUE</included_in_free>
        <application>web</application>
        <browsers>
            <browser>
                <code>1_2_11</code>
                <os>Windows</os>
                <name>Firefox</name>
                <version>3.6</version>
            </browser>
            .....
        </browsers>
    </email_client>
    <email_client>
        <client_code>12</client_code>
        <client_name><![CDATA[Mac Mail]]></client_name>
        <screen_shot>TRUE</screen_shot>
        <screenshot_orientation>V</screenshot_orientation>
        <code_preview>TRUE</code_preview>
        <included_in_free>FALSE</included_in_free>
        <application>desktop</application>
    </email_client>
    .....
</xml>

JSON

[
    {
        "email_client": {
            "client_code": "26",
            "client_name": "Android 2.3",
            "screen_shot": "TRUE",
            "screenshot_orientation": "B",
            "code_preview": "FALSE",
            "included_in_free": "FALSE",
            "application": "Mobile"
        }
    },
    {
        "email_client": {
            "client_code": "8",
            "client_name": "AOL Web ",
            "screen_shot": "TRUE",
            "screenshot_orientation": "V",
            "code_preview": "FALSE",
            "included_in_free": "TRUE",
            "application": "Web",
            "browsers": [
                {
                    "browser": {
                        "code": "7_1_8",
                        "os": "Windows",
                        "name": "Firefox",
                        "version": "4"
                    }
                },
                {
                    "browser": {
                       ...
                }
            ]
        }
    }
]

Response Details

Element Description
client_code Our unique identifier for the email client. This code can be used in the CreateTest API call.
client_name Name of the email client.
screen_shot If we offer this client as a screen-shot this value will be TRUE, otherwise it will be FALSE.
screenshot_orientation If we offer this client as a screen-shot this value will be V (Vertical), H (Horizontal) or B (Vertical and Horizontal).
code_preview If we offer a code based preview for this client the value will be TRUE, otherwise it will be FALSE.
included_in_free TRUE if the client is available in our free test, otherwise FALSE.
application The email client application type. Value will be one of the following: desktop, mobile or web
browsers Will be set if the record is a web-based client and we offer browser screenshots.