Release NotesUser InterfaceSystem Status
API Reference

Get QC Status

This returns the status of your QC requests.

Request

<?xml version="1.0"?>
<query>
    <userid><<id>></userid> <!-- required-->
    <userkey><<key>></userkey> <!-- required-->
    <action>GetStatus</action>
    <mediaid>[MediaID]</mediaid> <!-- required -->
    <qc_report_format>[xml|json]</qc_report_format>
    <add_qualify_progress>[yes|no]</add_qualify_progress>
</query>

{
    "query": {
        "userid": "<<id>>", // required
        "userkey": "<<key>>", // required
        "action": "GetQCStatus",
        "mediaid": "[MediaID]", // required
        "qc_report_format": "[xml|json]",
        "add_qualify_progress": "[yes|no]"
    }
}

📘

Media ID

You can use the ID of original media or the ID of QC-media which you can find by GetStatus request or in UI.

ParameterDescriptionAllowed ValuesDefault Value
mediaidChild QC media ID.Valid mediaIDnone
qc_report_formatQC Report Formatxml, jsonnone
add_qualify_progressAdd Qualify Engine progress into responseyes, nono

📘

For qc_report_format

By default, we will display QC report in format that was specified for notifications.

Response

Possible QC Status Response:

ParameterDescription
transcodingQC has not started since transcoding job is not finished.
validatingQC is in progress.
passedQC sucessfully finished. All tests passed.
quarantinedSome QC Tests failed and the error message was sent in the QC report.
failedCritical QC Tests failed.
stoppedQC process was suddenly stopped due to an error in previous QC task or StopMedia request.
skippedAll QC tests in the request were skipped for different reasons (e.g. there was only video qc tests in request, but audio-only output, etc.)
transcodingErrorQC not started because of transcoding error.

For Original Media

<?xml version="1.0"?>
<response>
    <id>[MediaID]</id>
    <userid><<id>></userid>
    <!-- media status -->
    <status>[MediaStatus]</status>
    <format>
        <!-- output information -->
        <qc_child_media>[QCMediaID]</qc_child_media>
        <qc_child_media_status>[Passed|Failse|Quarantined]</qc_status>
        <qc_report>[QCReportURL]</qc_report>
    </format>
</response>

{
    "response": {
        "id": "[MediaID]",
        "userid": "<<id>>",
        // media status
        "status": "[MediaStatus]",
        "format": {
            // output information
            "qc_child_media": "[QCMediaID]",
            "qc_child_media_status": "[Passed|Failse|Quarantined]",
            "qc_report": "[QCReportURL]"
        }
    }
}

For Child QC-Media

<?xml version="1.0"?>
<response>
    <id>[MediaID]</id> <!-- Equals to qc_child_media_id in parent media GetStatus response -->
    <userid><<id>></userid>
    <!-- media status -->
    <status>[MediaStatus]</status>
    <qc_parent_media>[ParentMediaID]</qc_parent_media>
    <qc_parent_task>[ParentTaskID]</qc_parent_task>
    <qc_status>[Passed|Failse|Quarantined]</qc_status>
    <qc_report>[QCReportURL]</qc_report>
    <progress_qualify>[QualifyEngineProgress]</progress_qualify>
    <format>
        <!-- output information -->
        <id>[ParentTaskID]</id>
        <status>[FormatStatus]</status>
    </format>
</response>

{
    "response": {
        "id": "[MediaID]", // Equals to qc_child_media_id in parent media GetStatus response
        "userid": "<<id>>",
        // media status
        "status": "[MediaStatus]",
        "qc_parent_media": "[ParentMediaID]",
        "qc_parent_task": "[ParentTaskID]",
        "qc_status": "[Passed|Failse|Quarantined]",
        "qc_report": "[QCReportURL]",
        "progress_qualify": "[QualifyEngineProgress]",
        "format": {
            // output information
            "id": "[ParentTaskID]",
            "status": "[FormatStatus]"
        }
    }
}

Report

<?xml version="1.0"?>
<report>
    <mediaID>[MediaID]</mediaID>
    <status>[QCStatus]</status>
    <notices>
        <!-- Skipped Tests -->
        <notice>Skip [TestName] test for [Reason]</notice>
    </notices>
    <passed>
        <test>
            <name>[QCTestName]</name>
            <filesProcessed>[FilesCount]</filesProcessed>
        </test>
        <test>
            <!-- Test params -->
        </test>
    </passed>
    <warnings>
        <!-- Failed Tests with severity set to 'warning' -->
        <warning>
            <streamID>[StreamID]</streamID>
            <testName>[QCTestName]</testName>
            <fileName>[FileName]</fileName>
            <message>[Message]</message>
        </warning>
        <warning>
            <!-- Test warning params -->
        </warning>
    </warnings>
    <errors>
        <!-- Failed Tests with severity set to 'failed' -->
        <error>
            <streamID>[StreamID]</streamID>
            <testName>[QCTestName]</testName>
            <fileName>[FileName]</fileName>
            <message>[Message]</message>
        </error>
        <error>
            <!-- Test failed params -->
        </error>
    </errors>
    <externalReports>
        <externalReport>
            <testName>[QCTestName]</testName>
            <fileName>[FileName]</fileName>
            <message>[ReportURL]</message>
        </externalReport>
        <externalReport>
            <!-- external report fields -->
        </externalReport>
    </externalReports>
</report>

{
    "report": {
        "mediaID": "[MediaID]",
        "status": "[QCStatus]",
        "notices": {
            "notice": [
                "Skip [TestName] test for [Reason]"
            ]
        },
        "passed": {
            "test": [{
                    "name": "[QCTestName]",
                    "filesProcessed": "[FilesCount]"
                }
            ]
        },
        "warnings": {
            "warning": [{
                    "streamID": "[StreamID]",
                    "testName": "[QCTestName]",
                    "fileName": "[FileName]",
                    "message": "[Message]"
                }
            ]
        },
        "errors": {
            "error": [{
                    "streamID": "[StreamID]",
                    "testName": "[QCTestName]",
                    "fileName": "[FileName]",
                    "message": "[Message]"
                }
            ]
        },
        "externalReports": {
            "externalReport": [
                {
                    "testName": "[QCTestName]",
                    "fileName": "[FileName]",
                    "reportLink": "[ReportURL]"
                },
                {
                    // external report fields
                }
            ]
        }
    }
}