Methods 1.1:deleteConversion

From Aviberry API

Language:

English  • Русский

Contents
Other methods
Still have a question?

deleteConversion - deletes conversion.
"Deletes" in this case means that this conversion will no longer appear in the output of getConversions method, but one still can obtain information about it by calling getConversion method.
Only finished or canceled conversion (see Conversion statuses section) can be deleted.

Signature

boolean deleteConversion(
    mixed conversion_id
)

Parameters

conversion_id

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

Return value

Type: boolean.

Method calling result - true, if the call was successful, else false. If when calling was indicated identifier array, then true will be returned only if all the indicated conversions were successfully deleted.

Examples

XML-RPC

deleteConversion

<methodCall>
<methodName>deleteConversion</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

deleteConversion

{
    "version":"1.1",
    "method":"deleteConversion",
    "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  • Русский