Favorites/destroy

«  Return to the list of API methods

Contents

URL

http://yourserver/api/favorites/destroy/ID.format

Description

It stops being favorite the specified note. When successful, information about the note will be returned.

Available formats

XML, JSON

HTTP Method

POST, DELETE

Requires authentication

YES

Required parameters

These parameters can be passed through GET or POST.

Return example (XML)

curl http://yourserver/api/favorites/destroy/ID.xml
<?xml version="1.0" encoding="UTF-8"?>
<status>
 <id>5</id>
 <created_at>Sat May 15 12:00:42 +0000 2010</created_at>
 <text>test</text>
 <source>web</source>
 <truncated>false</truncated>
 <in_reply_to_status_id/>
 <in_reply_to_user_id/>
 <favorited>false</favorited>
 <in_reply_to_screen_name/>
 <user>
  <id>2</id>
  <name>lorena</name>
  <screen_name>lorena</screen_name>
  <location/>
  <description/>
  <profile_image_url>http://192.168.1.180/static/img/avatar/default_note.png</profile_image_url>
  <url/>
  <protected>true</protected>
  <followers_count>0</followers_count>
  <created_at>Sat May 15 12:00:07 +0000 2010</created_at>
  <favourites_count>0</favourites_count>
  <statuses_count>1</statuses_count>
  <friends_count>0</friends_count>
  <following>false</following>
  <utc_offset/>
  <geo_enabled>false</geo_enabled>
  <time_zone/>
  <profile_background_image_url>http://192.168.1.180/themes/transparency/img/bg.png</profile_background_image_url>
  <profile_background_tile>false</profile_background_tile>
  <notifications>false</notifications>
  <verified>false</verified>
  <lang>en</lang>
  <contributors_enabled>false</contributors_enabled>
 </user>
</status>

Return example (JSON)

curl http://yourserver/api/favorites/destroy/ID.json
{
    "id": 5,
    "created_at": "Sat May 15 12:00:42 +0000 2010",
    "text": "test",
    "source": "web",
    "truncated": false,
    "in_reply_to_status_id": null,
    "in_reply_to_user_id": null,
    "in_reply_to_screen_name": null,
    "geo": null,
    "favorited": false,
    "contributors": null,
    "coordinates": null,
    "user": {
        "id": 2,
        "name": "lorena",
        "screen_name": "lorena",
        "location": null,
        "description": "",
        "profile_image_url": "http:\/\/192.168.1.180\/static\/img\/avatar\/default_note.png",
        "url": null,
        "protected": true,
        "followers_count": "0",
        "created_at": "Sat May 15 12:00:07 +0000 2010",
        "favourites_count": 0,
        "statuses_count": "1",
        "friends_count": "0",
        "following": false,
        "utc_offset": null,
        "time_zone": null,
        "profile_background_image_url": "http:\/\/192.168.1.180\/themes\/transparency\/img\/bg.png",
        "profile_background_tile": false,
        "notifications": false,
        "verified": false,
        "lang": "en",
        "contributions_enabled": false,
        "geo_enabled": false
    }
}