How do I use GetStatus and what information does it return?

Want to know what the status is of one or many jobs? Use GetStatus to return information on a particular MediaID. Indicate one or many (separated by commas of course); the MediaID must be included. Want even more info? See the article on GetStatus Extended for details on what that returns. Need a quick guide as to what all the tags refer to, go here: 

http://www.encoding.com/api/category/category/complete_api_documentation#getstatus_action

<?xml version="1.0"?>
<query>
    <action>GetStatus</action>
    <userid>[UserID]</userid>
    <userkey>[UserKey]</userkey>
    <mediaid>[MediaID]</mediaid>
</query>

Here's what you'll receive back:

<?xml version="1.0"?>
<response>
    <id>[MediaID]</id>
    <userid>[UserID]</userid>
    <sourcefile>[SourceFile]</sourcefile>
    <status>[MediaStatus]</status>
    <notifyurl>[NotifyURL]</notifyurl>
    <created>[Date]</created>
    <started>[Date]</started>
    <finished>[Date]</finished>
    <prevstatus>[MediaStatus]</prevstatus>
    <downloaded>[Date]</downloaded>
    <uploaded>[Date]</uploaded>
    <time_left>[TotalTimeLeft]</time_left>
    <progress>[TotalProgress]</progress>
    <time_left_current>[StatusTimeLeft]</time_left_current>
    <progress_current>[StatusProgress]</progress_current> 
    <format>
        <id>[ID]</id>
        <status>[Status]</status>
        <created>[Date]</created>
        <started>[Date]</started>
        <finished>[Date]</finished>
        <!----Format_Fields----->
        <s3_destination>[TempS3Link]</s3_destination> <!-- optional -->
        <cf_destination>[TempCFLink]</cf_destination> <!-- optional -->
        <destination>[URL]</destination>
        <destination_status>[Saved|Error (ErrorDescription)]</destination_status>
        <destination>[URL_2]</destination>
        <destination_status>[Saved|Error (ErrorDescription)]</destination_status>
        <destination>[URL_N]</destination>
        <destination_status>[Saved|Error (ErrorDescription)]</destination_status>
    </format>
    <format>
    </format>
</response>
1 Star2 Stars3 Stars4 Stars5 Stars (1 votes, average: 3.00 out of 5)
Loading...

By

edchelp

Posts