Request Metadata

To include custom data in responses from AddMedia requests to GetStatus response or Notifications you can add the parameter to the level. This parameter accepts a variety of simple string, single xml node (JSON object) or multiple XML nodes (JSON array).

Request

<?xml version="1.0"?>
<query>
    <userid>[UserID]</userid>
    <userkey>[UserKey]</userkey>
    <action>[AddMedia|AddMediaBenchmark]</action>
    <meta>Some random data</meta>
</query>

{
    "query": {
        "userid": "[UserID]",
        "userkey": "[UserKey]",
        "action": "[AddMedia|AddMediaBenchmark]",
        "meta": "Some random data"
    }
}

<?xml version="1.0"?>
<query>
    <userid>[UserID]</userid>
    <userkey>[UserKey]</userkey>
    <action>[AddMedia|AddMediaBenchmark]</action>
    <meta>
        <a>1</a>
        <b>2</b>
    </meta>
</query>

{
    "query": {
        "userid": "[UserID]",
        "userkey": "[UserKey]",
        "action": "[AddMedia|AddMediaBenchmark]",
        "meta": {
            "a": "1"
            "b": "2"
        }
    }
}

<?xml version="1.0"?>
<query>
    <userid>[UserID]</userid>
    <userkey>[UserKey]</userkey>
    <action>[AddMedia|AddMediaBenchmark]</action>
    <meta>foo</meta>
    <meta>
        <bar>baz</bar>
    </meta>
</query>

{
    "query": {
        "userid": "[UserID]",
        "userkey": "[UserKey]",
        "action": "[AddMedia|AddMediaBenchmark]",
        "meta": [
            "foo",
            {"bar": "baz"}
        ]
    }
}

GetStatus Response

<?xml version="1.0"?>
<response>
    <id>[MediaID]</id>
    <userid>[UserID]</userid>
    <sourcefile>[SourceFile]</sourcefile>
    <status>[MediaStatus]</status>
    <!-- ... -->
    <meta>Some random data</meta>
</response>

{
    "response": {
        "id": "[MediaID]",
        "userid": "[UserID]",
        "sourcefile": "[SourceFile]",
        "status": "[MediaStatus]",
        "meta": "Some random data"
    }
}

<?xml version="1.0"?>
<response>
    <id>[MediaID]</id>
    <userid>[UserID]</userid>
    <sourcefile>[SourceFile]</sourcefile>
    <status>[MediaStatus]</status>
    <!-- ... -->
    <meta>
        <a>1</a>
        <b>2</b>
    </meta>
</response>

{
    "response": {
        "id": "[MediaID]",
        "userid": "[UserID]",
        "sourcefile": "[SourceFile]",
        "status": "[MediaStatus]",
        "meta": {
            "a": "1"
            "b": "2"
        }
    }
}

<?xml version="1.0"?>
<response>
    <id>[MediaID]</id>
    <userid>[UserID]</userid>
    <sourcefile>[SourceFile]</sourcefile>
    <status>[MediaStatus]</status>
    <!-- ... -->
    <meta>foo</meta>
    <meta>
        <bar>baz</bar>
    </meta>
</response>

{
    "response": {
        "id": "[MediaID]",
        "userid": "[UserID]",
        "sourcefile": "[SourceFile]",
        "status": "[MediaStatus]",
        "meta": [
            "foo",
            {"bar": "baz"}
        ]
    }
}

HTTP Notification Body

<?xml version="1.0"?>
<result>
    <id>[MediaID]</id>
    <userid>[UserID]</userid>
    <sourcefile>[SourceFile]</sourcefile>
    <status>[MediaStatus]</status>
    <!-- ... -->
    <meta>Some random data</meta>
</result>

{
    "result": {
        "id": "[MediaID]",
        "userid": "[UserID]",
        "sourcefile": "[SourceFile]",
        "status": "[MediaStatus]",
        "meta": "Some random data"
    }
}

<?xml version="1.0"?>
<result>
    <id>[MediaID]</id>
    <userid>[UserID]</userid>
    <sourcefile>[SourceFile]</sourcefile>
    <status>[MediaStatus]</status>
    <!-- ... -->
    <meta>
        <a>1</a>
        <b>2</b>
    </meta>
</result>

{
    "result": {
        "id": "[MediaID]",
        "userid": "[UserID]",
        "sourcefile": "[SourceFile]",
        "status": "[MediaStatus]",
        "meta": {
            "a": "1"
            "b": "2"
        }
    }
}

<?xml version="1.0"?>
<result>
    <id>[MediaID]</id>
    <userid>[UserID]</userid>
    <sourcefile>[SourceFile]</sourcefile>
    <status>[MediaStatus]</status>
    <!-- ... -->
    <meta>foo</meta>
    <meta>
        <bar>baz</bar>
    </meta>
</result>

{
    "result": {
        "id": "[MediaID]",
        "userid": "[UserID]",
        "sourcefile": "[SourceFile]",
        "status": "[MediaStatus]",
        "meta": [
            "foo",
            {"bar": "baz"}
        ]
    }
}

Email Notification Body

...
Media ID: [MediaID]
Source file: [SourceFile]
Status: [MediaStatus]
Meta: Some random data

...
Media ID: [MediaID]
Source file: [SourceFile]
Status: [MediaStatus]
Meta: {
    "a": "1"
    "b": "2"
}

...
Media ID: [MediaID]
Source file: [SourceFile]
Status: [MediaStatus]
Meta: [
    "foo",
    {"bar": "baz"}
]