THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
...
Methods, Resources, and Descriptions
Method | Resource | Description/Payload schema/Response schema |
|---|---|---|
GET | api/sessions | (It might make sense for this to return only the current session, but in theory it would return all sessions that the current session is allowed to access, so for an administrator, it might return all open sessions. An individual session would be accessed at GET api/sessions/SESSIONID.) |
POST | api/sessions?token=API_TOKEN |
|
DELETE | api/sessions/SESSIONID | or |
GET | api/users/USERID/messages | (get USERID from api/session) |
GET | api/users/USERID/messages | (long-poll?) |
GET | api/messages/MESSAGEID | Gets a particular message. |
POST | api/messages?message=MESSAGE_BODY&via=CLIENT&tags=TAGS&metadata=XML&replyto=MESSAGEID |
|
PUT | api/messages/MESSAGEID | (payload the same as POST) |
DELETE | api/messages/MESSAGEID |
|
GET | api/users/USERID/followees |
|
GET | api/users/USERID/followers |
|
POST | api/users/USERID/followees/USERID2 | or POST api/users/USERID/followees?user=USERID2 |
DELETE | api/users/USERID/followees/USERID2 | or DELETE api/users/USERID/followees?user=USERID2 |
GET | api/users |
|
GET | api/tags | (This doesn't really seem like an appropriate API method. It should really return all of the tags, or user-specific tags (GET api/tags/USERID) and let the front-end decide what to do with it.) |
GET | api/users/USERID/tracks |
|
POST | api/users/USERID/tracks?track=TEXT_TO_TRACK |
|
DELETE | api/users/USERID/tracks/TRACKID |
|
GET | api/conversations/CONVERSATIONID |
|
GET | api/users/USERID/actions | (Actions probably don't make sense outside of the context of a specific user.) |
POST | api/users/USERID/actions?name=NAME&test=TEST&action=ACTION |
|
PUT | api/users/USERID/actions/ACTIONID?enabled=true|false | (This is actually a general outlet to update any attribute of an action, including whether or not it is enabled.) |
DELETE | api/users/USERID/actions/ACTIONID |
|
...