Planfix API file.delete: Difference between revisions
From Planfix
(Created page with "Function for deleting a list of files. Request format: <source lang="xml"> <?xml version="1.0" encoding="UTF-8"?> <request method="file.delete"> <account></account> <sid></sid> <files> <id></id> <id></id> <!-- ... --> </files> <signature></signature> </request> </source> or <source lang="xml"> <?xml version="1.0" encoding="UTF-8"?> <request method="file.delete"> <account></account> <sid></sid> <files> <uniqueId></uniqueId> <uniqueId>...") |
No edit summary |
||
Line 36: | Line 36: | ||
|files.id || int ||file identifier || | |files.id || int ||file identifier || | ||
|- | |- | ||
|files.uniqueId ||int ||unique file identifier | |files.uniqueId ||int ||unique file identifier || | ||
|- | |- | ||
|signature ||string(32) ||signature || | |signature ||string(32) ||signature || |
Latest revision as of 10:36, 12 March 2024
Function for deleting a list of files. Request format:
<?xml version="1.0" encoding="UTF-8"?>
<request method="file.delete">
<account></account>
<sid></sid>
<files>
<id></id>
<id></id>
<!-- ... -->
</files>
<signature></signature>
</request>
or
<?xml version="1.0" encoding="UTF-8"?>
<request method="file.delete">
<account></account>
<sid></sid>
<files>
<uniqueId></uniqueId>
<uniqueId></uniqueId>
<!-- ... -->
</files>
<signature></signature>
</request>
Name | Type | Value | Note |
---|---|---|---|
files | list of file identifiers | ||
files.id | int | file identifier | |
files.uniqueId | int | unique file identifier | |
signature | string(32) | signature |
Result of successful function execution:
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
<count></count>
</response>
Name | Type | Value | Note |
---|---|---|---|
count | int | number of deleted files |
Otherwise, an error response will be returned:
<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
<code></code>
</response>