You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@esme.apache.org by rh...@apache.org on 2011/07/17 16:44:34 UTC
svn commit: r1147641 - /esme/site/trunk/content/docs/apis/original-api.mdtext
Author: rhirsch
Date: Sun Jul 17 14:44:34 2011
New Revision: 1147641
URL: http://svn.apache.org/viewvc?rev=1147641&view=rev
Log:
CMS commit to esme by rhirsch
Modified:
esme/site/trunk/content/docs/apis/original-api.mdtext
Modified: esme/site/trunk/content/docs/apis/original-api.mdtext
URL: http://svn.apache.org/viewvc/esme/site/trunk/content/docs/apis/original-api.mdtext?rev=1147641&r1=1147640&r2=1147641&view=diff
==============================================================================
--- esme/site/trunk/content/docs/apis/original-api.mdtext (original)
+++ esme/site/trunk/content/docs/apis/original-api.mdtext Sun Jul 17 14:44:34 2011
@@ -66,38 +66,34 @@ Long Polling
<a name="OriginalAPI-GET/api/wait_for_msgs"></a>
##### GET /api/wait_for_msgs
-<esme_api operation="wait_for_msgs" success="true">
-<message id="1134" source="web" date="...">
-<author image="..."
-name="..." id="9"/>
-<body>
-Woohoo - got through the rest of the slides quite quickly. I can go home now.
-</body>
-<tags/>
-</message>
-</esme_api>
+ <esme_api operation="wait_for_msgs" success="true">
+ <message id="1134" source="web" date="...">
+ <author image="..."
+ name="..." id="9"/>
+ <body>
+ Woohoo - got through the rest of the slides quite quickly. I can go home now.
+ </body>
+ <tags/>
+ </message>
+ </esme_api>
-----
-
-<a name="OriginalAPI-SendMessage"></a>
#### Send Message
Sends a message
-<a name="OriginalAPI-POST/api/send_msg"></a>
##### POST /api/send_msg
-message=messagebody
-
-via=optional_name_of_client
-
-tags=optional_comma_delimitted_tags
-
-metadata=optional_XML_Element_data
-
-replyto=optional_id_of_message
-
-<esme_api operation="send_msg" success="true"/>
+ message=messagebody
+
+ via=optional_name_of_client
+
+ tags=optional_comma_delimitted_tags
+
+ metadata=optional_XML_Element_data
+
+ replyto=optional_id_of_message
+
+ <esme_api operation="send_msg" success="true"/>
----
@@ -109,10 +105,10 @@ Gets all the users that the current user
<a name="OriginalAPI-GET/api/get_following"></a>
##### GET /api/get_following
-<esme_api operation="get_following" success="true">
-<user nickname="ewh" image="..." id="13"
-whole_name="..."/>
-</esme_api>
+ <esme_api operation="get_following" success="true">
+ <user nickname="ewh" image="..." id="13"
+ whole_name="..."/>
+ </esme_api>
----
@@ -124,10 +120,10 @@ Gets all the users that follow the curre
<a name="OriginalAPI-GET/api/get_followers"></a>
##### GET /api/get_followers
-<esme_api operation="get_followers" success="true">
-<user nickname="..." image="..." id="13"
-whole_name="..."/>
-</esme_api>
+ <esme_api operation="get_followers" success="true">
+ <user nickname="..." image="..." id="13"
+ whole_name="..."/>
+ </esme_api>
----
@@ -139,9 +135,9 @@ Start following another user
<a name="OriginalAPI-POST/api/follow"></a>
##### POST /api/follow
-user=id_of_user
-
-<esme_api operation="follow" success="true"/>
+ user=id_of_user
+
+ <esme_api operation="follow" success="true"/>
----
@@ -150,12 +146,12 @@ user=id_of_user
Stop following another user
-<a name="OriginalAPI-POST/api/unfollow"></a>
+
##### POST /api/unfollow
user=id_of_user
-<esme_api operation="unfollow" success="true"/>
+ <esme_api operation="unfollow" success="true"/>
----
@@ -167,9 +163,9 @@ List all users in the system
<a name="OriginalAPI-GET/api/all_users"></a>
##### GET /api/all_users
-<esme_api operation="all_users" success="true">
-<user nickname="..." id="4" whole_name="..."/>
-</esme_api>
+ <esme_api operation="all_users" success="true">
+ <user nickname="..." id="4" whole_name="..."/>
+ </esme_api>
----
@@ -181,16 +177,16 @@ Gets the tags and words for the tag clou
<a name="OriginalAPI-GET/api/get_tagcloud"></a>
##### GET /api/get_tagcloud
-numTags=optional_no_of_tags
-
-<esme_api operation="get_tagcloud" success="true">
-<tag_cloud>
-<tag name="Scrum"
-weight="0.33333334"/>
-<word
-name="meeting" weight="0.13333334"/>
-</tag_cloud>
-</esme_api>
+ numTags=optional_no_of_tags
+
+ <esme_api operation="get_tagcloud" success="true">
+ <tag_cloud>
+ <tag name="Scrum"
+ weight="0.33333334"/>
+ <word
+ name="meeting" weight="0.13333334"/>
+ </tag_cloud>
+ </esme_api>
----
@@ -202,12 +198,12 @@ Gets the list of items the user is track
<a name="OriginalAPI-GET/api/get_tracking"></a>
##### GET /api/get_tracking
-<esme_api operation="get_tracking" success="true">
-<tracking user="1" removed="true"
-createdAt="1219639418277" id="1"/>
-<tracking user="1" removed="false"
-createdAt="1220896384128" pattern="#esme" id="24"/>
-</esme_api>
+ <esme_api operation="get_tracking" success="true">
+ <tracking user="1" removed="true"
+ createdAt="1219639418277" id="1"/>
+ <tracking user="1" removed="false"
+ createdAt="1220896384128" pattern="#esme" id="24"/>
+ </esme_api>
----
@@ -219,9 +215,9 @@ Adds a tracking item
<a name="OriginalAPI-POST/api/add_tracking"></a>
##### POST /api/add_tracking
-track=text_of_thing_to_track
-
-<esme_api operation="add_tracking" success="true"/>
+ track=text_of_thing_to_track
+
+ <esme_api operation="add_tracking" success="true"/>
----
@@ -233,9 +229,9 @@ Removes the tracking item
<a name="OriginalAPI-POST/api/remove_tracking"></a>
##### POST /api/remove_tracking
-trackid=id_of_tracking_item
-
-<esme_api operation="remove_tracking" success="true"/>
+ trackid=id_of_tracking_item
+
+ <esme_api operation="remove_tracking" success="true"/>
----
@@ -247,17 +243,17 @@ Gets all the messages in a conversation
<a name="OriginalAPI-GET/api/get_conversation"></a>
##### GET /api/get_conversation
-conversationid=Conversation_id
-
-<esme_api operation="get_conversation" success="true">
-<conversation id="1089">
-<message when="..."
-date="..." source="Web Dynpro ABAP" id="1089" conversation="1089">
-
-<author image="..." name="..." id="24"/>
-</message>
-</conversation>
-</esme_api>
+ conversationid=Conversation_id
+
+ <esme_api operation="get_conversation" success="true">
+ <conversation id="1089">
+ <message when="..."
+ date="..." source="Web Dynpro ABAP" id="1089" conversation="1089">
+
+ <author image="..." name="..." id="24"/>
+ </message>
+ </conversation>
+ </esme_api>
----
@@ -269,10 +265,10 @@ Gets the actions
<a name="OriginalAPI-GET/api/get_actions"></a>
##### GET /api/get_actions
-<esme_api operation="get_actions" success="true">
-<action action="resend" enabled="true"
-name="#0208" test="#o208" id="3"/>
-</esme_api>
+ <esme_api operation="get_actions" success="true">
+ <action action="resend" enabled="true"
+ name="#0208" test="#o208" id="3"/>
+ </esme_api>
----
@@ -284,13 +280,13 @@ Adds an Action
<a name="OriginalAPI-POST/api/add_action"></a>
##### POST /api/add_action
-name=name_of_action
-
-test=test_that_triggers_action
-
-action=action_to_take
-
-<esme_api operation="add_action" success="true"/>
+ name=name_of_action
+
+ test=test_that_triggers_action
+
+ action=action_to_take
+
+ <esme_api operation="add_action" success="true"/>
----
@@ -302,11 +298,11 @@ Enables or Disables an Action
<a name="OriginalAPI-POST/api/enable_action"></a>
##### POST /api/enable_action
-id=action_id
-
-enabled=true\|false
-
-<esme_api operation="enable_action" success="true"/>
+ id=action_id
+
+ enabled=true\|false
+
+ <esme_api operation="enable_action" success="true"/>
----
@@ -318,6 +314,10 @@ Deletes an Action
<a name="OriginalAPI-POST/api/delete_action"></a>
##### POST /api/delete_action
-actionid=action_id
-<esme_api operation="delete_action" success="true"/>
+
+ actionid=action_id
+
+ <esme_api operation="delete_action" success="true"/>92
+
+92
\ No newline at end of file