Commits

Kang-min Wang committed 2c7bf89

add api doc

Comments (0)

Files changed (1)

+==================================================
+API Doc
+==================================================
+
+--------------------------------------------------
+所有的資料都需要透過API來存取
+--------------------------------------------------
+
+/API/GetConfInfo
+====================
+Desc
+--------------------
+get conference information
+
+Howto
+--------------------
+require:
+    - name: conference name
+return:
+    - name: conference name
+    - desc: conference information
+
+example
+--------------------
+    - Send:{'name':'coscup2011'}
+    - Return:{'name':'coscup2011','desc', "its a conference!"}
+
+/API/GetData
+====================
+Desc
+--------------------
+get conference date by conference name
+
+Howto
+--------------------
+- require:
+    - name: conference name
+- return:
+    - List
+        - when
+        - where
+        - who
+        - what
+        - time
+
+example
+--------------------
+    - Send:{'name':'coscup2011'}
+    - Return:[{'when':'sesson name','where':'room name','who':'aminzai','what':'crboy so handsome','time':'2002-12-25 00:00:00-06:39'},{'when':'sesson name','where':'room name','who':'aminzai','what':'crboy so handsome','time':'2002-12-25 00:00:00-06:39'}]