PeopleAggregator API: method peopleaggregator.deleteFile

Arguments | Return value | REST (XML) example | REST (JSON) example | XML-RPC example

Method: peopleaggregator.deleteFile

Deletes a media file.
User documentation for peopleaggregator.deleteFile on the PeopleAggregator wiki

Arguments (see also Authentication)

If calling by XML-RPC, note that this method takes a single struct as input, with the following keys:

authToken

Type: string
Authentication token for the user who wants to delete the file
Example: as9d867f234o7asdf:928734982734987234:298374982734987234

id

Type: string
ID of the file to delete
Example: file:42

Return value (see also Exceptions)

Type: hash

Attributes:

success

Type: boolean
true if the file was successfully received and saved, or false if an error occurred.
Example: True

Example REST (XML) request

Request

POST /api/xml/peopleaggregator/deleteFile HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Content-Length: 82

authToken=as9d867f234o7asdf%3A928734982734987234%3A298374982734987234&id=file%3A42

Response

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 89

<response>
 <success>true</success>
</response>

Example REST (JSON) request

Request

POST /api/json/peopleaggregator/deleteFile HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Content-Length: 82

authToken=as9d867f234o7asdf%3A928734982734987234%3A298374982734987234&id=file%3A42

Response

HTTP/1.1 200 OK
Content-Type: application/x-javascript
Content-Length: 17

{"success": true}

Example XML-RPC call

Request

POST /api/xmlrpc HTTP/1.1
Content-Type: text/xml
Content-Length: 1025

<?xml version='1.0'?>
 <methodCall>
  <methodName>peopleaggregator.deleteFile</methodName>
  <params>
   <param>
    <value><struct>
     <member>
      <name>authToken</name>
      <value><string>as9d867f234o7asdf:928734982734987234:298374982734987234</string></value>
     </member>
     <member>
      <name>id</name>
      <value><string>file:42</string></value>
     </member>
    </struct></value>
   </param>
  </params>
 </methodCall>
 

Response

HTTP/1.1 200 OK
Content-Type: text/xml
Content-Length: 627

<?xml version='1.0'?>
 <methodResponse>
  <params>
   <param>
    <value><struct>
     <member>
      <name>success</name>
      <value><boolean>1</boolean></value>
     </member>
    </struct></value>
   </param>
  </params>
 </methodResponse>