31 August 2023
about 1 year ago by Encoding.com Product Team #2
Qualify template validation
Added API-request to validate Qualify QC Validation template.
Request:
<?xml version="1.0" encoding="UTF-8"?>
<query>
<userid><<id>></userid> <!-- required -->
<userkey><<key>></userkey> <!-- required-->
<action>ValidateQualifyTemplate</action> <!-- required-->
<template><![CDATA[
{
"id": "[TemplateGUID]", // optional
"created_at": "[TemplateCreatedDate]",
"updated_at": "[TemplateUpdatedDate]",
"name": "[TemplateName]",
"tests": {
[TestsList]
},
"package_layout": {
"id": "[LayoutID]" // optional, new layout will be added if not provided
// package_layout params
},
"audio_layout": {
"id": "[LayoutID]" // optional, new layout will be added if not provided
// audio_layout params
}
}
]]></template> <!-- required-->
</query>
{
"query": {
"userid": "<<id>>", // required
"userkey": "<<key>>", // required
"action": "ValidateQualifyTemplate", // required
"template": {
"id": "[TemplateGUID]", // optional
"created_at": "[TemplateCreatedDate]",
"updated_at": "[TemplateUpdatedDate]",
"name": "[TemplateName]",
"tests": {
[TestsList]
},
"package_layout": {
"id": "[LayoutID]" // optional, new layout will be added if not provided
// package_layout params
},
"audio_layout": {
"id": "[LayoutID]" // optional, new layout will be added if not provided
// audio_layout params
}
} // required
}
}
Parameter | Description | Allowed Values | Default Value |
---|---|---|---|
template | Qualify template | JSON string for XML request and JSON object for JSON request. For XML request it should be wrapped in tage. | none |
Response:
<?xml version="1.0" encoding="UTF-8"?>
<response>
<action>validatequalifytemplate</action>
<status>Success</status>
</response>
{
"response": {
"action": "validatequalifytemplate",
"status": "Success"
}
}
<?xml version="1.0" encoding="UTF-8"?>
<response>
<action>validatequalifytemplate</action>
<status>Error</status>
<errors>
<error>Template is invalid</error>
<error>[ErrorMessage1]</error>
<error>[ErrorMessage2]</error>
<!-- ... -->
<error>[ErrorMessageN]</error>
</errors>
</response>
{
"response": {
"status": "Error",
"errors": {
"error": [
"Template is invalid",
"[ErrorMessage1]",
"[ErrorMessage2]",
// ...
"[ErrorMessageN]"
]
}
}
}