05 May 2023

GetQualifyReport API Call

Added new API call to get Qualify QC Validation report.

Request

<?xml version="1.0" encoding="UTF-8"?>
<query>
    <userid><<id>></userid> <!-- required -->
    <userkey><<key>></userkey> <!-- required-->
    <action>GetQualifyReport</action> <!-- required-->
    <mediaid>[MediaID]</mediaid> <!-- required-->
    <report_format>[pdf|json]</report_format>
</query>

{
    "query": {
        "userid": "<<id>>", // required
        "userkey": "<<key>>", // required
        "action": "GetQualifyReport", // required
        "mediaid": "[MediaID]", // required
        "report_format": "[pdf|json]"
    }
}

Parameter	Description	Allowed Values	Default Value
mediaid	ID of Qualify QC Media	Positive integer number	none
report_format	Report format	json, pdf	json

📘
Response
In response for GetQualifyReport we will send empty body and add Location HTTP header with link to the report.

Nielsen Watermarking parameters length limitation

Added limits for maximum length of the Nielsen Watermarking parameters: <nielsen_asset_id >, <nielsen_asset_name />, and <nielsen_episode />

<?xml version="1.0"?>
<query>
    <userid><<id>></userid> <!-- required-->
    <userkey><<key>></userkey> <!-- required-->
    <action>[Action]</action> <!-- required-->
    <source>[SourceFile]</source> <!-- required-->
    <format>
        <output>[OutputFormat]</output> <!-- required-->
        <nielsen_asset_id>[AssetID]</nielsen_asset_id>
        <nielsen_asset_name>[AssetName]</nielsen_asset_name>
        <nielsen_episode>[NielsenEpisode]</nielsen_episode>
        <!-- format params -->
    </format>
</query>

{
    "query": {
        "userid": "<<id>>", // required
        "userkey": "<<key>>", // required
        "action": "[Action]", // required
        "source": "[SourceFile]", // required
        "format": {
            "output": "[OutputFormat]", // required
            "nielsen_asset_id": "[AssetID]",
            "nielsen_asset_name": "[AssetName]",
            "nielsen_episode": "[NielsenEpisode]"
            // format params
        }
    }
}

Prameter	Description	Allowed Values	Default Value
nielsen_asset_id	Nielsen Asset ID	Valid String Maximum length 20 characters	none
nielsen_asset_name	Nielsen Asset Name	Valid String Maximum length 50 characters	none
nielsen_episode	Nielsen Episode	Valid String Maximum length 40 characters	none