photo-documentation/docs/api/PostTagDelete.markdown
sneakypete81 7ac8e553c5 * Remove email/latitude/longitude
* Add actor/owner (although I'm not sure exactly what these mean)
* Add delete tag API
* Mark create/delete API as "internal"
* Create API returns TRUE, not the created tag
* Removed update API examples
2013-03-28 10:25:59 +00:00

2 KiB

Delete Tag


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

Purpose of the Delete Tag API

This API is used internally to delete a tag. External applications should use the Photo Update API to delete tags.


Endpoint

Authentication: required

POST /tag/:id/delete.json

Parameters


Examples

Command Line (using openphoto-php)

./openphoto -p -X POST -h current.trovebox.com -e /tag/sunnyvale/delete.json

PHP (using openphoto-php)

$client = new OpenPhotoOAuth($host, $consumerKey, $consumerSecret, $oauthToken, $oauthTokenSecret);
$response = $client->post("/tag/sunnyvale/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, 201 on success
  • result, TRUE if the tag was successfully deleted

Sample

{
  "message":"",
  "code":201,
  "result":TRUE
}