Version 3

Request

<?xml version="1.0"?>
<query>
    <userid>[UserID]</userid>
    <userkey>[UserKey]</userkey>
    <action>GetMediaList</action>
    <version>3</version>
    <page>[PageNum]</page>
    <per_page>[ItemsPerPage]</per_page>
    <date_from>[DateFrom]</date_from>
    <date_to>[DateTo]</date_to>
    <mediaid>[MediaID]</mediaid>
    <taskid>[QueueID]</taskid>
    <output>[OutputName]</output>
    <format_params>[FormatParams]</format_params>
    <sort>[SortingField]</sort>
    <order>[asc|desc]</order>
</query>
{
    "query": {
        "userid": "[UserID]",
        "userkey": "[UserKey]",
        "action": "GetMediaList",
        "version": "3",
        "page": "[PageNum]",
        "per_page": "[ItemsPerPage]",
        "date_from": "[DateFrom]",
        "date_to": "[DateTo]",
        "mediaid": "[MediaID]",
        "taskid": "[QueueID]",
        "output": "[OutputName]",
        "format_params": "[FormatParams]",
        "sort": "[SortingField]",
        "order": "[asc|desc]"
    }
}
ParameterDescriptionAllowed ValuesDefault Value
pagePage numberPositive integer number1
per_pageNumber of elements per pagePositive integer number between between 5 and 100 inclusive10
date_fromMinimum media created DateValid datenone
date_toMaximum media created dateValid datenone
mediaidMedia IDPositive integer numbernone
taskidOutput task IDPositive integer numbernone
outputOutput format nameStringnone
format_paramsList of output format parametersComma separated listnone
sortSorting fielduser – User ID (for parent user)
media_id – Media ID
source – Source File
status – Media Status
queue_time – Media Queue Time
created – Created Date
started – Started Date
finished – Finished Date
media_id
orderSorting orderasc, descasc

Response

<?xml version="1.0"?>
<response>
    <pagination>
        <per_page>[ItemsPerPage]</per_page>
        <page>[PageNum]</page>
        <count>[ItemsCountOnPage]</count>
        <total>[TotalItemsCount]</total>
        <pages>[PagesCount]</pages>
    </pagination>
    <media>
        <id>[MediaID]</id>
        <userid>[UserID]</userid>
        <sourcefile>[SourceFile]</sourcefile>
        <created>[CreatedDate]</created>
        <started>[StartedDate]</started>
        <finished>[FinishedDate]</finished>
    </media>
    <media>
        <id>[MediaID]</id>
        <userid>[UserID]</userid>
        <sourcefile>[SourceFile1]</sourcefile>
        <sourcefile>[SourceFile2]</sourcefile>
        <!-- multiple source files -->
        <sourcefile>[SourceFileN]</sourcefile>
        <created>[CreatedDate]</created>
        <started>[StartedDate]</started>
        <finished>[FinishedDate]</finished>
    </media>
</response>
{
    "response": {
        "pagination": {
            "per_page": "[ItemsPerPage]",
            "page": "[PageNum]",
            "count": "[ItemsCountOnPage]",
            "total": "[TotalItemsCount]",
            "pages": "[PagesCount]"
        },
        "media": [
            {
                "id": "[MediaID]",
                "userid": "[UserID]",
                "sourcefile": "[SourceFile]",
                "created": "[CreatedDate]",
                "started": "[StartedDate]",
                "finished": "[FinishedDate]"
            },
            {
                "id": "[MediaID]",
                "userid": "[UserID]",
                "sourcefile": [
                    "[SourceFile1]",
                    "[SourceFile2]",
                    // multiple source files
                    "[SourceFileN]"
                ],
                "created": "[CreatedDate]",
                "started": "[StartedDate]",
                "finished": "[FinishedDate]"
            }
        ]
    }
}
ParameterDescription
Pagination parameters
per_pageNumber of elements per page
pagePage number
countCount of items on current page
totalTotal count of items
pagesPages count
Media parameters
idMedia ID
useridUser ID
sourcefileSource files location
createdMedia creation date and time
startedMedia start date and time
finishedMedia encoding finish date and time