Whootin REST API Resources

Basic API requests work under this relative path: /api/v1/ (i.e. http://whootin.com/api/v1) and requires OAuth2 authentication.
Developers API requests work under this relative path: /api/private/ (i.e. http://whootin.com/api/private).

Timeline

Resource Description
GET statuses/home_timeline Returns the 20 most recent timeline events, including rewhoots if they exist, posted by the authenticated user and the user's they follow. This is the same timeline seen by a user when they login to whootin.com.

Whoots

Resource Description
GET statuses/whoots Returns the 20 most recent Whoots, posted by the authenticated user only (without whoots of users they follow). Whoots can be filtered by category used in Hashtag with "category" parameter.
POST statuses/update Updates the authenticating user's status, also known as whooting. For each update attempt, the update text is compared with the authenticating user's recent whoot.
PUT statuses/:id Updates the authenticated user's whoot text.
GET statuses/:id/image Returns all versions of image attached to whoot. Actually it returns an url for each image version. Available versions are "gallery" (this image size is used in User's gallery), "whoot" (this one is shown in whoot) and "thumb" (this size is shown on whoot's side panel).
DELETE statuses/destroy/:id Destroys Whoot specified in the required ID parameter.
POST statuses/:id/vote_up Vote up for whoot.
POST statuses/:id/vote_down Vote down for whoot.
POST statuses/:id/favor Marks whoot as favorite.
POST statuses/:id/unfavor Removes "favorite" mark from specified whoot.

Messages

Resource Description
GET direct_messages Returns the 20 most recent direct messages sent to the authenticating user. The XML and JSON versions include detailed information about the sender and recipient user.
GET direct_messages/sent Returns the 20 most recent direct messages sent by the authenticating user. The XML and JSON versions include detailed information about the sender and recipient user.
GET direct_messages/all Returns the 20 most recent direct messages both incoming and sent by the authenticating user. The XML and JSON versions include detailed information about the sender and recipient user.
DELETE direct_messages/destroy/:id Destroys the direct message specified in the required ID parameter. The authenticating user must be the recipient of the specified direct message.
POST direct_messages/new Sends a new direct message to the specified user from the authenticating user. Requires both the user and text parameters and must be a POST. Returns the sent message in the requested format if successful.
GET direct_messages/show/:id Returns a single direct message, specified by an id parameter. Like the /1/direct_messages.format request, this method will include the user objects of the sender and recipient.
GET direct_messages/search Searches authenticated user messages
GET conversations Returns authenticated user conversations with other Whootin users via messages. The XML and JSON versions include detailed information about conversation participants.
GET conversations/:id Returns authenticated user conversation by given id. The XML and JSON versions include detailed information about conversation participants and messages.
GET participants Returns authenticated user's participants.

Hashtags

Resource Description
GET hashtags/categories Returns the 20 most recent categories used in whoots. Categories are the first parts of hashtags (#CATEGORY:KeyWord#).
GET hashtags/keywords Returns the 20 most recent keywords under category used in whoots. Keywords are the last parts of hashtags (#category:KEYWORD#).

Search

Resource Description
GET search/by_category/:category Returns the 20 most recent whoots searched by category (and by keyword if specified).

Files and Folders

Resource Description
POST files/new Uploads new file to user's Files section. Your POST request's Content-Type should be set to multipart/form-data with the file parameter.
POST files/share/:id Share a file with other users. Requires the user (or email) and must be a POST. Returns the upload sharing object or success message (in case if email parameter provided).
PUT files/move/:id Moves a file to folder. Requires folder id and must be a PUT.
PUT files/rename/:id Renames a file or folder. Requires id and must be a PUT.
PUT files/lock/:id Removes public link for file, specified by an id parameter.
PUT files/restore/:id Restores previously deleted file or folder.
GET files Returns by default 10 files and folders of authenticated user. The XML and JSON versions include detailed information about files.
GET file Get file/folder info by it's name.
GET file/by_token/:token Returns public file or folder by its token exposed via file (or folder) publishing.
GET files/publish/:id Creates a public link for file, specified by an id parameter. Actually it generates token for a file that can be used to access this file directly.
DELETE files/destroy/:id Deletes (marks as deleted) user's file if called for the first time. Once you call this query second time on a same file - it will be deleted permanently.
POST folders/new Creates new folder in user's Files section. You should specify unique folder name.
DELETE folders/destroy/:id Deletes (marks as deleted) user's folder if called for the first time. Once you call this query second time on a same folder - it will be deleted permanently.

Users

Resource Description
GET user/entourage Returns 20 users from user's entourage.
GET user/posse Returns 20 users from user's posse.
GET users/:id/entourage Returns 20 users of user's entourage. Without OAuth authentication.
GET users/:id/posse Returns 20 users of user's posse. Without OAuth authentication.
POST user/join_entourage Joins user to another user's entourage. Requires user parameter and must be a POST. Returns user in the requested format whose id or username was provided in parameters.
DELETE user/unfollow Unfollow user. Requires user parameter and must be a DELETE. Returns user in the requested format whose id or username was provided in parameters.
GET users Returns 20 Whootin users.
GET user Returns current authenticated user.
POST users/new Registers a new user on Whootin.com.
POST user/recover_password Allows to request password reset in case of forgotten password. This request works without authentication.

Developers API

Resource Description
POST sms This API allows Whootin Developers to send sms in their apps.
POST subscribe This API allows Whootin Developers to subscribe authenticated user to other plan.
GET phone/search This API allows Whootin Developers to search available phone numbers.
POST phone This API allows Whootin Developers to purchase phone number for Whootin User.