Methods 1.1:cancelConversion

From Aviberry API

Language:

English  • Русский

Contents
Other methods
Still have a question?

cancelConversion - cancels conversion. If conversion process is already in progress, the process will not be stopped, but the output will not be sent to the user.

Signature

boolean cancelConversion(
    mixed conversion_id
)

Parameters

conversion_id

conversion_id - identifier of conversion to cancel or identifier array.
Type: mixed.

Return value

Type: boolean.
Method call result is true, if call was successful, else false. If at method calling there was indicated an identifier array, then true will be returned only if all the chosen conversions were successfully canceled.

Examples

XML-RPC

cancelConversion

<methodCall>
<methodName>cancelConversion</methodName>
<params>
    <param>
        <value>
            <string>2011_11-22_01_5116-72429800</string>
        </value>
    </param>
</params>
</methodCall>

Return value

<methodResponse>
<params>
    <param>
        <value>
            <boolean>1</boolean>
        </value>
    </param>
</params>
</methodResponse>

JSON-RPC

cancelConversion

{
    "version":"1.1",
    "method":"cancelConversion",
    "id":1,
    "params":
    {
        "conversion_id":"2011_11-22_01_5116-72429800"
    }
}

Return value

{
    "version":"1.1",
    "id":1,
    "result":true
}

Contents
Other methods
Still have a question?

Language:

English  • Русский