ReprocessScreenshot

Use the following to reprocess a single screenshot.

URLs:

Sandbox:

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

Production:

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

Request:

XML

<?xml version="1.0" encoding="utf-8"?>
<reprocess_screenshot>
    <eoa_test_id>5023</eoa_test_id>
    <clients>
        <client_code>1</client_code>
    </clients>
    <no_images>false</no_images>
</reprocess_screenshot>

JSON

{
    "eoa_test_id":1234,
    "clients":[
        {
            "client_code":"1"
        },...
    ],
    "no_images":false
}

JSON Validation Schema:

Click here to download.

Request Details

Element Description Data Type Required
eoa_test_id The reference id for the test to retrieve Integer Y
clients Client to reprocess. Array Y
client_code Client code returned from GetClientList response String Y
no_images Flag to indicate whether to reprocess the screenshot with images blocked. Boolean Y

Response:

XML

<?xml version="1.0" encoding="utf-8"?>
<xml>
    <message>Your screenshot has been resubmitted for processing.</message>
        <status>TRUE</status>
        <remaining_reprocesses>5</remaining_reprocesses>
</xml>

    -OR-

<?xml version="1.0" encoding="utf-8"?>
<xml>
    <message>You may only reprocess a screenshot 1 time for this email client</message>
    <status>FALSE</status>
    <remaining_reprocesses/>
</xml>

JSON

{
    "message":"Your screenshot has been resubmitted for processing.",
    "status":"TRUE",
    "remaining_reprocesses":"1"
}
           -OR-
{
    "message":"You may only reprocess a screenshot 1 time for this email client",
    "status":"FALSE",
    "remaining_reprocesses":"0"
}

Response Details

Element Description
message Message about the success/failure of your request.
status "TRUE" if the reprocess request was successful, "FALSE" otherwise
remaining_reprocesses Indicates the number of remaining reprocesses allowed for that Client/Image combination