photo-documentation/docs/api/PostActionDelete.markdown
2013-01-28 22:49:14 -05:00

1.9 KiB

Delete Action


  1. Purpose
  2. Endpoint
  3. Parameters
  4. Examples
  1. Response

Purpose of the delete action API

Use this API to delete an action on a photo. This includes comments and favorites.


Endpoint

Authentication: required

POST /action/photo/:targetId/delete.json

Parameters

N/A


Examples

Command Line (using openphoto-php)

./openphoto -p -X POST -h current.openphoto.me -e /action/photo/a/delete.json

PHP (using openphoto-php)

$client = new OpenPhotoOAuth($host, $consumerKey, $consumerSecret, $oauthToken, $oauthTokenSecret);
$response = $client->post("/action/photo/a/delete.json");

Response

The response is in a standard response envelope.

  • message, A string describing the result. Don't use this for anything but reading.
  • code, 204 on success
  • result, boolean

Sample

{
  "message":"",
  "code":204,
  "result": true
}